Error Handling

Our APIs follow RFC 9457 and return errors in the standardized Problem JSON format. This provides a consistent, machine-readable structure for error responses, while also including human-readable details that make debugging easier.

Whenever a request fails — whether due to client-side issues (4xx status codes) or server-side errors (5xx status codes) — the response will include a Problem JSON object with the media type application/problem+json.

A Problem JSON response typically contains the following fields:

• type – A URI reference identifying the problem type. This may point to our Problem Registry, where error types are documented.
• title – A short, human-readable summary of the problem.
• status – The HTTP status code generated by the server.
• detail – A human-readable explanation specific to this occurrence of the problem.

Example:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/problem+json

{
  "type": "https://developer.quinyx.com/api/problems/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The request is not valid.",
  "errors": [
    {
      "detail": "Must be a positive integer",
      "pointer": "#/age"
    },
    {
      "detail": "must be 'green', 'red' or 'blue'",
      "pointer": "#/profile/color"
    }
  ]
}