Skip to main content
The Ceibo public API is a JSON-over-HTTPS REST interface. Every call goes through a single gateway in front of api.ceibo.me.

Base URL

All endpoints in this reference are relative to that base. URI versioning is in effect — when a new major version ships it will live at /v2 without breaking the /v1 contract. A liveness check is available at:
It returns 200 OK with status, timestamp, and the deployed version when the API is healthy.

Authentication

Pass your API key in the x-api-key header on every request. See Authentication for the full key lifecycle and the JWT-based developer dashboard surface.

Pagination

Every list endpoint returns a paginated envelope. The shape is consistent regardless of resource:
Some resources accept additional filters (name, iso2, continent, etc.) — check the endpoint reference for what each accepts.

Timestamps

All timestamps are ISO 8601 in UTC:
Both request and response bodies use this format. Date-only fields (e.g. expires_on on a passport) use YYYY-MM-DD.

Errors

The API returns a structured error envelope on any non-2xx response:

CORS

The public API is consumable from browsers in production. Origins are allow-listed at the gateway — if you need a domain added, open an issue or contact support.

Conventions

  • Resource paths are plural (/countries, /cities).
  • IDs are integers, returned as numbers in JSON.
  • Field names are camelCase in responses; query parameters are also camelCase.
  • null is meaningful. A field returning null indicates the absence of data; the field is omitted only when explicitly noted.