Face Comparison

This endpoint allows you to compare two facial images for verification purposes.

Endpoint: POST {baseurl}/v1/api/verification/face-comparison

Request Body

Parameter	Type	Required	Description
country	string	Yes	The country code (e.g., "NGA" for Nigeria).
reference	string	Yes	A unique reference for the verification request.
verificationLevel	string	No	The level of verification to perform (e.g., "basic").
customer	string	No	ID of the customer (optional).
verificationGroup	string	No	ID of the verification group (optional).
sourceImage	string	Yes	Base64 encoded source image for comparison.
targetImage	string	Yes	Base64 encoded target image for comparison.

Sample Request

curl

curl -X 'POST' \
  'http://localhost:4000/v1/api/verification/face-comparison' \
  -H 'accept: application/json' \
  -H 'x-api-key: {API-KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "country": "NGA",
  "reference": "09876543567890000002020008006",
  "verificationLevel": "basic",
  "customer": "68922a8c839016cfca2ff038",
  "verificationGroup": "68ada27c2e94452b66f779b0",
  "sourceImage": "",
  "targetImage": ""
}'

Sample Response

{
  "status": true,
  "responseCode": "00",
  "statusCode": "200",
  "message": "Face comparison verification successful",
  "data": {
    "match": true,
    "confidence": 0.95,
    "sourceImage": "base64_encoded_image",
    "targetImage": "base64_encoded_image"
  },
  "meta": {
    "statusCode": "200",
    "isValid": true,
    "timeStamp": "Wed Apr 23 2025 07:16:01 GMT+0000 (Coordinated Universal Time)"
  }
}