v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Face Match

post/v3/kyc/farsight/face-match

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

consentboolean required

true/false based on the consent given by the customer. Mandatory as per regulation.

purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation

imagesstring[] required

Array of Base 64 images. The first member of this array is the source image and the remaining images are the target images

thresholdnumber float required

Default threshold value: 70 (Max value = 95)

Response

200

decentroTxnIdstring

statusstring

messagestring

responseKeystring

Example response

{
  "decentroTxnId": "XXXXXXXXXXX",
  "status": "SUCCESS",
  "message": "Face match completed successfully",
  "data": [
    {
      "status": "SUCCESS",
      "message": "Face scan completed successfully.",
      "match": "100.0%",
      "sourceImage": 1,
      "targetImage": 2
    }
  ],
  "responseKey": "success_face_scan"
}