Back
v1.99.0: Candidate Form - Change (2026-06-18)

What's New

POST /candidateDocumentTypes/{candidateDocumentTypeId}/duplicate

Request one more document of the same type

POST /customFields/{id}/duplicate

Duplicate custom field

PUT /candidate-forms

Change Candidate Forms (bulk create, update and delete)

What's Changed

POST /integrations/send-init-request
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
GET /documentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property addOneMore (boolean)

      It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

PATCH /documentTypes/{id}
Request:

Changed content type : application/json

  • Added property addOneMore (boolean)

    It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property addOneMore (boolean)

      It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

GET /integrations/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
PATCH /integrations/{id}
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /candidateTokens
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Token included relations

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)

        Enum values:

        • en
        • fr
        • nl
        • de
        • it
        • pl
        • ro
        • sq
        • be
        • bg
        • hr
        • cs
        • da
        • et
        • fi
        • el
        • hu
        • is
        • ga
        • lv
        • lt
        • mk
        • mt
        • no
        • pt
        • ru
        • sr
        • sk
        • sl
        • es
        • sv
        • uk
        • cy
GET /candidateTokens/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /candidate-selfies
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate selfie included relations

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /candidate-selfies/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /candidate-forms
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Form properties

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
POST /candidate-forms
Request:

Changed content type : application/json

  • Added property name (string)

    Candidate form name

GET /candidate-forms/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
PATCH /candidate-forms/{id}
Request:

Changed content type : application/json

  • Added property name (string)

    Candidate form name

  • Added property signatureId (string)

    Unique identifier for the entity

GET /company-signature-roles
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Company Signature role included relations

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /company-signature-roles/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /customFields/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property isMultiline (boolean)

      Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

    • Added property options (array)

      Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

      One of:

        Items (string):

  Items (object):

  * Property `value` (string)
      > Stored value of the option.


  * Property `label` (object)
      > Translations keyed by language code.


      * Property `en` (string)

      * Property `fr` (string)

      * Property `nl` (string)

      * Property `de` (string)

      * Property `it` (string)

      * Property `pl` (string)

      * Property `{other language}` (string)
          > Placeholder for any other language code from the supported language enumeration.

    • Added property isMultipleOptions (boolean)

      Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

    • Added property isTranslatedOptions (boolean)

      Options carry translated labels (value/label pairs). Applies only to "list" fields.

    • Added property isSortedOptions (boolean)

      Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

    • Added property isSearchableOptions (boolean)

      Allow searching within options. Applies only to "list" fields. Defaults to false.

    • Added property querySettingsId (string)

      Unique identifier for the entity

    • Changed property fieldType (string)

      Custom field type

      Added enum values:

      • phone
      • mobilePhone
      • list
      • query
PATCH /customFields/{id}
Request:

Changed content type : application/json

  • Added property isMultiline (boolean)

    Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

  • Added property options (array)

    Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

  • Added property isMultipleOptions (boolean)

    Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

  • Added property isTranslatedOptions (boolean)

    Options carry translated labels (value/label pairs). Applies only to "list" fields.

  • Added property isSortedOptions (boolean)

    Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

  • Added property isSearchableOptions (boolean)

    Allow searching within options. Applies only to "list" fields. Defaults to false.

  • Added property querySettingsId (string)

    Unique identifier for the entity

  • Changed property fieldType (string)

    Custom field type

    Added enum values:

    • phone
    • mobilePhone
    • list
    • query
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property isMultiline (boolean)

      Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

    • Added property options (array)

      Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

    • Added property isMultipleOptions (boolean)

      Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

    • Added property isTranslatedOptions (boolean)

      Options carry translated labels (value/label pairs). Applies only to "list" fields.

    • Added property isSortedOptions (boolean)

      Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

    • Added property isSearchableOptions (boolean)

      Allow searching within options. Applies only to "list" fields. Defaults to false.

    • Added property querySettingsId (string)

      Unique identifier for the entity

    • Changed property fieldType (string)

      Custom field type

      Added enum values:

      • phone
      • mobilePhone
      • list
      • query
POST /integrations
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /integrations
Parameters:

Changed: filter[triggerEvent] in query

Filter by candidate 'triggerEvent' field

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /accounts
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property candidates (array)

      Array of candidates

      Changed items (object): > Immutable candidate properties

      • Added property preferredLanguage (string)
GET /accounts/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidates (array)

      Array of candidates

      Changed items (object): > Immutable candidate properties

      • Added property preferredLanguage (string)
