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
Request Body required
object
Consent to process the user’s biometric data.
Consent to store the user’s biometric data for later verification.
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.
Responses
200
Consent state after the change.
object
Endpoint-specific payload; omitted when the operation returns no data.
Scoring decision computed for the request when a scoring system applies.
object
Decision status from the scoring engine (e.g. pass, fail, refer).
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
object
400
Bad Request / Parameter Validation Failed.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
401
Unauthorized / Missing or Invalid Authentication Credentials.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
404
Not Found / Specified Resource (User, Session, Reference Image, etc.) does not exist.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
500
Internal Server Error.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.