Skip to main content
These HTTP status codes are returned in API calls to indicate the overall success or failure of a request.

Success response shape

Most successful responses use a consistent JSON envelope:
That means:
  • the HTTP status code is in the response line
  • the same numeric code is also echoed in the JSON code field
  • the business payload is inside data

Error response shape

Client and server errors typically use this shape:
Some validation errors also include an error object or extra metadata depending on the endpoint and middleware that produced the response.

Practical integration notes

  • Treat any non-2xx response as a failed API call, even if the JSON body contains additional details.
  • Do not rely on 201 for create operations. The current verification and company-verification create endpoints return 200.
  • Always inspect the JSON message field for a human-readable explanation when a request fails.