Skip to main content
The Instant Compliance v1 API is a small, deliberately simple surface covering individual customers (KYC, on /customers) and entity customers (companies, trusts, partnerships, SMSFs — KYB, on /entities).

​
Base URL

​
Authentication

Every request requires a bearer API key in the Authorization header:
Issue keys in Settings → Developers in your Instant Compliance organisation. See Authentication for the full guide.

​
Content type

All requests and responses use application/json.

​
Endpoints

Entity endpoints use the same customers:* scopes — an entity is a customer record; only its verification track (KYB vs KYC) differs.

​
OpenAPI

The machine-readable OpenAPI 3.1 spec is available at openapi.yaml. Import it into Postman, Insomnia, Stoplight, or your preferred SDK generator.

​
Conventions

  • Identifiers. Customer ids are UUIDs. Wherever a {id} path parameter appears, you can also pass your own external_id — we detect the format and resolve accordingly.
  • Timestamps. ISO-8601 with offset (2026-06-23T01:12:00Z).
  • Pagination. Cursor-based. See Pagination.
  • Idempotency. Pass Idempotency-Key on writes. See Idempotency.
  • Errors. Standard envelope. See Errors.