Get user info

GET

/v2/users/{user_id}

Retrieve enrollment state for a client-provided user identity. User IDs are opaque keys, not registered resources: an identity with no enrollments returns 200 with both enrollment flags false, never 404.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

user_id

required

string

Responses

200

User details retrieved.

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

user_id

required

string

project_id

required

string

enrollments

required

object

face

required

boolean

voice

required

boolean

face_meta_id

string

voice_phrases

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>

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>