Digio | Documentation

Face match is a process of comparing two facial images and a similarity score is calculated. It is used to determine if the two images belong to the same individual or if there is a match between them. This technology is used to verify or identify a person based on their facial features.

The API accepts two images as input and returns a score between 0 and 100, where 0 means no similarity and 100 means identical faces. Businesses can also specify the level of confidence they want for the result, from low to high.

For a single image via the API, the maximum allowed size is 5 MB.

For API Base URL's, click here

FaceMatch API

post {BASE_URL}/v3/client/kyc/facematch

Call this API to check if faces from two images match.

Maximum file size for a single image: 5 MB
Include supported image formats (e.g., jpg, jpeg) and note that HEIC images are not supported.

REQUEST

REQUEST BODY multipart/form-data

file1

binary

Face 1 to be matched

file2

binary

Face 2 to be matched with Face 1

minimum_match

integer

Minimum threshold (in percentage) for matching faces

unique_request_id

string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/v3/client/kyc/facematch" \
 -H 'accept: application/json'

RESPONSE

application/json

Results from the checks for the back part of the ID Card

Field

Type

Description

score

number

Confidence of image being live or real/acceptable. Higher the better

result

enum

➔ Result for the validation check (UNKNOWN is from Gray-area where manual verification can be done if you don't want customers to reattempt). Ideally consider Unknown also as Fail and ask user to reattempt.

Allowed: PASS┃FAIL┃UNKNOWN

errors

[string]

In case there are errors, list of errors found in image
⮕ [ In case there are errors, list of errors found in image ]

count

integer

Count