POST /candidateDocumentTypes/{candidateDocumentTypeId}/uploadGET /documentTypes/{id}Added: includeSubmission in query
To include document type 'submission' relation: the post-submission rules applied when a document of this type is validated
Changed response : 200 OK
Request was successful
Changed content type : application/json
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Enum values:
uploaderselfieAdded property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Enum values:
capturelivenessnullChanged 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
PATCH /documentTypes/{id}Changed content type : application/json
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
New response : 400 Bad Request
The body is not valid. A selfie document type ("uploadMethod": "selfie") answers DOCUMENT_TYPE_SELFIE_MODE_IS_REQUIRED when neither the body nor the stored document type has a "selfieMode", and DOCUMENT_TYPE_SELFIE_FIELDS_CONDITIONS_ARE_NOT_ALLOWED when the sent post-validation rules, or the stored ones when none are sent, hold a "fields" condition. The uploader settings a selfie document type cannot use are coerced, not refused.
Changed response : 200 OK
Request was successful
Changed content type : application/json
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
POST /containers/{candidateDocumentTypeId}/uploadAdded: transactionId in query
Only for a candidate uploading into a selfie document type in liveness mode ("uploadMethod": "selfie", "selfieMode": "liveness"): the id (uuid v4) of the Regula liveness transaction. The attached file (the camera frame) is discarded and the document stores the portrait of the verified transaction. Send the key only in that case: any other upload answers 400 TRANSACTION_ID_IS_NOT_ALLOWED, and an empty value is refused.
New response : 400 Bad Request
The upload is refused; the message is the code. Selfie document types: TRANSACTION_ID_IS_NOT_ALLOWED (a transactionId anywhere but a candidate liveness upload), SELFIE_LIVENESS_TRANSACTION_IS_REQUIRED, SELFIE_LIVENESS_TRANSACTION_IS_INVALID (unknown transaction, another document, or no portrait), SELFIE_LIVENESS_IS_NOT_CONFIRMED, SELFIE_DOCUMENT_IMAGE_IS_NOT_VALID (not a JPEG or a PNG by its content).
New response : 503 Service Unavailable
The liveness service or its storage could not be reached (server-side code SELFIE_LIVENESS_SERVICE_IS_UNAVAILABLE). Like every 5xx, the response carries the generic message "Service Unavailable": clients recognise the case by the status. The same transactionId may be sent again.
GET /scenariosChanged 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 uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
POST /scenariosChanged response : 200 OK
Request was successful
Changed content type : application/json
Changed property documentTypes (array)
Scenario document types
Changed items (object):
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
GET /scenarios/{id}Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed property documentTypes (array)
Scenario document types
Changed items (object):
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
PATCH /scenarios/{id}Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed property documentTypes (array)
Scenario document types
Changed items (object):
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
GET /candidateDocumentTypes/{id}Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed property documentType (object)
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
POST /requestsChanged content type : multipart/form-data
files (array)Daas request files: 1 to 10, each named with an allowed extension (checked first, for every request). For a selfie document type ("uploadMethod": "selfie"): exactly one JPEG or PNG photo, told by its content, named ".jpg", ".jpeg" or ".png"; 2 to 10 files answer 400 SELFIE_DOCUMENT_FILES_AMOUNT_IS_NOT_VALID, and a file that is not a JPEG or a PNG answers 400 SELFIE_DOCUMENT_IMAGE_IS_NOT_VALID.
New response : 404 Not Found
The document type is not one of the company of the token (an unknown id and a document type of another company answer alike): "Request Document Type with id:
is not found".
GET /registration-pagesChanged 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 uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
GET /registration-pages/{id}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 uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
GET /candidateDocumentTypesChanged response : 200 OK
Request was successful
Changed content type : application/json
Changed items (object): > Candidate Document Type properties
Changed property documentType (object)
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
POST /documentTypesChanged content type : application/json
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
New response : 400 Bad Request
The body is not valid. A selfie document type ("uploadMethod": "selfie") answers DOCUMENT_TYPE_SELFIE_MODE_IS_REQUIRED without a "selfieMode", and DOCUMENT_TYPE_SELFIE_FIELDS_CONDITIONS_ARE_NOT_ALLOWED when its post-validation rules hold a "fields" condition.
Changed response : 200 OK
Request was successful
Changed content type : application/json
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type
GET /documentTypesAdded: includeSubmission in query
To include document type 'submission' relation: the post-submission rules applied when a document of this type is validated
Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed items (object):
Added property uploadMethod (string)
How the candidate fills the document: with the file uploader, or with a camera photo of their face ("selfie"). A selfie document type never uses a parser, face match, recto-verso, the advanced uploader, image review, file type restrictions or its own upload limit: these settings are forced off on every write, and an "auto" validation type is stored as "always_valid".
Added property selfieMode (string)
Required for the selfie upload method: "capture" (a camera photo) or "liveness" (a Regula liveness check; the document stores the portrait of the check). Null for the file uploader.
Changed 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.
Changed property rules (array)
Rules evaluated in order. Rules of a document type shared with another company of the group are not applied
Changed 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
Changed property conditionsType (string)
Whether every condition has to match or only one of them. Ignored when there are no conditions
Changed property conditions (array)
Empty for a rule that applies to every validated document of this type