Identity PlatformAPI Reference
Errors
How the Identity Platform API reports errors, and a reference for every error type.
All errors from the Identity Platform API follow RFC 7807 Problem Details for HTTP APIs. Every error response has Content-Type: application/problem+json and a consistent JSON body.
Response shape
{
"type": "https://brivo.ltd/docs/identity/api/errors/bad-request",
"title": "Bad Request",
"status": 400,
"detail": "A human-readable explanation of what went wrong.",
"instance": "/auth/session",
"requestId": "req_01j3k..."
}| Field | Type | Description |
|---|---|---|
type | string | URI that identifies the error type. Links to this documentation. |
title | string | Short summary of the error. Stable for a given type. |
status | number | HTTP status code. |
detail | string | Optional. Specific detail for this occurrence. May change between requests. |
instance | string | Optional. The URI of the request that produced the error. |
requestId | string | Optional. Unique ID for the request, useful when contacting support. |
Error types
400 Bad Request
The request was malformed or missing required fields.
401 Unauthorized
No valid session or credentials were provided.
402 Payment Required
The account has no active subscription for this feature.
403 Forbidden
The session is valid but lacks permission for this action.
404 Not Found
The requested resource does not exist.
409 Conflict
The request conflicts with existing state.
422 Validation Error
The request body failed schema validation.
429 Too Many Requests
The client has exceeded the rate limit.
403 Sudo Required
This action requires a fresh re-authentication grant.
500 Internal Server Error
An unexpected error occurred on the server.