Error Responses

All API requests will follow below error response structure:

  • Http: 4xx or 5xx
  • example payload:
{
"type": "string",
"title": "Compact error message",
"status": 400,
"detail": "Error message",
"instance": "string",
"errors": [
{
"code": "string",
"message": "Optional: Detailed error message",
"explanation": "Optional: Extra explanation on cause and sometimes instructions how to resolve"
}
]
}

alt text