POST /candidateDocumentTypes/{candidateDocumentTypeId}/uploadGET /documentTypes/{id}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:
capturelivenessnullPATCH /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.
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.
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 /requests/{id}Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed property data (object)
Data of the parsing result. For a request whose "portrait" was compared, it also holds "faceMatch".
Added property faceMatch (object)
The comparison of the "portrait" sent with the request with the photo printed on the ID document, through the face match provider configured for the document type or the company. Present once the comparison ended, before the validation rules run. Absent when no portrait was sent, when face match is not switched on for both the document type and the company, and for a document type without a parser or a selfie document type. DAAS makes no face liveness check on the portrait. The faceMatchSimilarityMore, faceMatchSimilarityMoreOrEqual, faceMatchSimilarityLess and faceMatchSimilarityLessOrEqual validation rules compare the similarity multiplied by 100 with the rule value, a number of percent, as for candidate documents. A request without "faceMatch" passes them; a "faceMatch" without a similarity ("not_done", "error") counts as 0, so the More rules fail and the Less rules pass.
Property status (string)
"matched": a similarity of at least 0.75; "not_matched": below 0.75; "not_done": the images allowed no comparison (no photo found on the ID document, no face detected, an unreadable image), never a sign of a different person; "error": a final face match error, or a passing failure that still failed after the last retry.
Enum values:
matchednot_matchednot_doneerrorProperty similarity (number)
From 0 to 1, rounded to 2 decimals. Null unless "status" is "matched" or "not_matched".
Property reason (string)
Null for "matched" and "not_matched". For "not_done" and "error", a code that says why. "not_done": DOCUMENT_PORTRAIT_NOT_FOUND (no photo found on the ID document), DOCUMENT_PORTRAIT_EXTRACTION_HTTP_{status} (the photo could not be extracted from the ID document), FACE_NOT_DETECTED (no usable face on the portrait or the ID photo), IMAGE_NOT_READABLE (an empty or undecodable image), FACE_MATCH_NO_RESULT (the comparison returned no similarity). "error": a technical code, for example FACE_MATCH_TIMEOUT.
Property completedAt (string)
Datetime in ISO format
Changed property status (string)
Request status. A request whose "portrait" is compared passes through "face_matching_start" and "face_matching_end" between "parsing_end" and "validation_start". "face_matching_error" means the comparison failed for a moment and a retry is pending; after the last retry the request goes on to validation with "data.faceMatch.status" "error".
Added enum values:
face_matching_startface_matching_endface_matching_errorGET /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.
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.
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.
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.
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.
POST /requestsChanged content type : multipart/form-data
Added property portrait (string)
Optional: one photo of the face of the person the document belongs to, compared with the photo printed on the ID document. It must be a JPEG or PNG, told by its content, of at most 5 MB and within the upload size limit of the document type or the company. It is malware-scanned like the files and always stored with the request, but never converted, merged into the document, parsed or returned by the API. It is compared only when face match is switched on for both the document type and the company, and the document type has a parser and is not a selfie document type; otherwise it is stored but not compared, without an error. The portrait must not be repeated in "files": a portrait in "files" is treated as a page of the document and merged into it. A second portrait answers 400 PORTRAIT_FILES_AMOUNT_IS_NOT_VALID, a file that is not a JPEG or a PNG (an animated PNG, a HEIC, a WebP, a truncated or empty file) 400 PORTRAIT_IMAGE_IS_NOT_VALID, and a portrait above 5 MB or the upload size limit 400 NOT_ALLOWED_UPLOAD_FILE_MAX_SIZE. DAAS makes no face liveness check: it does not tell a live person from a photo of a photo.
Changed property 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 : 400 Bad Request
The upload is refused before anything is stored. "message" is a sentence about the number or the names of the "files", or one of: SELFIE_DOCUMENT_FILES_AMOUNT_IS_NOT_VALID, SELFIE_DOCUMENT_IMAGE_IS_NOT_VALID (a selfie document type), PORTRAIT_FILES_AMOUNT_IS_NOT_VALID (more than one "portrait"), PORTRAIT_IMAGE_IS_NOT_VALID (the "portrait" is not a JPEG or a PNG by its content), NOT_ALLOWED_UPLOAD_FILE_MAX_SIZE (a file above the upload size limit of the document type or the company, or a "portrait" above its own cap or that limit). The portrait checks apply whether or not face match is switched on; the face match switches themselves never cause a 400.
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".
New response : 409 Conflict
MALWARE_DETECTED: one of the "files" or the "portrait" is infected; a 409 is also answered when storing a file fails.
Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed property data (object)
Data of the parsing result. For a request whose "portrait" was compared, it also holds "faceMatch".
faceMatch (object)The comparison of the "portrait" sent with the request with the photo printed on the ID document, through the face match provider configured for the document type or the company. Present once the comparison ended, before the validation rules run. Absent when no portrait was sent, when face match is not switched on for both the document type and the company, and for a document type without a parser or a selfie document type. DAAS makes no face liveness check on the portrait. The faceMatchSimilarityMore, faceMatchSimilarityMoreOrEqual, faceMatchSimilarityLess and faceMatchSimilarityLessOrEqual validation rules compare the similarity multiplied by 100 with the rule value, a number of percent, as for candidate documents. A request without "faceMatch" passes them; a "faceMatch" without a similarity ("not_done", "error") counts as 0, so the More rules fail and the Less rules pass.
Changed property status (string)
Request status. A request whose "portrait" is compared passes through "face_matching_start" and "face_matching_end" between "parsing_end" and "validation_start". "face_matching_error" means the comparison failed for a moment and a retry is pending; after the last retry the request goes on to validation with "data.faceMatch.status" "error".
Added enum values:
face_matching_startface_matching_endface_matching_errorGET /requestsChanged: status in query
Filter by request 'status' field
Changed: statuses[] in query
Filter result by custom statuses (or)
Changed response : 200 OK
Request was successful
Changed content type : application/json
Changed items (object):
Changed property data (object)
Data of the parsing result. For a request whose "portrait" was compared, it also holds "faceMatch".
faceMatch (object)The comparison of the "portrait" sent with the request with the photo printed on the ID document, through the face match provider configured for the document type or the company. Present once the comparison ended, before the validation rules run. Absent when no portrait was sent, when face match is not switched on for both the document type and the company, and for a document type without a parser or a selfie document type. DAAS makes no face liveness check on the portrait. The faceMatchSimilarityMore, faceMatchSimilarityMoreOrEqual, faceMatchSimilarityLess and faceMatchSimilarityLessOrEqual validation rules compare the similarity multiplied by 100 with the rule value, a number of percent, as for candidate documents. A request without "faceMatch" passes them; a "faceMatch" without a similarity ("not_done", "error") counts as 0, so the More rules fail and the Less rules pass.
Changed property status (string)
Request status. A request whose "portrait" is compared passes through "face_matching_start" and "face_matching_end" between "parsing_end" and "validation_start". "face_matching_error" means the comparison failed for a moment and a retry is pending; after the last retry the request goes on to validation with "data.faceMatch.status" "error".
Added enum values:
face_matching_startface_matching_endface_matching_errorGET /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.
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.
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.
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.
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.
GET /documentTypesChanged 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.