Errors

Failed requests use a matching HTTP status and the same envelope as successful ones, with success: false and an error object. Branch on error.code; messages are for people and may change. Failed requests are not billed.

400 Bad Request

{
  "success": false,
  "error": {
    "code": "invalid_registry_code",
    "message": "A registry code has 8 digits, e.g. 10421629.",
    "details": {
      "parameter": "registry_code"
    }
  },
  "meta": {
    "request_id": "9d2f6c1e-5b7a-4e0c-8f3d-2a1b0c9e8d7f"
  }
}

400

The request is invalid. error.details.parameter names the parameter at fault.

invalid_parameterinvalid_registry_codeinvalid_vat_numberunknown_sectioninvalid_json

401

The API key is missing, unknown or revoked.

api_key_requiredinvalid_api_key

403

The key is valid, but API access for its organisation is not active: the API plan is off, or an invoice is overdue. Switch it on under Dashboard › Services.

api_plan_inactive

404

The endpoint or record does not exist.

not_foundcompany_not_foundperson_not_foundannual_report_not_foundclassifier_not_foundemtak_code_not_found

405

The endpoint does not accept this method.

method_not_allowed

413

The request body is larger than 256 KB.

body_too_large

429

Too many requests for this key. Wait for the Retry-After seconds.

rate_limited

500

Something failed on our side. Retry with backoff.

internal_error

503

The API is briefly unavailable. Retry shortly.

service_unavailable

504

The request took too long. Ask for less at once (fewer includes, smaller pages).

timeout

A search or lookup that finds nothing is not an error: it returns an empty list, or an empty matches for that query.