GuideAPI Reference
API Reference
Portal

Compare a selfie against a reference face

post
https://api2.idanalyzer.com/face

Run 1:1 biometric face verification between a reference image and a selfie photo or selfie video.

Use this endpoint when you already have a trusted reference face. If you need to compare a selfie against a document portrait while also performing document OCR and validation, use /scan instead.

Body Params
string
required

Reference Image in base64 or remote URL. You may also reference image from another transaction by passing "ref:abcde" where abcde is the output image reference.

string
required

Selfie photo in base64 or URL, you can provide multiple frames of images captured continuously by separating each image with a comma (,). You may also reference image from another transaction by passing "ref:abcde" where abcde is the output image reference.

string
required

Selfie video in base64 or remote URL

string
required

Profile ID

string

Override any particular setting on the existing profile

string

Any arbitrary string you wish to save with the transaction. e.g Internal customer reference number

Response
200

Response would be similar to new standard ID scan transaction, except there will be no "data" fields. Look for FACE_LIVENESS_ERR and RECAPTURED_FACE warnings.

Updated about 2 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 2 months ago