API Reference

All API requests return HTTP status codes that can tell you more about the error.

{
	"error": {
		"message": null, // Message explaining the cause of the error
		"code": null, // Specific code for the error
    	"data": null // Returned only when the error code is validation_error
	}
}

Status Codes

Status codeDescription
400 Bad RequestGeneral server error. The request must be reviewed before being sent again.
401 UnauthorizedThe client doesn’t have correct authentication credentials (API KEY).
403 ForbiddenThere may be a problem with permissions accessing the request resource.
404 Not FoundThe requested resource was not found.
422 Unprocessable EntityThe request body is not valid. This is typically caused by incorrect formatting or by not respecting the required fields.
429 Too Many RequestsThe client has exceeded the rate limit.
5xx ErrorsAn internal error occurred on the server. Check out the API status page or contact the support for more information.

Error Types

Error TypeDescription
authorization_error
authentication_scopes_error
authentication_error
forbidden_error
query_entries_error
request_error
validation_error
address_validation_error