How Aera's REST APIs report success and errors, and where to find the response codes for each API.
Master: api-docs.aerahost.comWe're moving our API docs to docs.aera.id. Until the move is done, 19.1. Response Codes and 19.2. HTTP Error responses on api-docs.aerahost.com are the master for this page. If this page and api-docs differ, api-docs is right.
Aera's REST APIs return a responseInfo object in every JSON response.
| Field | Description |
|---|---|
responseCode | 0 means success. Any other value is an error or a warning |
timeStamp | When Aera answered, in UTC |
message | A text explaining the code. Often empty on success |
cid | Correlation ID. Include it when you contact support |
externalResponseCode | A code from a third party, for example the acquirer, when there is one |
Example error response
{
"responseInfo": {
"responseCode": "10000",
"timeStamp": "2026-03-11T17:46:05.412Z",
"message": "No report found with the provided file Id.",
"cid": "1-67d06a5d-0e7c3b1f4c2a9d8e7f6a5b4c"
}
}HTTP status codes
| Status | Meaning |
|---|---|
400 Bad Request | The request is malformed |
401 Unauthorized | The API key or access token is missing, wrong or expired |
403 Forbidden | You don't have access to this resource |
404 Not Found | The resource doesn't exist |
405 Method Not Allowed | The HTTP method isn't allowed here |
409 Conflict | What you're adding already exists |
413 Request Entity Too Large | The request is too large |
415 Unsupported Media Type | Check Content-Type and Accept |
429 Too Many Requests | You sent too many requests in a short time. Wait, then try again |
500 Internal Server Error | Aera couldn't handle the request |
504 Gateway Timeout | Aera didn't answer in time. Check the status before you try again |
Error responses with a body include responseInfo. Responses for 403, 405, 413, 415, 429 and 504 have no body.
Response codes per API
| API | Codes |
|---|---|
| All REST APIs | HTTP responses on api-docs.aerahost.com (full list) |
| Reporting API | Get report data (the ones you're most likely to see) |
| Terminal messages (Nexo) | Response codes |