Status Code Description
200 OK - The request was successful. The response payload will contain the requested data.
400 Bad Request - The server could not process the request due to a client-side error. This typically occurs when the request contains invalid arguments, missing data, or malformed syntax.
401 Unauthorized - The request failed because it lacks valid authentication credentials. The client must be authenticated to access the requested resource.
404 Not Found - The server could not find the specific resource that was requested. This often happens when an incorrect identifier (e.g., a key or ID) is provided.
499 Client Closed Request - A non-standard code indicating that the client terminated the request before the server could complete it. This can be triggered by a request timeout or if the client is rate-limited.
500 Internal Server Error - A generic error indicating that something went wrong on the server. This is a "catch-all" response for unexpected conditions that prevented the server from fulfilling the request.

API Error Response Structure

ErrorCode (string)

A machine-readable code that programmatically identifies the type of error (e.g., InternalServerError, InvalidRequest). This allows your application to handle different error types gracefully.

ErrorDescription (string)

A clear, user-friendly message explaining the error. This message is considered safe to display directly to an end-user to inform them of the issue.

RequestId (string)

The unique identifier for the API request, corresponding to the x-request-id header value. It's essential to include this ID in any support tickets or bug reports for faster tracing and debugging.

Details (string, optional)

Contains more specific, technical information about the error, which can be useful for developers during troubleshooting. This field may be empty and should not be displayed to end-users.

Example Response

Below is an example of an error response for an invalid request.

{
  "ErrorCode": "InvalidRequest",
  "ErrorDescription": "One or more parameters in your request are invalid. Please check the documentation.",
  "RequestId": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
  "Details": "Field 'email' must be a valid email address."
}