API Reference

Every endpoint in this reference is a POST request to https://api.croma.run, authenticated with a bearer API key. Pick an endpoint from the sidebar to see its full schema, example request, and a “try it” playground.

​

Supported countries

Endpoints are grouped by country, and each country has its own path prefix: GET /jobs/{id} is country-independent: it returns the status of any async job.

​

Conventions

• Auth: Authorization: Bearer <key> on every endpoint. See Authentication.
• Success: responses wrap the payload under data: { "data": … }.
• Errors: { "error": { "type", "code", "message" } } with a non-2xx status. See Errors.
• No match: a queried record that doesn’t exist is a 200, not a 404: single-record lookups return found: false, list lookups return an empty array.
• Rate limits: reported via X-RateLimit-* response headers. See Rate limits.
• Async jobs: longer-running lookups may return a 202 with a job you can poll or receive via callback. See Async jobs for the list.