Skip to main content
POST
/
api
/
v1
/
verification
/
biometricsverification
Biometric Verification
curl --request POST \
  --url https://{environment-subdomain}.idmetagroup.com/api/v1/verification/biometricsverification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "image_base64": "dGVzdGltYWdlYmFzZTY0",
  "template_id": "{your_trust_flow_id}",
  "verification_id": "{your_created_verification_id}"
}
'
{
  "success": true,
  "message": "Biometrics verification processed successfully",
  "data": {
    "livenessPass": true,
    "livenessScore": 0.8635861
  },
  "verificationStatus": "VERIFIED",
  "verificationStatusCode": 3,
  "trustFlowId": 1708,
  "trustValidationId": "a9936497-9f97-4d3d-b46e-f543fa9482a5",
  "verificationType": "biometrics_verification",
  "metadata": null
}
When the submitted image does not meet face-detection or quality rules, the API may return an error whose message matches one of the entries below.
DescriptionMessage
No face is detected in imageNo face detected in the image. Please ensure face is clearly visible.
Face is too smallFace is too small. Please move face closer to the camera.
Multiple faces detectedMultiple faces detected in the image. Please ensure only one face is visible.
Face is partially hidden or obscuredFace is partially hidden or obscured. Please ensure full face is clearly visible.
Face is croppedFace is cropped. Please ensure full face is in frame.
Face angle is too largeFace angle is too large. Please ensure face is clearly visible.
Face is too close to the borderFace is too close to the border. Please ensure face is clearly visible.

Authorizations

​
Authorization
string
header
required

Use Bearer {your_api_token} in the Authorization header.

Headers

​
Accept
string
default:application/json
​
Content-Type
string
default:application/json

Body

application/json
​
template_id
string
required

Identifier used to categorize or group requests for tracking or reporting.

​
verification_id
string
required

Unique identifier for the verification request, used for traceability.

​
image
string

Face image as a base64 data URI (for example, data:image/jpeg;base64,...).

​
image_base64
string

Base 64 of images

Response

200 - application/json

Biometric verification completed successfully

​
success
boolean
required
​
message
string
required
​
data
object
required
​
verificationStatus
string
required
​
verificationStatusCode
integer
required
​
trustFlowId
integer
required
​
trustValidationId
string
required
​
verificationType
string
required
​
metadata
unknown