Error Response Shape

All endpoints return a JSON envelope with the shape:

{
  "data": [],
  "pagination": {},
  "errors": []
}

Successful requests

On success, errors is an empty array. The response body’s data and pagination fields carry the response payload.

{
  "data": [{ "id": "123", "status": 200 }],
  "pagination": { "page": 1, "total": 1 },
  "errors": []
}

Failed requests

On failure, the HTTP status code reflects the failure class (4xx for client errors, 5xx for server errors), and errors contains one or more error objects describing what went wrong.

Caution

The exact shape of the objects inside errors is not documented yet and will be added here. In the interim, the endpoint reference at rest.efiling.co.uk/docs shows example error responses for each endpoint.

See also

• Common error codes
• Retry patterns