Credentials at a glance
| Credential | Where you send it | Purpose |
|---|---|---|
api_key | HTTP header api_key | Tenant authentication and scope enforcement |
userToken | Path or body per endpoint | End-user session for contacts, funding, operations |
Typical error responses
Auth routes usually return JSON with at least areason string. Money routes often add code. Treat 400 as a client fix, 401 as a key problem, 404 as missing user, and 500 as retryable with backoff.
Example error body
Rotate keys safely
Rotate keys safely
Store keys in a secret manager, rotate when staff leave or a key leaks, and update all services before disabling the old key.
Scope and OpenAPI tags
Scope and OpenAPI tags
mTLS
mTLS
Some integrations use mutual TLS and a different host. See API overview for the mTLS base URL pattern and certificate usage.
/v1/partners/request4r — see Request4R (JWE encrypted channel).