API reference
Two complementary surfaces:
- OpenAPI specs — machine-readable, generate clients in any language.
- Postman collection — copy-paste-tweak, ideal for one-off exploration.
OpenAPI 3.1 specs
Each product ships its own spec at a stable URL:
| Product | Spec URL |
|---|---|
| Identity | /openapi/identity.yaml |
| AML | /openapi/aml.yaml |
| Anti-Fraud | /openapi/anti-fraud.yaml |
| Document Intelligence | /openapi/document-intelligence.yaml |
| Bank Statement | /openapi/bank-statement.yaml |
| Orchestration | /openapi/orchestration.yaml |
| AI Automation | /openapi/ai-automation.yaml |
A unified spec covering all seven products:
/openapi/quantum-elixir.yaml— single file, ~2 MB
Generated clients we test against:
- TypeScript via
openapi-typescript(opens in a new tab) - Python via
openapi-python-client(opens in a new tab) - Go via
oapi-codegen(opens in a new tab)
Specs ship monthly
We publish updated specs on the first of each month with that month's changes. Old spec URLs are versioned (/openapi/v2026-05/identity.yaml) and stay stable forever. The unversioned URL always points to the latest.
Postman collection
Download Postman collection v2.1 →
Includes:
- Every endpoint of every product
- Pre-configured environment variables (
baseUrl,apiKey,orgId) - Sample requests for the common flows (KYC, screening, transaction evaluate, statement upload)
- Pre-request and test scripts for HMAC signature generation (webhook trigger flows)
To use:
- Import the collection into Postman.
- Set
baseUrltohttps://sandbox.quantumelixir.techandapiKeyto your sandbox key. - Run the Onboarding flow folder — it walks through create-customer → KTP-capture → screening → check-tier in order.
Spec quality
We treat the specs as the canonical contract. If the spec says a field is required and the code accepts an absent value, that's a spec bug — file it via developers@quantumelixir.tech.
Tested guarantees:
- Every documented endpoint compiles via at least one generated client per language.
- Every documented field is exercised by at least one test.
- Every documented error code is produced by at least one test path.
What we don't yet promise:
- Exhaustive examples on every schema field.
- Webhook payload schemas in the same spec file (separate per-product
webhooks.yamlavailable on request). - Strict-typed bigint handling (some fields ship as
stringin JSON to avoid JS number precision loss; the spec marks them withx-quantum-bigint: true).