What's New

---

POST /candidateDocumentTypes/{candidateDocumentTypeId}/process

Process candidate document type

What's Changed

---

GET /candidates/export

Parameters:

Changed: order in query

Candidates order

GET /document-validation-groups/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

    • Property en (string)

    • Property fr (string)

    • Property nl (string)

    • Property de (string)

    • Property it (string)

    • Property pl (string)

    • Property ro (string)

    • Property sq (string)

    • Property be (string)

    • Property bg (string)

    • Property hr (string)

    • Property cs (string)

    • Property da (string)

    • Property et (string)

    • Property fi (string)

    • Property el (string)

    • Property hu (string)

    • Property is (string)

    • Property ga (string)

    • Property lv (string)

    • Property lt (string)

    • Property mk (string)

    • Property mt (string)

    • Property no (string)

    • Property pt (string)

    • Property ru (string)

    • Property sr (string)

    • Property sk (string)

    • Property sl (string)

    • Property es (string)

    • Property sv (string)

    • Property uk (string)

    • Property cy (string)

  • Added property internalNote (string)

    Internal note.

PATCH /document-validation-groups/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

GET /documentValidations/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documentValidationGroup (object)

    Document validation group properties

    • Added property reference (string)

      Validation group reference. This value is not unique within a validation group

    • Added property description (string)

      Human-readable description of the validation group.

    • Added property message (string)

      Default validation message shown to the contact. Used when no localized message is available.

    • Added property messageI18n (object)

    • Added property internalNote (string)

      Internal note.

GET /tags/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property tint (string)

    Tag tint for Admin v2

PATCH /tags/{id}

Request:

Changed content type : application/json

• Added property tint (string)

  Tag tint for Admin v2

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property tint (string)

    Tag tint for Admin v2

GET /candidate-forms

Parameters:

Added: includeCandidateSelfie in query

You can include candidate 'selfie' relation

GET /candidate-forms/{id}

Parameters:

Added: includeCandidateSelfie in query

You can include candidate 'selfie' relation

POST /documentValidationSets

Request:

Changed content type : application/json

• Changed property validationGroups (array)

  Array of document validation groups related to this validation set. Should be included min 1 item

  Changed items (object): > Document validation set validation group properties

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

GET /document-validation-groups

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Document validation group included relations

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

POST /document-validation-groups

Request:

Changed content type : application/json

• Added property reference (string)

  Validation group reference. This value is not unique within a validation group

• Added property description (string)

  Human-readable description of the validation group.

• Added property message (string)

  Default validation message shown to the contact. Used when no localized message is available.

• Added property messageI18n (object)

• Added property internalNote (string)

  Internal note.

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

PATCH /document-validation-groups

Request:

Changed content type : application/json

Changed items (object): > Update document validation groups body params

• Added property reference (string)

  Validation group reference. This value is not unique within a validation group

• Added property description (string)

  Human-readable description of the validation group.

• Added property message (string)

  Default validation message shown to the contact. Used when no localized message is available.

• Added property messageI18n (object)

• Added property internalNote (string)

  Internal note.

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Document validation group properties

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

POST /document-validation-groups/bulk

Request:

Changed content type : application/json

Changed items (object): > Create document validation group body params

• Added property reference (string)

  Validation group reference. This value is not unique within a validation group

• Added property description (string)

  Human-readable description of the validation group.

• Added property message (string)

  Default validation message shown to the contact. Used when no localized message is available.

• Added property messageI18n (object)

• Added property internalNote (string)

  Internal note.

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Document validation group properties

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

GET /documentValidations

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Document validation included relations

  • Changed property documentValidationGroup (object)

    Document validation group properties

    • Added property reference (string)

      Validation group reference. This value is not unique within a validation group

    • Added property description (string)

      Human-readable description of the validation group.

    • Added property message (string)

      Default validation message shown to the contact. Used when no localized message is available.

    • Added property messageI18n (object)

    • Added property internalNote (string)

      Internal note.

GET /requests/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property validation (array)

    Array of daas request validations

    Changed items (object): > Daas Request Validation Group

    • Added property reference (string)

      Validation group reference. This value is not unique within a validation group

    • Added property description (string)

      Human-readable description of the validation group.

    • Added property message (string)

      Default validation message.

    • Added property messageI18n (object)

    • Added property internalNote (string)

      Internal note.

PATCH /documentValidationSets/{id}

Request:

Changed content type : application/json

• Changed property validationGroups (array)

  Array of document validation groups related to this validation set

  Changed items (object): > Document validation set validation group properties

  • Added property reference (string)

    Validation group reference. This value is not unique within a validation group

  • Added property description (string)

    Human-readable description of the validation group.

  • Added property message (string)

    Default validation message shown to the contact. Used when no localized message is available.

  • Added property messageI18n (object)

  • Added property internalNote (string)

    Internal note.

POST /scenarios

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property tags (array)

    Scenario document tags

    Changed items (object): > Tag for grouping data based on similarity

    • Added property tint (string)

      Tag tint for Admin v2

GET /scenarios

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Scenario included relations

  • Changed property tags (array)

    Array of tags

    Changed items (object): > Tag for grouping data based on similarity

    • Added property tint (string)

      Tag tint for Admin v2

PATCH /scenarios/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property tags (array)

    Scenario document tags

    Changed items (object): > Tag for grouping data based on similarity

    • Added property tint (string)

      Tag tint for Admin v2

GET /scenarios/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property tags (array)

    Array of tags

    Changed items (object): > Tag for grouping data based on similarity

    • Added property tint (string)

      Tag tint for Admin v2

POST /tags

Request:

Changed content type : application/json

• Added property tint (string)

  Tag tint for Admin v2

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property tint (string)

    Tag tint for Admin v2

GET /tags

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Updated tagArray : Changed items (object): > Tag for grouping data based on similarity

  • Added property tint (string)

    Tag tint for Admin v2

  Updated tagWithStatisticArray : Changed items (object): > Tag usage statistics across different entities.

  • Added property tint (string)

    Tag tint for Admin v2

POST /requests

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property validation (array)

    Array of daas request validations

    Changed items (object): > Daas Request Validation Group

    • Added property reference (string)

      Validation group reference. This value is not unique within a validation group

    • Added property description (string)

      Human-readable description of the validation group.

    • Added property message (string)

      Default validation message.

    • Added property messageI18n (object)

    • Added property internalNote (string)

      Internal note.

GET /requests

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object):

  • Changed property validation (array)

    Array of daas request validations

    Changed items (object): > Daas Request Validation Group

    • Added property reference (string)

      Validation group reference. This value is not unique within a validation group

    • Added property description (string)

      Human-readable description of the validation group.

    • Added property message (string)

      Default validation message.

    • Added property messageI18n (object)

    • Added property internalNote (string)

      Internal note.

GET /registration-pages

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property tags (array)

    Related documents

    Changed items (object):

    • Changed property tag (object)

      Tag for grouping data based on similarity

      • Added property tint (string)

        Tag tint for Admin v2

GET /registration-pages/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property tags (array)

    Related documents

    Changed items (object):

    • Changed property tag (object)

      Tag for grouping data based on similarity

      • Added property tint (string)

        Tag tint for Admin v2

GET /candidates

Parameters:

Changed: order in query

Candidates order

GET /signature-requests

Parameters:

Added: includeEntityCandidateSelfie in query

To include entity candidate selfie

GET /signature-requests/{id}

Parameters:

Added: includeEntityCandidateSelfie in query

To include entity candidate selfie