API Reference
Entry point to the OmniOmni partner APIs: authentication, Proof of Action, environments and conventions
The OmniOmni partner APIs expose the register, custody and compliance functions of the ecosystem to licensed partners and integrators. This reference groups the interactive operation pages by product. Conceptual guides (integration scenarios, onboarding, usage considerations) live in the product sections.
OmniAsset API
Parties, assets, transfers and documents of the crypto securities register.
OmniSafe API
Wallets, tokens, transfers and signing requests of the custody software.
OmniEagle API
Identity and transaction risk assessment orders and results.
Conventions
| Topic | Convention |
|---|---|
| Authentication | Bearer token (JWT) obtained through the client sign-in of each product; Accept-Language is expected on every call. See Client onboarding. |
| Sensitive actions | Signed with the Proof of Action mechanism: X-Signature, X-Signature-DateTime and X-Signature-DeviceId headers, RS256 signature created with the acting user's private key. See Proof of Action. |
| Idempotency | Non-GET methods manage idempotency through unique identifiers; some write operations accept X-Idempotency-Key. See API usage considerations. |
| Rate limits | Sandbox: limited number of non-GET requests per time window; 429 Too Many Requests when exceeded. |
| Errors | HTTP status code plus a JSON body with the status, an error-specific code and a descriptive message. |
| Environments | Sandbox hosts are shown in each operation's playground; production endpoints are provided during onboarding. |
Using the playground
Choose an operation
Open an operation page from the sidebar. The playground shows the server, path, parameters and response schema.Authorise
Paste a bearer token obtained from the product's client sign-in.Send against the sandbox
Requests run against the sandbox environment through the documentation proxy. Do not use production credentials here.Operation pages are available in English. German navigation labels are provided; the operation content itself is not translated.