Skip to main content
POST
identity.face.match

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
faceImage
string
required

Id of an uploaded file holding the candidate face photo (for example a selfie), up to 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
referenceImage
string
required

Id of an uploaded file holding the reference face photo to compare against (for example an ID document portrait or an enrolled photo), up to 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
declineThreshold
number

Similarity score at or below which the check fails, 0 to 100. Default 30 (permissive); 50 to 60 is a stricter choice.

Required range: 0 <= x <= 100
saveRecord
boolean

False (default): nothing is kept — the two face images are compared for this one answer and not stored. True: the check is kept as a retrievable verification record (its data and images stay until deleted, and the candidate face is enrolled into your account's face index, where identity.face.search can find it).

endUserId
string

Your own stable id for the person (an opaque id, never a name or an email). It is sent to the verification service with the check, also when nothing is saved: the service uses it to tie the check to their other records.

Maximum string length: 256

Response

The result

status
string
required

passed when the two photos score as the same person; failed otherwise.

warnings
string[]
required

Warning codes (for example NO_REFERENCE_IMAGE or LOW_FACE_MATCH_SIMILARITY), empty when it passed cleanly.

score
number

Similarity 0 to 100: how confident the check is that both photos show the same person. Absent when no face could be compared (the check then fails with a warning code).

ref
string

Reference to what this call created. Pass it as ref to identity.verification.get or identity.verification.delete (only set when saveRecord was true).