Bitcall APIOverview
The Bitcall API gateway — one authenticated, permissioned entry point to every Bitcall product.
The Bitcall API is a single, hardened gateway in front of every Bitcall product. Instead of integrating each product separately, you get one base URL, one authentication scheme, and one place to manage access.
How it works
Your app ──key id + secret──▶ Bitcall API gateway ──▶ OTP · eSIM · HLR
auth · scopes · limits (downstream products)- An admin mints an API key for a tenant, with a secret and a set of scoped permissions (for example
otp:readandotp:write). - Your app sends the key id and secret as two headers on each request.
- The gateway authenticates the request, checks the key's scopes, tenant status and rate limit, then proxies it to the right product — minting the downstream credential itself.
Your app never holds or sees a downstream product's credentials. It only ever holds its Bitcall key id + secret.
Why a gateway
- One credential model. Keys, secrets, scopes and rate limits are the same across every product.
- Least privilege. Each key is scoped to exactly the products and operations it needs, and bound to one tenant.
- Safe by default. Failures reveal nothing about why they failed, and a 404 never tells you an identifier belongs to someone else.
- Add products without re‑integrating. New products appear as new scopes and routes behind the same gateway.
Start here
Quick Start
Send your first authenticated request.
Authentication
The two headers every request needs.
Key Management
How admins create, scope, rotate and revoke keys.
Products
OTP, eSIM and HLR — each with its own API reference.
Shared rules
Every product uses the same envelopes, pagination, error format and retry semantics. Learn them once:
Conventions
Response envelopes, pagination, request ids, timestamps and money.
Errors
One error shape, thirteen codes, and which are worth retrying.
Idempotency
How to retry a purchase without paying twice.
The products
| Product | What it does | API reference |
|---|---|---|
| OTP | Rent numbers and receive one‑time passcodes | OTP |
| eSIM | Provision and manage eSIM profiles and data plans | eSIM |
| HLR | Home Location Register lookups and number intelligence | HLR |
WebPhone (SIP voice calling) is documented separately and is not yet part of this API reference.
Each product is a standalone microservice with its own API. They share one credential and permission model through the gateway, and each has its own API reference — see Products.