Error Documentation

This document describes the error responses returned by the API, along with their corresponding status codes and error codes.

Error Response Structure

The error response returned by the API has the following structure:

interface ErrorResponse {
  error: {
    code: string;
    message: string;
    details?: { [key: string]: any };
  };
  status: number;
}

where:

error: An object containing the error code, error message and optional error details. status: The HTTP status code that corresponds to the error.

Error Codes and Messages

The following table describes the error codes, messages and status codes that can be returned by the API: