Environments

UDAI provides separate API hosts so integrators can build safely before operating in production.

Hosts

All REST paths in this documentation are relative to /v1 on the host you choose.

Sandbox

Use the sandbox while building and validating integrations. Start with the Integration Kit. Full sandbox access steps are in Sandbox.

• Same API surface as the API overview
• Requires a partner API key (partner-api-key) and, for most routes, a user JWT
• Organisation context via X-Organisation-ID where applicable
• Data may be reset. Do not store production credentials or unnecessary personal data here.

Access

1. Register an organisation through the standard onboarding process.
2. Ensure at least one verified Admin or Owner user.
3. Follow Standards and Interoperability.
4. Request a sandbox partner key through your DFI or AAI integration contact.

Staging

Use staging for a production-like rehearsal before go-live. Access requires an active integration agreement. Data may be reset periodically.

Production

Production is restricted to verified organisations with approved operational status. Treat it as mission-critical. Do not run exploratory load tests against it.

Authentication

• Partner key. Identifies the integrating platform.
• User JWT. Identifies the acting user.
• Rotate keys on a schedule aligned with your security policy.

Rate limiting

Fair-use quotas apply by organisation type and volume. Sustained excess traffic returns 429 Too Many Requests.