Skip to main content
POST
Biometrics Verification

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

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

Body

image
string
required

Base64 data URI (for example data:image/jpeg;base64,...), or a multipart file upload when posting multipart/form-data.

livenessThreshold
number
default:70

Minimum liveness confidence as a percentage (0–100), on the same scale as livenessScore. livenessPass is true and verificationStatus is VERIFIED when the score is greater than or equal to this value. May only tighten the result, never loosen it.

Required range: 0 <= x <= 100
performDuplicateDetection
boolean
default:false

When true, screens the selfie against your company's duplicate watchlist and enrols it for future matches.

performBlacklistDetection
boolean
default:false

When true, screens the selfie against the blacklists named in blacklistIds. This feature is only available if your account is subscribed to biometric blacklist screening. You must create and add blacklists in the IDmeta Platform first to obtain the blacklistIds to pass here.

blacklistIds
string<uuid>[]

UUID strings of your company's active biometric blacklists, created in the IDmeta Platform. Required when performBlacklistDetection is true.

metadata
object

Free-form correlation data, echoed back on the response.

Response

Liveness completed. Passed, rejected, and review-needed outcomes all use HTTP 200 when the engine returns a liveness verdict. Duplicate and blacklist hits are reported in data but do not change verificationStatus.

success
boolean
required
Example:

true

message
string
required

Biometrics verification successful when liveness passed; Biometrics verification rejected when liveness failed.

data
object
required
verificationStatus
enum<string>
required

Liveness verdict only. Duplicate and blacklist hits do not change this field.

Available options:
VERIFIED,
REVIEW_NEEDED,
REJECTED
verificationStatusCode
enum<integer>
required

3 = Verified, 2 = Review Needed, 1 = Rejected.

Available options:
3,
2,
1
transactionId
string<uuid>
required
verificationType
string
required
Example:

"biometrics_verification"

createdAt
string
required
Example:

"2026-09-14 04:12:37+0000"

metadata
object | null