Skip to main content

Error Handling

The API uses the RFC 7807 and RFC 9457 standards for "Problem Details for HTTP APIs". These RFCs define a simple and consistent format for returning machine-readable error details in HTTP responses, making it easier for clients to understand and handle errors.

A typical error response looks like:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.4",
  "title": "ForbiddenError",
  "status": 403,
  "detail": "Email not found",
  "instance": "/some/auth/api",
  "stackTrace": null,
  "data": {},
  "traceId": "00-ba7caa31ee5df34fc096f18d1f59e0a1-f267eba106716031-01"
}
  • type: A URI reference that identifies the problem type.
  • title: A short, human-readable summary of the problem.
  • detail: A human-readable explanation specific to this occurrence of the problem.
  • instance: A URI reference that identifies the specific occurrence of the problem.

For more information and advanced usage, refer to the official RFCs linked above. This approach ensures error responses are predictable and easy to integrate with automated error handling in your applications.