GET /candidateCustomFields
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate custom field included relations

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)

    • Changed property customField (object)

      Base properties of custom field for an entity

      • Added property isMultiline (boolean)

        Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

      • Added property options (array)

        Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

      • Added property isMultipleOptions (boolean)

        Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

      • Added property isTranslatedOptions (boolean)

        Options carry translated labels (value/label pairs). Applies only to "list" fields.

      • Added property isSortedOptions (boolean)

        Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

      • Added property isSearchableOptions (boolean)

        Allow searching within options. Applies only to "list" fields. Defaults to false.

      • Added property querySettingsId (string)

        Unique identifier for the entity

      • Changed property fieldType (string)

        Custom field type

        Added enum values:

        • phone
        • mobilePhone
        • list
        • query
GET /candidateCustomFields/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)

    • Changed property customField (object)

      Base properties of custom field for an entity

      • Added property isMultiline (boolean)

        Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

      • Added property options (array)

        Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

      • Added property isMultipleOptions (boolean)

        Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

      • Added property isTranslatedOptions (boolean)

        Options carry translated labels (value/label pairs). Applies only to "list" fields.

      • Added property isSortedOptions (boolean)

        Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

      • Added property isSearchableOptions (boolean)

        Allow searching within options. Applies only to "list" fields. Defaults to false.

      • Added property querySettingsId (string)

        Unique identifier for the entity

      • Changed property fieldType (string)

        Custom field type

        Added enum values:

        • phone
        • mobilePhone
        • list
        • query
GET /candidateResources
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate resource included relations

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
GET /candidateResources/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
PUT /candidateResources/{id}/{action}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)
POST /customFields
Request:

Changed content type : application/json

  • Added property isMultiline (boolean)

    Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

  • Added property options (array)

    Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

  • Added property isMultipleOptions (boolean)

    Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

  • Added property isTranslatedOptions (boolean)

    Options carry translated labels (value/label pairs). Applies only to "list" fields.

  • Added property isSortedOptions (boolean)

    Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

  • Added property isSearchableOptions (boolean)

    Allow searching within options. Applies only to "list" fields. Defaults to false.

  • Added property querySettingsId (string)

    Unique identifier for the entity

  • Changed property fieldType (string)

    Custom field type

    Added enum values:

    • phone
    • mobilePhone
    • list
    • query
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property isMultiline (boolean)

      Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

    • Added property options (array)

      Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

    • Added property isMultipleOptions (boolean)

      Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

    • Added property isTranslatedOptions (boolean)

      Options carry translated labels (value/label pairs). Applies only to "list" fields.

    • Added property isSortedOptions (boolean)

      Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

    • Added property isSearchableOptions (boolean)

      Allow searching within options. Applies only to "list" fields. Defaults to false.

    • Added property querySettingsId (string)

      Unique identifier for the entity

    • Changed property fieldType (string)

      Custom field type

      Added enum values:

      • phone
      • mobilePhone
      • list
      • query
GET /customFields
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Base properties of custom field for an entity

    • Added property isMultiline (boolean)

      Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

    • Added property options (array)

      Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

    • Added property isMultipleOptions (boolean)

      Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

    • Added property isTranslatedOptions (boolean)

      Options carry translated labels (value/label pairs). Applies only to "list" fields.

    • Added property isSortedOptions (boolean)

      Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

    • Added property isSearchableOptions (boolean)

      Allow searching within options. Applies only to "list" fields. Defaults to false.

    • Added property querySettingsId (string)

      Unique identifier for the entity

    • Changed property fieldType (string)

      Custom field type

      Added enum values:

      • phone
      • mobilePhone
      • list
      • query
GET /integrations/logs
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario for handling candidate event.

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent

    • Changed property recipients (object)

      Options for who will receive notifications.

      New required properties:

      • assignee

      • Added property assignee (object)

        The user assigned to the candidate.

        • Property enabled (boolean)

    • Changed property replyTo (object)

      Scenario notifications replyTo options.

      • Changed property type (string)

        Scenario reply to type

        Added enum value:

        • candidateAssignee
POST /scenarios
Request:

Changed content type : application/json

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent

  • Changed property recipients (object)

    Options for who will receive notifications.

    New required properties:

    • assignee
    • Added property assignee (object)

      The user assigned to the candidate.

  • Changed property replyTo (object)

    Scenario notifications replyTo options.

    • Changed property type (string)

      Scenario reply to type

      Added enum value:

      • candidateAssignee
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent

    • Changed property recipients (object)

      Options for who will receive notifications.

      New required properties:

      • assignee
      • Added property assignee (object)

        The user assigned to the candidate.

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property replyTo (object)

      Scenario notifications replyTo options.

      • Changed property type (string)

        Scenario reply to type

        Added enum value:

        • candidateAssignee
GET /scenarios
Parameters:

Changed: filter[events][] in query

