BridgeFT WealthTech API platform follows the standards of the RESTful API architectural style with the common error codes being used. A typical error message from the WealthTech APIs is a json structure with the following fields:

Key	Description	When Presented
`message` String	A message summarizing the problem	Always
`validation_errors` Array of strings	A list of validation errors when invalid input data is provided	Validation failure
`eventID` String	A reference to an internally tracked error	An unexpected error is encountered

Error Codes

WealthTech API uses conventional and commonly encountered HTTP status codes. 2xx codes indicate success; 4xx are expected errors likely resulting from an invalid input or authentication failure; 5xx is returned when there is a problem with the WealthTech API.

Response Code	Description
200 OK	Operation completed successfully.
201 Created	An object or list of objects were successfully created.
400 Bad request	The request was unacceptable due to validation or a missing required input parameter for example.
401 Unauthorized	Authentication failed. Incorrect or invalid Access Token key.
403 Forbidden	The authenticated user doesn't have permissions to complete the operation.
404 Not found	The resource or endpoint doesn't exist.
429 Too many requests	This is a rate limiting error. Too many requests to the API were made within a time window. Your application should throttle back requests using exponential backoff when this error is encountered.
500, 502 or other 5xx	An unexpected error was encountered in the WealthTech API platform.
504 Timeout	The request can't be completed within 3 minutes - our timeout window. We recommend providing filter and pagination parameters in the requests.

Examples

A basic error response message from the WealthTech API is a json response:

{
  "message": "Error message text"
}

Validation errors provide additional information when invalid data was sent in the request. In this case the validation_errors key is furnished, like following:

{
  "message": "Error message text",
  "validation_errors": [
    "ID is required",
    "Name is required",
  ]
}

Handling Errors

For all 4xx errors our general suggestion is to double check the next key moments:

your Access Key is correct and valid. Simply re-generate your new key if it is expired;
make sure you are sending the correct requests containing pagination parameters and all required fields which are specified in the API reference.

In case if you have encountered any unexpected 5xx errors, please contact our Customer Support Team via Zendesk Portal providing in the ticket an information about the API endpoint you tried to call, the event ID and the error description from the response:

{
  "eventID":"c3cc54b96c554b378adcd1d27da090c2",
  "message":"Failed to do something"
}