Skip to main content
POST
Biometrics Face Compare
Face compare answers whether two faces belong to the same person. Biometrics Verification answers whether a single selfie shows a live person. A full remote-identity check usually calls both.

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

image1
string
required

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

image2
string
required

The face to compare against, in the same accepted formats as image1. URLs are not accepted.

minSimilarityScore
number
default:50

Percentage (0–100). Similarity scores below this value are REJECTED

Required range: 0 <= x <= 100
verifiedSimilarityScore
number
default:70

Percentage (0–100). Similarity scores at or above this value are VERIFIED. When the similarity score is between minSimilarityScore and verifiedSimilarityScore, the outcome is REVIEW_NEEDED.

Required range: 0 <= x <= 100
metadata
object

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

Response

Comparison completed. Verified, review-needed, and rejected outcomes all use HTTP 200.

success
boolean
required
Example:

true

message
string
required
data
object
required
verificationStatus
enum<string>
required
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_face_compare"

createdAt
string
required
Example:

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

metadata
object | null