Skip to main content
POST
identity.face.search

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 a front-facing photo of the face to search with, up to 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
scope
enum<string>

everything (default) searches every face enrolled in your account's own index. screened limits matches to faces on your blocklist or allowlist and faces from approved verifications, blocklisted entries first.

Available options:
everything,
screened
saveRecord
boolean

False (default): nothing is kept — the face is searched for this one answer and is not enrolled. True: the search is kept as a retrievable verification record (its data and face image stay until deleted) AND the searched face is enrolled into your account's face index.

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 unless the searched face matched a face on your blocklist, in which case failed.

totalMatches
integer
required

How many enrolled faces matched (at most 5 are listed).

Required range: -9007199254740991 <= x <= 9007199254740991
matches
object[]
required

The matched faces, most similar first. Facts about the match only — never who the people are.

warnings
string[]
required

Warning codes (for example FACE_IN_BLOCKLIST or MULTIPLE_FACES_DETECTED), empty when the search was clean.

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).