Webhooks

Once the enrollment or verification process is completed, it is necessary for you to expose a service in order to send you the response of the client(s) in real time.

How to configure and/or customize the Webhook? ✏️

When logging into the administrative panel you will find a tab called Company, select it followed by the option Settings and you will be able to see the webhook you have configured to edit it, in case you do not have it you can add it.

Process Types

Enrollment

The Enrolment process has several steps and each step returns its own results.

The most common steps include:

• liveness + FaceMap Extraction (LIVENESS_FACEMAP)

• OCR extraction data, and document validation from the front side of the document (FRONT_DOCUMENT)

• OCR extraction data, and document validation from the back side of the document (BACK_DOCUMENT)

• Match of face against document photo (MATCH_DOCUMENT)

The last type you will get when a transaction is completed is "MATCH_DOCUMENT". If for any reason you don't get it, is because something happened in the previous steps, which will be described in the response codes.

LIVENESS_FACEMAP

Fields

process	String	Process being executed
ageEstimateGroup	Int	Identifier of the age group in which the person is most likely to be found
result_code	Int	Process result code
result_message	String	Process result message
tid	String	Transaction ID
faceImage	String	Image on base 64 of the face

Response

FRONT_DOCUMENT

Fields

process	String	Process being executed
result_code	Int	Process result code
result_message	String	Process result message
success	Boolean	Result if the process was satisfactory or not
idNumber	String	The document number of the person to be enrolled
tid	String	Transaction ID
docBack	String	Base 64 image of the back of the document
docFront	String	Base 64 image of the front of the document
match_level	String	Match level between the document and the person's face can be in the range of 0 - 7 acceptable values are: 2 - 7 unacceptable values are from 0 - 1
age_estimate_group	Int	Identifier of the age group in which the photo of the person's document face is likely to be found.
digital_id_spoof	Int	Physical and morphological document validation
face_on_document_status	Int	Validation of the face contained in the document
full_id_status	Int	Validates if the document is complete
text_on_document_status	Int	Validates the document text
unexpectedMediaEncounteredAtLeastOnce	boolean	Validates if the material in the document was unexpected
location	jsonObject	Return the latitude and longitude of the client, this parameter isn't present if the client not active her location mobile

Response

BACK_DOCUMENT

Fields

process	String	Process being executed
result_code	Int	Process result code
result_message	String	Process result message
success	Boolean	Result if the process was satisfactory or not
idNumber	String	The document number of the person to be enrolled
tid	String	Transaction ID
docFront	String	Base 64 image of the front of the document
docBack	String	Image on base 64 of the back of the document
match_level	String	Match level between the document and the person's face can be in the range of 0 - 7 acceptable values are: 2 - 7 unacceptable values are from 0 - 1
age_estimate_group	Int	Identifier of the age group in which the photo of the person's document face is likely to be found.
digital_id_spoof	Int	Physical and morphological document validation
face_on_document_status	Int	Validation of the face contained in the document
full_id_status	Int	Validates if the document is complete
text_on_document_status	Int	Validates the document text
unexpectedMediaEncounteredAtLeastOnce	Boolean	Validates if the material in the document was unexpected
location	JsonObject	Return the latitude and longitude of the client, this parameter isn't present if the client not active her location mobile

Response

MATCH_DOCUMENT

Fields

process	String	Process being executed
result_code	Int	Process result code
result_message	String	Process result message
success	Boolean	Result if the process was satisfactory or not
idType	String	Type of document of the person to be enrolled
idNumber	String	The document number of the person to be enlisted
idName	String	Names of person to be enrolled
idLastName	String	Last name of person to be enrolled
birthDate	String	Date of birth
placeBirth	String	Place of birth
issue_date	String	Date of issue of the document
issue_place	String	Place of issue of the document
heigth	String	Height recorded in the document
gender	String	Person's gender
tid	String	Transaction ID
docFront	String	Base 64 image of the front of the document
docBack	String	Image on base 64 of the back of the document
match_level	String	Match level between the document and the person's face can be in the range of 0 - 7 acceptable values are: 2 - 7 unacceptable values are from 0 - 1
age_estimate_group	Int	Identifier of the age group in which the photo of the person's document face is likely to be found.
digital_id_spoof	Int	Physical and morphological document validation
face_on_document_status	Int	Validation of the face contained in the document
full_id_status	Int	Validates if the document is complete
text_on_document_status	Int	Validates the document text
unexpectedMediaEncounteredAtLeastOnce	boolean	Validates if the material in the document was unexpected
idNumberOCR	string	idNumber returned by the OCR process
location	JsonObject	Return the latitude and longitude of the client, this parameter isn't present if the client not active her location mobile

Response

Verificación

Fields

Field name	Type	Description
process	String	Process being executed
tid	String	Transaction ID
auditTrailImage	Base64	Image on base 64 of the face
ageEstimateGroup	Int	Identifier of the age group in which the person is most likely to be found
result_code	Int	Transaction result code
result_message	String	Transaction result message
match_level	String	Match level for verification can only be: 0 not valid and 15 valid.
liveness_check	Boolean	Liveness validation result

Response

ageEstimateGroup, matchLevel, result_code return different codes which you can find described in the following section Result codes and References

Practical URL example

https://<domain>/api/results-verification

This is an example of the definition of your service which must receive the parameters mentioned below in JSON structure. This Url of the webhook must be previously configured in the Unicus administrative application, in general settings.