Identity Check

Run an Identity Check

To run an Identity Check, you must create a check with type set to identity_check.

Also, a valid clientId , livePhotoId, and documentId are required.

The documentId provided must have associated image attachments that adhere to our image specifications.

We will use the front side of the document for the Identity Check.

Learn more about Identity Checks

Image Specifications

The image attachments must comply with the following:

• The images must be of good quality, with a minimum of 150 DPI.

• The images must be either in JPG or PNG format.

• The images must be provided without blur or glare.

• You must not take the image at an angle.

• Each side of the document must be between 34 KB and 4 MB.

Result object

The result object is only returned when the status of the check is complete . It has two components - outcome and breakdown.

Outcome

The outcome attribute represents the overall check result. Returned values include:

1. clear: Indicates every analysis conducted returned a successful result, and hence the identity is authentic.

2. attention: Indicates at least one of the analysis results requires attention.

Breakdown

The breakdown comprises the following objects:

faceAnalysis object

The facial analysis results. It has the following constituents:

• faceDetection: Indicates whether a face is detected and that number of faces detected on the ID and live photo are valid.

• facialSimilarity: Indicates whether the faces on the live photo and document belong to the same person.

• breakdown: Breakdown related to facial analysis.

  • facialSimilarityScore: Indicates the similarity level of whether two faces belong to the same person. The score will be 1 for a perfect match.

authenticityAnalysis object

The facial analysis results. It has the following constituents:

• spoofedImageAnalysis: Indicates whether the images are spoofed, copied from the internet, or are known blacklisted images.

• livenessCheck: Indicates if the live photo is genuine and not a photo-of-an-image or photo-of-a-screen.

• breakdown: Breakdown related to authenticity analysis.

  • specimenCheckMatches: If an image is deemed copied from the internet, this will contain an array of URLs pointing to the image.

integrityAnalysis object

The integrity analysis results. It has the following constituents:

• faceDetection: Indicates whether the images contained the expected number faces.

Sample Response

{
    "id": "5e94b88a01bce00008c86f06",
    "entityName": "John Doe",
    "type": "identity_check",
    "clientId": "5e94b75d01bce00008c86f02",
    "documentId": "5e94b87b01bce00008c86f03",
    "livePhotoId": "5e94b88901bce00008c86f05",
    "status": "complete",
    "result": {
        "outcome": "clear",
        "breakdown": {
            "faceAnalysis": {
                "faceDetection": "clear",
                "facialSimilarity": "clear",
                "breakdown": {
                    "facialSimilarityScore": 100
                }
            },
            "authenticityAnalysis": {
                "spoofedImageAnalysis": "clear",
                "livenessCheck": "clear"
            },
            "integrityAnalysis": {
                "faceDetection": "clear"
            }
        }
    },
    "createdAt": "2020-01-04T17:25:21.116Z",
    "updatedAt": "2020-01-04T17:25:21.116Z"
}