Search by scenario events (or)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent

    • Changed property recipients (object)

      Options for who will receive notifications.

      New required properties:

      • assignee
      • Added property assignee (object)

        The user assigned to the candidate.

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property replyTo (object)

      Scenario notifications replyTo options.

      • Changed property type (string)

        Scenario reply to type

        Added enum value:

        • candidateAssignee
PATCH /scenarios/{id}
Request:

Changed content type : application/json

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent

  • Changed property recipients (object)

    Options for who will receive notifications.

    New required properties:

    • assignee
    • Added property assignee (object)

      The user assigned to the candidate.

  • Changed property replyTo (object)

    Scenario notifications replyTo options.

    • Changed property type (string)

      Scenario reply to type

      Added enum value:

      • candidateAssignee
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent

    • Changed property recipients (object)

      Options for who will receive notifications.

      New required properties:

      • assignee
      • Added property assignee (object)

        The user assigned to the candidate.

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property replyTo (object)

      Scenario notifications replyTo options.

      • Changed property type (string)

        Scenario reply to type

        Added enum value:

        • candidateAssignee
GET /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent

    • Changed property recipients (object)

      Options for who will receive notifications.

      New required properties:

      • assignee
      • Added property assignee (object)

        The user assigned to the candidate.

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property replyTo (object)

      Scenario notifications replyTo options.

      • Changed property type (string)

        Scenario reply to type

        Added enum value:

        • candidateAssignee
GET /candidateDocumentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

      Enum values:

      • admin
      • candidate

    • Changed property documentType (object)

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)

    • Changed property customFields (array)

      Related Document Custom Fields

      Changed items (object): > Base properties of document custom field

      • Changed property customField (object)

        Base properties of custom field for an entity

        • Added property isMultiline (boolean)

          Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

        • Added property options (array)

          Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

        • Added property isMultipleOptions (boolean)

          Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

        • Added property isTranslatedOptions (boolean)

          Options carry translated labels (value/label pairs). Applies only to "list" fields.

        • Added property isSortedOptions (boolean)

          Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

        • Added property isSearchableOptions (boolean)

          Allow searching within options. Applies only to "list" fields. Defaults to false.

        • Added property querySettingsId (string)

          Unique identifier for the entity

        • Changed property fieldType (string)

          Custom field type

          Added enum values:

          • phone
          • mobilePhone
          • list
          • query
PATCH /candidateDocumentTypes/{id}
Request:

Changed content type : application/json

  • Added property requestedBy (string)

    Who requested the candidate document type: by an admin or cloned by the candidate

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

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 addOneMore (boolean)

          It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property fields (array)

      Related documents

      Changed items (object):

      • Changed property customField (object)

        Base properties of custom field for an entity

        • Added property isMultiline (boolean)

          Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

        • Added property options (array)

          Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

        • Added property isMultipleOptions (boolean)

          Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

        • Added property isTranslatedOptions (boolean)

          Options carry translated labels (value/label pairs). Applies only to "list" fields.

        • Added property isSortedOptions (boolean)

          Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

        • Added property isSearchableOptions (boolean)

          Allow searching within options. Applies only to "list" fields. Defaults to false.

        • Added property querySettingsId (string)

          Unique identifier for the entity

        • Changed property fieldType (string)

          Custom field type

          Added enum values:

          • phone
          • mobilePhone
          • list
          • query
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 addOneMore (boolean)

          It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property fields (array)

      Related documents

      Changed items (object):

      • Changed property customField (object)

        Base properties of custom field for an entity

        • Added property isMultiline (boolean)

          Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

        • Added property options (array)

          Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

        • Added property isMultipleOptions (boolean)

          Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

        • Added property isTranslatedOptions (boolean)

          Options carry translated labels (value/label pairs). Applies only to "list" fields.

        • Added property isSortedOptions (boolean)

          Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

        • Added property isSearchableOptions (boolean)

          Allow searching within options. Applies only to "list" fields. Defaults to false.

        • Added property querySettingsId (string)

          Unique identifier for the entity

        • Changed property fieldType (string)

          Custom field type

          Added enum values:

          • phone
          • mobilePhone
          • list
          • query
POST /candidates
Request:

