Request
[POST]
Header
| Header | Type | Description |
|---|---|---|
| AppId | string | Create an app to get your app ID on dashboard here |
| Authorization | string | Private/secret key. Use <key> not Bearer <key> |
Body parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| selfie_image | string | Base64 value of the selfie image NB: Kindly truncate data:image/jpeg;base64, from the selfie_image object. | required |
| photoid_image | string | Base64 value of the photoId image NB: Kindly truncate data:image/jpeg;base64, from the photoid_image object. | required |
| first_name | string | First Name | optional |
| last_name | string | Last Name | optional |
Confidence Values range from 0% to 100%
- 0% - 90% denote match value is false
- 90% - 100% denote match value is true
Response
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the response data |
| entity.selfie | object | Selfie verification results |
| entity.selfie.confidence_value | number | Confidence score (0-100) indicating how closely the selfie matches the photo ID. 90+ indicates a match |
| entity.selfie.match | boolean | Whether the selfie matches the photo ID (true if confidence_value >= 90) |
| entity.selfie.photoId_image_blurry | boolean | Whether the photo ID image was detected as blurry |
| entity.selfie.selfie_image_blurry | boolean | Whether the selfie image was detected as blurry |
| entity.selfie.selfie_glare | boolean | Whether glare was detected on the selfie image |
| entity.selfie.photoId_glare | boolean | Whether glare was detected on the photo ID image |
| entity.selfie.age_range | string | Estimated age range of the person in the image |
| entity.selfie.sunglasses | boolean | Whether sunglasses were detected on the person |
| entity.selfie.card_type | string | Type of ID card detected in the photo ID image |
| entity.selfie.last_name | object | Last name verification result |
| entity.selfie.last_name.match | boolean | Whether the last name matches the provided value |
| entity.selfie.last_name.last_name | string | Last name extracted from the photo ID |
| entity.selfie.last_name.confidence_value | number | Confidence score (0-100) for the last name match |
| entity.selfie.first_name | object | First name verification result |
| entity.selfie.first_name.match | boolean | Whether the first name matches the provided value |
| entity.selfie.first_name.first_name | string | First name extracted from the photo ID |
| entity.selfie.first_name.confidence_value | number | Confidence score (0-100) for the first name match |