Search
K
Links
Comment on page

Facial Comparison

post
{{baseurl}}
/v2/api/identity/compare-image
Compare Images
This endpoint allows you to compare the similarity between two different images.
Parameters
Header
token*
String
API secret token
Body
image1*
String
valid image URL or Base64 encoded string of image
image2*
String
valid image URL or Base64 encoded string of image
isSubjectConsent*
Boolean
Indicate subject has given consent. Must be true
Responses
Sample Request
{
"image1": "https://cdn.youverify.co/1655426991330-nbkHP7qYykVYiXJP-pZr3.jpg",
"image2": "https://cdn.youverify.co/1655261851961-za9BbHiHvWwROm19hRlv7.jpg",
"isSubjectConsent": true
}
Sample Response
{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "62abcfcb4f9005b0ddaa4a7a",
"parentId": null,
"status": "completed",
"reason": "Provided image does not match ID image",
"selfieValidation": true,
"imageComparison": {
"confidenceLevel": 47,
"threshold": 80,
"match": false,
"image1": "https://cdn.youverify.co/1655426991330-nbkHP7qYykVYiXJP-pZr3.jpg",
"image2": "https://cdn.youverify.co/1655261851961-za9BbHiHvWwROm19hRlv7.jpg"
},
"isConsent": true,
"idNumber": "62ABCFCD4F9005B0DDAA4A7B",
"businessId": "61d880f1e8e15aaf24558f1a",
"type": "facial_compare",
"requestedAt": "2022-06-17T00:50:21.567Z",
"requestedById": "61d880f2e8e15aaf24558f9b",
"createdAt": "2022-06-17T00:50:21.716Z",
"lastModifiedAt": "2022-06-17T00:50:21.716Z",
"requestedBy": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}
Error Response
HTTP/1.1 404 NotFound
{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}