What's Changed

---

POST /candidateDocumentTypes/{candidateDocumentTypeId}/upload

Return Type:

New response : 409 Conflict

An auto check is running on the parts of this document (NOT_ALLOWED_UNTIL_DOCUMENT_IN_PROCESSING). The parts are frozen while they are being validated; retry the upload once the check has finished.

GET /documentTypes/{id}

Parameters:

Added: includeSubmission in query

To include document type 'submission' relation: the post-submission rules applied when a document of this type is validated

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property submission (object)

    Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

    • Property rules (array)

      Rules evaluated in order. Rules of a document type shared with another company of the group are not applied

      Items (object): > A post-submission rule: conditions to evaluate and actions to apply when they match, or on every validated document when there are no conditions

      • Property id (string)

        Unique identifier for the entity

      • Property conditionsType (string)

        Whether every condition has to match or only one of them. Ignored when there are no conditions

        Enum values:

        • or
        • and

      • Property conditions (array)

        Empty for a rule that applies to every validated document of this type

        Items (object): > One condition of a post-submission rule

        • Property type (string)

          Where the reference is read from. fields is the parsed document, context is the candidate around it

          Enum values:

          • fields
          • context

        • Property reference (string)

          Key to read. For fields it is a document parser reference, dotted for nested values. For context it is a candidate key, cf_<reference> for a candidate custom field or dcf_<reference> for a document custom field

        • Property operator (string)

          How the read value is compared

          Enum values:

          • isEmpty
          • isNotEmpty
          • isEqual
          • isNotEqual
          • contains
          • notContains

        • Property value (object)

          Value to compare against. Not needed by isEmpty and isNotEmpty

          One of:

            Items (string):
          

      • Property actions (array)

        Items (object): > One action applied to the candidate when the rule matches

        • Property type (string)

          What to do with the candidate

          Enum values:

          • sendNotification
          • addDocumentType
          • removeDocumentType
          • removeForm
          • applyPreset

        • Property value (string)

          Id of the entity the action targets: a document type, a form, a candidate preset or a notification scenario, depending on type

        • Property metadata (object)

          Extra properties of the requested document, read by addDocumentType only

PATCH /documentTypes/{id}

Request:

Changed content type : application/json

• Added property submission (object)

  Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property submission (object)

    Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

POST /containers/{candidateDocumentTypeId}/upload

Return Type:

New response : 409 Conflict

An auto check is running on the parts of this document (NOT_ALLOWED_UNTIL_DOCUMENT_IN_PROCESSING). The parts are frozen while they are being validated; retry the upload once the check has finished.

GET /scenarios

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Scenario included relations

  • Changed property documentTypes (array)

    Scenario document types

    Changed items (object):

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

POST /scenarios

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documentTypes (array)

    Scenario document types

    Changed items (object):

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /scenarios/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documentTypes (array)

    Scenario document types

    Changed items (object):

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

PATCH /scenarios/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documentTypes (array)

    Scenario document types

    Changed items (object):

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /candidateDocumentTypes/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documentType (object)

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /registration-pages

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documents (array)

    Related documents

    Changed items (object):

    • Changed property documentType (object)

      • Added property submission (object)

        Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /registration-pages/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documents (array)

    Related documents

    Changed items (object):

    • Changed property documentType (object)

      • Added property submission (object)

        Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /candidateDocumentTypes

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Candidate Document Type properties

  • Changed property documentType (object)

    • Added property submission (object)

      Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

POST /documentTypes

Request:

Changed content type : application/json

• Added property submission (object)

  Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property submission (object)

    Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.

GET /documentTypes

Parameters:

Added: includeSubmission in query

To include document type 'submission' relation: the post-submission rules applied when a document of this type is validated

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object):

  • Added property submission (object)

    Actions applied to the candidate once a document of this type is validated. They run after the parsed values have been written back onto the candidate and before the candidate status is recalculated, so integrations see the result of the rules.