Skip to main content
POST
/
api
/
onboarding
/
biometrics
/
face
/
comparison
Face Comparison
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/comparison \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "image_url": "<string>",
  "selfie_url": "<string>"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

The Face Comparison endpoint uses biometric analysis to compare two face images and returns a confidence score indicating whether they depict the same individual. Use this for identity verification during onboarding or transaction approval.

​
Endpoint

POST /api/onboarding/biometrics/face/comparison

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

​
Body Parameters

ParameterTypeRequiredDescription
image_onestringYesURL or base64-encoded string of the first face image
image_twostringYesURL or base64-encoded string of the second face image

​
Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/comparison" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_one": "https://example.com/photo1.jpg",
    "image_two": "https://example.com/photo2.jpg"
  }'

​
Response

​
200 OK

FieldTypeDescription
data.statusbooleantrue if the faces match, false if they do not
data.response_codestring"00" indicates a successful comparison
data.messagestringHuman-readable match result
data.confidenceintegerMatch confidence percentage (0–100)
{
  "status": "success",
  "data": {
    "status": true,
    "response_code": "00",
    "message": "Face Match",
    "confidence": 100
  },
  "message": "Face comparison completed successfully"
}
A data.status of false indicates the faces do not match. Use data.confidence to apply your own threshold for acceptance (e.g., require >= 80 for a positive match).

​
400 Bad Request

Returned when one or both image URLs are missing, inaccessible, or do not contain a detectable face. 
{
  "status": "failed",
  "data": [],
  "message": "Could not process one or both images"
}

​
401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
image_url
string
required

URL of the reference ID photo

​
selfie_url
string
required

URL of the selfie image

Response

Comparison successful