Skip to content

Give or revoke user consents

PUT
/v2/users/{user_id}/consents

Record the user’s authorization and/or storage consent: true gives it, false revokes it, an omitted field is left unchanged. Idempotent: setting a consent to its current state is a no-op. Each change is recorded in the user’s transaction history.

Collect consent from the user before calling this; face and voice enrollment require both consents, reference-image upload requires authorization consent.

Pass session_id to show the consent with that session in the Console.

Authorizations

Parameters

Path Parameters

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

Request Body required

object
>= 1 properties
authorization

Consent to process the user’s biometric data.

boolean
storage

Consent to store the user’s biometric data for later verification.

boolean
session_id

Optional. Links the consent to this session so it shows with the session in the Console. The session must belong to your project and must not already belong to a different user_id.

string format: uuid

Responses

200

Consent state after the change.

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
authorization
required
boolean
storage
required
boolean

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>

404

Not Found / Specified Resource (User, Session, Reference Image, etc.) does not exist.

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>