Verification Data

When you perform a Know Your Customer (KYC) verification using the Faceki API, you receive a detailed verification response containing valuable information about the verification process, document authenticity, facial matching, and more. This documentation aims to help you understand the different fields present in the response and their significance.

Document Verification Result Structure

A unique identifier or reference for the document.

record_identifier

A unique identifier is associated with the record by a customer while requesting through API or SDK

requestId

A unique identifier for the request associated with the document generated by Faceki (UUIDV4)

document_data

An array containing information about the document. Each element represents a document with the following details:

  • reference: A unique identifier for the document.

  • full_name: Full name of the individual.

  • first_name: First name of the individual.

  • local_name: Local name (In Local Language)

  • last_name: Last name of the individual.

  • middle_name: Middle name of the individual.

  • nationality: Nationality of the individual.

  • nationality_iso: ISO code for nationality.

  • nationality_iso2: Another ISO code for nationality.

  • issuer: Entity or country that issued the document.

  • issuer_iso: ISO code for the issuer.

  • issuer_iso2: Another ISO code for the issuer.

  • gender: Gender of the individual.

  • dob: Date of birth in a partial format.

  • age: Age of the individual.

  • expiry: Expiry date of the document.

  • issued: Date when the document was issued.

  • document_number: Document number.

  • document_type: Type code for the document.

  • document_type_full: Full name or description of the document.

  • mrz: Machine Readable Zone information from the document.

  • document_face_match: Information about the match between the document photo and facial image.

  • passed: Boolean indicating if document verification passed.

  • date_of_birth: Date of birth in formatted form.

  • date_of_birth_day: Day component of the date of birth.

  • date_of_birth_month: Month component of the date of birth.

  • date_of_birth_year: Year component of the date of birth.

selfie_data

Information about selfie verification.

  • liveness_pass: Boolean indicating if the selfie liveness verification passed.

warnings

Array of warnings associated with the document verification.

notes

Array of notes associated with the document verification.

aml

Array of Anti Money Laundering (AML) information associated with the document verification.

verification_summary

Summary of various verification checks.

  • face_verified: Boolean indicating if face verification passed.

  • selfie_liveness_verified: Boolean indicating if selfie liveness verification passed.

  • document_verified: Boolean indicating if document verification passed.

  • verification_rules_passed: Boolean indicating if general verification rules passed.

  • document_liveness_verified: Boolean indicating if document liveness verification passed.

  • image_quality: Boolean indicating if image quality is satisfactory.

document_data_confidence

An array provides confidence levels for different fields in the document.

  • Each field in the document has a confidence score ranging from 0 to 1.

decision

The decision is based on the verification process (e.g., "DECLINED").

errorCodes

The array of error codes associated with the verification process.

deviceDetails

Information about the device used for the verification.

  • useragent: User-agent information.

  • detectResult: Details about the client and device.

createdAt

A timestamp indicating when the document verification request was created.

updatedAt

A timestamp indicating when the document verification request was last updated.

images

The array of objects contains the following information:

1. Cropped Signature Image

  • documentName: "Type of document (ID_Card , Passport, Driving License)"

  • side: "cropped_signature"

  • key: [Image URL]

2. Cropped Portrait Image

  • documentName: "Type of document (ID_Card , Passport, Driving License)"

  • side: "cropped_portrait"

  • key: [Image URL]

3. Cropped Front Image

  • documentName: "Type of document (ID_Card , Passport, Driving License)"

  • side: "cropped_front"

  • key: [Image URL]

4. Front Image

  • documentName:"Type of document (ID_Card , Passport, Driving License)"

  • side: "front"

  • key: [Image URL]

5. Back Image

  • documentName: "Type of document (ID_Card , Passport, Driving License)"

  • side: "back"

  • key: [Image URL]

6. Cropped Back Image

  • documentName: "Type of document (ID_Card , Passport, Driving License)"

  • side: "cropped_back"

  • key: [Image URL]

Selfie Image:

7. Selfie Image

  • documentName: "Selfie"

  • side: "Selfie"

  • key: [Image URL]

face_id

Unique identifier for the face image.

updateBy

Information about who updated the document verification record.

Need Support?

Contact us on WhatsApp Click here

Last updated