Changed content type : application/json

  • Added property preferredLanguage (string)

  • Added property documents (array)

    Candidate Document Types to request from the candidate

    Items (object): > Candidate Document Type to request from the candidate on creation

    • Property documentTypeId (string)

      Unique identifier for the entity

    • Property name (string)

      Candidate Document Type name

    • Property description (string)

      Candidate Document Type description

    • Property filename (string)

      Candidate Document filename. It can include dynamic fields like {candidateFirstName}

    • Property comment (string)

      Candidate Document Type comment

    • Property commentType (string)

      Candidate document type comment type

      Enum values:

      • info
      • success
      • warning
      • danger

    • Property mandatory (boolean)

      It says that Candidate Document Type is mandatory or optional for the candidate

    • Property folder (string)

      Candidate Document Type files folder name

    • Property metadata (object)

      Candidate Document Type metadata (external properties)

  • Added property forms (array)

    Candidate Forms to assign to the candidate

    Items (object): > Candidate Form to assign to the candidate on creation

    • Property formId (string)

      Unique identifier for the entity

    • Property name (string)

      Candidate form name

    • Property signatureId (string)

      Unique identifier for the entity

    • Property actions (array)

      Form actions (at least one action required);

      Please note that allowable actions depend on the type of the original form:

      file, readonly and combo types: read, eSign, download

      editable type: complete, eSign, download

      Items (string): > An action that a candidate must perform with a form Enum values:

      • read
      • complete
      • eSign
      • download

    • Property isMandatory (boolean)

      It says that form is mandatory or optional for the candidate

    • Property fileId (string)

      Unique identifier for the entity

    • Property isPreliminary (boolean)

      Is candidate form preliminary

    • Property folder (string)

      Folder name

    • Property metadata (object)

      Candidate Form metadata (external properties)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property preferredLanguage (string)
GET /candidates
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Immutable candidate properties

    • Added property preferredLanguage (string)

    • Changed property candidateDocumentTypes (array)

      Candidate document types relation

      Changed items (object): > Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

PATCH /candidates/{id}
Request:

Changed content type : application/json

New optional properties:

  • accountId
  • email
  • firstName
  • language
  • lastName
  • reference

  • Added property preferredLanguage (string)

  • Added property presetIds (array)

    Candidate preset ids

    Items (string): > Unique identifier for the entity

  • Added property presetReferences (array)

    Candidate preset references

    Items (string):

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property preferredLanguage (string)
GET /candidates/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property preferredLanguage (string)

    • Changed property candidateDocumentTypes (array)

      Candidate document types relation

      Changed items (object): > Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

GET /candidateDocumentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Document Type properties

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

    • Changed property documentType (object)

      • Added property addOneMore (boolean)

        It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property candidate (object)

      Immutable candidate properties

      • Added property preferredLanguage (string)

    • Changed property customFields (array)

      Related Document Custom Fields

      Changed items (object): > Base properties of document custom field

      • Changed property customField (object)

        Base properties of custom field for an entity

        • Added property isMultiline (boolean)

          Render the field as a multi-line text area instead of a single-line input. Applies only to "string" fields. Defaults to false.

        • Added property options (array)

          Available options of the field. Applies only to "list" fields. A plain array of values, or an array of value/label pairs when "isTranslatedOptions" is true.

        • Added property isMultipleOptions (boolean)

          Allow selecting multiple options. Applies only to "list" and "query" fields. Defaults to false.

        • Added property isTranslatedOptions (boolean)

          Options carry translated labels (value/label pairs). Applies only to "list" fields.

        • Added property isSortedOptions (boolean)

          Display options sorted alphabetically. Applies only to "list" fields. Defaults to false.

        • Added property isSearchableOptions (boolean)

          Allow searching within options. Applies only to "list" fields. Defaults to false.

        • Added property querySettingsId (string)

          Unique identifier for the entity

        • Changed property fieldType (string)

          Custom field type

          Added enum values:

          • phone
          • mobilePhone
          • list
          • query
POST /candidateDocumentTypes
Request:

Changed content type : application/json

  • Added property requestedBy (string)

    Who requested the candidate document type: by an admin or cloned by the candidate

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

PUT /candidateDocumentTypes
Request:

Changed content type : application/json

  • Changed property create (array)

    Changed items (object): > Create Candidate Document Type body params

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property created (array)

      Candidate document type

      Changed items (object): > Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

PATCH /candidateDocumentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Document Type properties

    • Added property requestedBy (string)

      Who requested the candidate document type: by an admin or cloned by the candidate

POST /documentTypes
Request:

Changed content type : application/json

  • Added property addOneMore (boolean)

    It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property addOneMore (boolean)

      It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

GET /documentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Added property addOneMore (boolean)

      It says that a candidate is allowed to request an additional document of this type (a clone of an already requested candidate document type)

    • Changed property candidateDocumentTypes (array)

      Related Candidate Document Types

      Changed items (object): > Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

GET /signature-requests
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Signature request included relations

    • Changed property candidateDocumentType (object)

      Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

GET /signature-requests/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property candidateDocumentType (object)

      Candidate Document Type properties

      • Added property requestedBy (string)

        Who requested the candidate document type: by an admin or cloned by the candidate

© 2026 All rights reserved - Powered by CheckHub.io