Set user reference image
PUT /v2/users/{user_id}/reference-image
Store a reference image for the user. Requires the user’s authorization consent, recorded with PUT /v2/users/{user_id}/consents.
Authorizations
Parameters
Path Parameters
Request Body required
object
Reference portrait photo.
Responses
200
Reference image stored.
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.
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.
403
Forbidden / Service Not Enabled or Consent Required.
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.