Skip to content
Biometry

Enroll face

POST
/v2/enrollments/face

Enroll face for face recognition. Requires user_id in request.

Authorizations

Request Body required

object
request
required
object
user_id
required

Opaque, customer-provided identity key.

string
>= 1 characters <= 128 characters /^[A-Za-z0-9._:@-]+$/
face
required

Face image file (e.g. JPEG, PNG).

string format: binary

Responses

200

Enrollment attempt completed. A rejected image also returns 200: meta.message is then failed to enroll face and data.enrollment_result.code is non-zero. Check the code, not the HTTP status.

object
data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object
status

Decision status from the scoring engine (e.g. pass, fail, refer).

string
score
number
reasons
Array<string>
meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>
data
object
enrollment_result
object
code

0 on success. 1 no face / too small / bad quality, 2 more than one face, 3 face not centered.

integer
description
string
key
additional properties
any
document_auth
object
first_name
string
last_name
string
birth_date
string format: date
document_number
string
expiry_date
string format: date
country_code
string
document_category
string
current_result
string
portrait_photo
string
key
additional properties
any
key
additional properties
any

400

Bad Request / Parameter Validation Failed.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

403

Forbidden / Service Not Enabled or Consent Required.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

422

Unprocessable Entity / Face not detected, audio unreadable, or file payload syntax error.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>