Status Codes

This section describes the response codes used across the API

The Brass API uses standard HTTP response codes. For instance, this means: any 2xx response is successful while a 4xx means that there was an error with the data provided (like an invalid identifier number).

These errors can sometimes be handled programmatically by your application when we provide an error reason.

In the case of 5xx errors, this means we encountered an error in our software, which we will work to fix immediately.

2XX Success

Status CodeDescription
200 OKThe request succeeded.
201 CreatedThe request succeeded and the new resource was created (usually returned from POST calls).
202 AcceptedThe request has been accepted for processing, but the processing has not been completed (usually returned from endpoints that need to perform some processing in the background; for instance, account statement creation)

4XX Client Errors

Status CodeDescription
400 Bad RequestThe request cannot be processed due to some bad data provided
401 UnauthorizedThe authorization key was invalid
403 ForbiddenThe authorization key is valid but the user does not have sufficient permissions for the action
409 ConflictThe request conflicts with another request or resource.
422 Unprocessable EntityData was invalid or missing required parameters
429 Too Many RequestsThe authorized user has issued too many requests.

5XX Server Errors

Status CodesDescription
500 Internal Server ErrorOur server encountered an error while processing your request.
502 Bad GatewayA backing service that's required to process your request is failing, for instance, by returning an unrecognised response
503 Service UnavailableA backing service that required to complete processing your request is unreachable