What's Changed

---

GET /documentTypes/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property advancedUploader (boolean)

    Enables additional logic for uploading recto-verso documents

  • Added property advancedUploaderSettings (object)

    Extended settings for advanced uploader

PATCH /documentTypes/{id}

Request:

Changed content type : application/json

• Added property advancedUploader (boolean)

  Enables additional logic for uploading recto-verso documents

• Added property advancedUploaderSettings (object)

  Extended settings for advanced uploader

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property advancedUploader (boolean)

    Enables additional logic for uploading recto-verso documents

  • Added property advancedUploaderSettings (object)

    Extended settings for advanced uploader

GET /signatures

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Signature included relations

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

POST /signatures

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

GET /signatures/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

PATCH /signatures/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

POST /signatures/{id}/copy

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

POST /adminUserGroups

Request:

Changed content type : application/json

• Added property reference (string)

  Admin user group reference

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Admin user group reference

GET /adminUserGroups

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Admin user group included relations

  • Added property reference (string)

    Admin user group reference

PATCH /adminUserGroups/{id}

Request:

Changed content type : application/json

• Added property reference (string)

  Admin user group reference

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Admin user group reference

GET /adminUserGroups/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property reference (string)

    Admin user group reference

PATCH /candidateDocumentTypes/{candidateDocumentTypeId}/documents

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Candidate Document properties New required properties:

  • candidateDocumentTypeId

  New optional properties:

  • filename
  • mandatory

  • Added property candidateDocumentTypeId (string)

    Unique identifier for the entity

  • Added property pdfFileName (string)

    Document Pdf converted filename

  • Added property originFilePath (string)

    Original file path

  • Added property originFileName (string)

    Original filename

  • Added property thumbnailFilePath (string)

    Document thumbnail file path

  • Added property imageContentType (string)

    Document file content type

  • Added property imageFileSize (number)

    Document file size

  • Added property pdfFilePath (string)

    Document Pdf converted file path

  • Added property position (number)

    Document position

  • Deleted property description (string)

    Candidate Document Type description

  • Deleted property internal (boolean)

    It says that Candidate Document Type is for system internal using

  • Deleted property folder (string)

    Candidate Document Type files folder name

  • Deleted property customStatus (string)

    Candidate Document Type Custom status name

  • Deleted property combinedMultipleDocumentPath (string)

    PDF file path of combined multiple document parts

  • Deleted property combinedMultipleDocumentName (string)

    PDF file name of combined multiple document parts

  • Deleted property filename (string)

    Document type filename. It can include dynamic fields like {candidateFirstname}

  • Deleted property comment (string)

    Candidate Document Type comment

  • Deleted property commentType (string)

    Candidate document type comment type

  • Deleted property mandatory (boolean)

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

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.

  • Deleted property tags (array)

    Scenario tag ids

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateUploadedFile
    • candidateUploadedFileRejected
    • candidateUploadedFileValidated
    • candidateUploadedFilePending

POST /scenarios

Request:

Changed content type : application/json

• Added property documentTypes (array)

  Scenario document type ids

  Items (string): > Unique identifier for the entity

• Changed property eventName (string)

  Scenario event type

  Added enum values:

  • candidateUploadedFile
  • candidateUploadedFileRejected
  • candidateUploadedFileValidated
  • candidateUploadedFilePending

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property documentTypes (array)

    Scenario document types

    Items (object):

    • Property id (string)

      Unique identifier for the entity

    • Property companyId (string)

      Unique identifier for the entity

    • Property createdAt (string)

      Datetime in ISO format

    • Property updatedAt (string)

      Datetime in ISO format

    • Property filename (string)

      Document type filename. It can include dynamic fields like {candidateFirstname}

    • Property name (string)

      Document type name

    • Property reference (string)

      Document type reference

    • Property nameI18n (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)

    • Property description (string)

      Document type description

    • Property descriptionI18n (object)

    • Property documentParserId (string)

      Unique identifier for the entity

    • Property documentValidationSetId (string)

      Unique identifier for the entity

    • Property validationType (string)

      Document validation type

      Enum values:

      • auto
      • manual
      • always_valid

    • Property integrationSendOriginal (boolean)

      It says that uploaded document original file should be send to integrations

    • Property convertToPDF (boolean)

      It says that document should be converted to pdf

    • Property isUnique (boolean)

      It says that document type should be unique for a candidate

    • Property expiresInMonths (number)

      Document should be expired after the amount of months.

    • Property isRectoVerso (boolean)

      It says that document must have two parts (front and back sides). Document parts will be combined to pdf file

    • Property advancedUploader (boolean)

      Enables additional logic for uploading recto-verso documents

    • Property advancedUploaderSettings (object)

      Extended settings for advanced uploader

    • Property skipBackup (boolean)

      If this option is true, it will exclude all candidate documents related to this type from our backup system.

  • Changed property tags (array)

    Scenario document tags

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateUploadedFile
    • candidateUploadedFileRejected
    • candidateUploadedFileValidated
    • candidateUploadedFilePending

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

  • Added property documentTypes (array)

    Scenario document types

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateUploadedFile
    • candidateUploadedFileRejected
    • candidateUploadedFileValidated
    • candidateUploadedFilePending

PATCH /scenarios/{id}

Request:

Changed content type : application/json

• Added property documentTypes (array)

  Scenario document type ids

