Document Verification with Face

This endpoint provides a powerful feature that enables users to verify the authenticity of a document by comparing it with a face image. This process helps ensure that the document matches the person claiming ownership or authorization, adding an extra layer of security and trustworthiness. Whether it's validating identity documents such as passports, driver's licenses, or identification cards, this endpoint streamlines the verification process and reduces the risk of fraudulent activities.

👍
TEST DATA

doc_type: ID

doc_country: MSR

doc_image:

iVBORw0KGgoAAAANSUhEUgAABEIAAALNCAMAAAAcKjR8AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAMAUExURfk6snUzcHOybDQyM3NwNLh3/zn4QDoktLo6fjZzY/JxwDRZdPQytbMvZvAtsnIwe/e2ADxleLi5MHAss3Y19Ta3AUPDQDedIC8tRwXELfGuwQoLQMcHpzJxs7UvdHz+d3+/YDBwgC0QMXr9LfV2wDIW9/Rwa7W1Mm9vZC1tqjDttXDw8Hc27rUzgFWG868rufGswBrB6ra3dPd1bq3vgkzOWVwbO3t8Y7CsgC/Uejn7JPSziQlH6HQ0AB5D3+trrHh5rm3r7Xf2NL8gg==

selfie_image:

/9j/4AAQSkZJRgABAQAAAQABAAD/4gxYSUNDX1BST0ZJTEUAAQEAAAxITGlubwIQAABtbnRyUkdCIFhZWiAHzgACAAkABgAxAABhY3NwTVNGVAAAAABJRUMgc1JHQgAAAAAAAAAAAAAAAAAA9tYAAQAAAADTLUhQICAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABFjcHJ0AAABUAAAADNkZXNjAAABhAAAAGx3dHB0

📘
POST
{{URL}}/identitypass/verification/document_w_face

Request Header

Key	Description
x-api-key	Your Secret Key
app-id	Your App ID

Request Body

Key	Description
doc_type	Document - Passport (PP) \| Driver's License (DL) \| Government issued Identity Card (ID) \| Residence Permit (RP) \| Utility Bill (UB)
doc_country	Country code e.g MSR. Get country codes here
doc_image	Base 64 encoding of document image
selfie_image	Base 64 encoding of face image

Sample Response

{
    "status": true,
    "response_code": "00",
    "message": "Information Retrieved",
    "data": {
        "fullName": "MASANJA MAKA KISINZA",
        "first_name": "MAKA KISINZA",
        "last_name": "MASANJA",
        "gender": "M",
        "dob": "1990-09-07",
        "address": "",
        "document_name": "",
        "documentNumber": "",
        "documentType": "",
        "documentCountry": "MSR",
        "nationality": "",
        "issuer": "",
        "place_of_issue": "",
        "date_of_issue": "",
        "age": "32",
        "expirationDate": "2028-03-17",
        "device": {},
        "image": "/9j/4AAQSkZJRgABAQEBKwErAAD/2wBDAAUDBAQEAwUEBAQFBQUGBwwIBwcHBw8LCwkMEQ8SEhEPERETFhwXExQaFRERGCEYGh0dHx8fExciJCIeJBweHx7/2wBDAQUFBQcGBw4ICA4eFBEUHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh7/wAARCAFVAS0DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL=="
    },
    "face_data": {
        "status": false,
        "response_code": "01",
        "message": "Face does not match",
        "confidence": 0
    },
    "verification": {
        "reference": "f06fc1a5-423e-4076-a022-634f9ebc54c0"
    }
}

Response Description

Response	Description
status	Indicates that the request was successful.
response_code	Represents the response code.
message	Provides additional information or a descriptive message related to the response.
data	An array containing the information received.
fullName	The full name of the individual.
first_name	The first name of the individual.
last_name	The last name of the individual.
gender	The gender of the individual.
dob	The date of birth of the individual.
address	The address of the individual.
document_name	The name of the document associated with the individual.
documentNumber	The number of the document associated with the individual.
documentType	The type of document associated with the individual.
documentCountry	The country code of the document issuer.
nationality	The nationality of the individual.
issuer	The name of the country that issued the document.
place_of_issue	The place where the document was issued.
date_of_issue	The date when the document was issued.
age	The age of the individual, calculated based on the date of birth.
expirationDate	The expiration date of the document associated with the individual.
device	Additional information about the device used for capturing the data.
image	A base64-encoded image of the individual's face.
Face_data	Information related to the face matching process.
status	The overall status of the face matching process.
response_code	A code representing the outcome of the face matching process.
message	A human-readable message describing the result of the face matching process.
confidence	The level of confidence or certainty associated with the face matching result.

👍TEST DATA

📘POST

Sample Response

Response Description

👍
TEST DATA

📘
POST