• Changed property eventName (string)

  Scenario event type

  Added enum values:

  • candidateUploadedFile
  • candidateUploadedFileRejected
  • candidateUploadedFileValidated
  • candidateUploadedFilePending

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property documentTypes (array)

    Scenario document types

  • Changed property tags (array)

    Scenario document tags

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateUploadedFile
    • candidateUploadedFileRejected
    • candidateUploadedFileValidated
    • candidateUploadedFilePending

GET /scenarios/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property documentTypes (array)

    Scenario document types

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateUploadedFile
    • candidateUploadedFileRejected
    • candidateUploadedFileValidated
    • candidateUploadedFilePending

GET /candidateDocumentTypes/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property documents (array)

    Related Candidate Documents

    Changed items (object): > Candidate Document properties New required properties:

    • candidateDocumentTypeId

    New optional properties:

    • filename
    • mandatory

    • Added property candidateDocumentTypeId (string)

      Unique identifier for the entity

    • Added property pdfFileName (string)

      Document Pdf converted filename

    • Added property originFilePath (string)

      Original file path

    • Added property originFileName (string)

      Original filename

    • Added property thumbnailFilePath (string)

      Document thumbnail file path

    • Added property imageContentType (string)

      Document file content type

    • Added property imageFileSize (number)

      Document file size

    • Added property pdfFilePath (string)

      Document Pdf converted file path

    • Added property position (number)

      Document position

    • Deleted property description (string)

      Candidate Document Type description

    • Deleted property internal (boolean)

      It says that Candidate Document Type is for system internal using

    • Deleted property folder (string)

      Candidate Document Type files folder name

    • Deleted property customStatus (string)

      Candidate Document Type Custom status name

    • Deleted property combinedMultipleDocumentPath (string)

      PDF file path of combined multiple document parts

    • Deleted property combinedMultipleDocumentName (string)

      PDF file name of combined multiple document parts

    • Deleted property filename (string)

      Document type filename. It can include dynamic fields like {candidateFirstname}

    • Deleted property comment (string)

      Candidate Document Type comment

    • Deleted property commentType (string)

      Candidate document type comment type

    • Deleted property mandatory (boolean)

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

  • Changed property documentType (object)

    • Added property advancedUploader (boolean)

      Enables additional logic for uploading recto-verso documents

    • Added property advancedUploaderSettings (object)

      Extended settings for advanced uploader

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

        Enables additional logic for uploading recto-verso documents

      • Added property advancedUploaderSettings (object)

        Extended settings for advanced uploader

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

        Enables additional logic for uploading recto-verso documents

      • Added property advancedUploaderSettings (object)

        Extended settings for advanced uploader

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 documents (array)

    Related Candidate Documents

    Changed items (object): > Candidate Document properties New required properties:

    • candidateDocumentTypeId

    New optional properties:

    • filename
    • mandatory

    • Added property candidateDocumentTypeId (string)

      Unique identifier for the entity

    • Added property pdfFileName (string)

      Document Pdf converted filename

    • Added property originFilePath (string)

      Original file path

    • Added property originFileName (string)

      Original filename

    • Added property thumbnailFilePath (string)

      Document thumbnail file path

    • Added property imageContentType (string)

      Document file content type

    • Added property imageFileSize (number)

      Document file size

    • Added property pdfFilePath (string)

      Document Pdf converted file path

    • Added property position (number)

      Document position

    • Deleted property description (string)

      Candidate Document Type description

    • Deleted property internal (boolean)

      It says that Candidate Document Type is for system internal using

    • Deleted property folder (string)

      Candidate Document Type files folder name

    • Deleted property customStatus (string)

      Candidate Document Type Custom status name

    • Deleted property combinedMultipleDocumentPath (string)

      PDF file path of combined multiple document parts

    • Deleted property combinedMultipleDocumentName (string)

      PDF file name of combined multiple document parts

    • Deleted property filename (string)

      Document type filename. It can include dynamic fields like {candidateFirstname}

    • Deleted property comment (string)

      Candidate Document Type comment

    • Deleted property commentType (string)

      Candidate document type comment type

    • Deleted property mandatory (boolean)

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

  • Changed property documentType (object)

    • Added property advancedUploader (boolean)

      Enables additional logic for uploading recto-verso documents

    • Added property advancedUploaderSettings (object)

      Extended settings for advanced uploader

POST /candidateDocumentTypes

Request:

Changed content type : application/json

New optional properties:

• filename
• name

PUT /candidateDocumentTypes

Request:

Changed content type : application/json

• Changed property create (array)

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

  • filename
  • name

POST /documentTypes

Request:

Changed content type : application/json

• Added property advancedUploader (boolean)

  Enables additional logic for uploading recto-verso documents

• Added property advancedUploaderSettings (object)

  Extended settings for advanced uploader

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property advancedUploader (boolean)

    Enables additional logic for uploading recto-verso documents

  • Added property advancedUploaderSettings (object)

    Extended settings for advanced uploader

GET /documentTypes

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object):

  • Added property advancedUploader (boolean)

    Enables additional logic for uploading recto-verso documents

  • Added property advancedUploaderSettings (object)

    Extended settings for advanced uploader

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 defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload

GET /signature-requests/{id}

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Changed property defaultMethod (string)

    Signature method that is available for signers

    Removed enum values:

    • draw
    • type
    • upload