DevelopersOsai website ↗
API v1
Financial workflows

Credential management

Create, inspect, rotate and revoke application credentials without exposing secrets.

Issue for a defined responsibility

Authorized institutions create credentials with POST /v1/credentials. Use a meaningful label and the credential scope supplied to your institution. Read endpoints return metadata; secrets are shown only on creation or rotation. Store the secret immediately.

Coordinate rotation

POST /v1/credentials/{public_id}/rotate replaces the active secret immediately. There is no overlap window. Coordinate application cutover and monitor authentication failures; do not assume the old secret remains valid.

Revoke and investigate

DELETE /v1/credentials/{public_id} revokes a credential. Permitted Console operators can use the credential-revocation workflow. Retain audit references and inspect affected application queues without logging secrets.

16 suggested pages

Get startedIntroductionIntegrate institutional FX and stablecoin trading with quotes, orders, market data, account records and settlement reporting.Get startedQuickstartMake an authenticated read, request a quote and follow an instruction without losing its original references.Get startedAuthenticationUse the correct authentication scheme for API credentials, Console sessions and market-data feeds.Get startedErrorsDistinguish invalid inputs, denied access, conflicts, rate limits and uncertain outcomes.Get startedRate limitsUse response headers, bounded concurrency and backoff rather than repeated bursts.Get startedAmounts & precisionKeep minor-unit money, fixed-point FX rates and instrument-scaled quantities exact.Get startedPagination & recoveryUse each resource’s pagination model and preserve stable recovery checkpoints.Financial workflowsQuotes & acceptanceRequest explicit FX economics, review conditions and retain accepted terms.Financial workflowsTrade lifecycleTrack funding, execution and settlement as distinct business transitions.Financial workflowsBalances & transactionsRead institutional financial positions and reconcile movements by currency.Financial workflowsBeneficiariesRegister beneficiaries and coordinate their institutional approval lifecycle.Financial workflowsCredential managementCreate, inspect, rotate and revoke application credentials without exposing secrets.Events & reliabilityIdempotencyPrevent duplicate financial effects across retries and uncertain outcomes.Events & reliabilityWebhooks & verificationVerify deliveries, persist original events and make downstream processing idempotent.Events & reliabilityEvent payloadsUnderstand the customer event envelope and business transitions behind subscriptions.Events & reliabilityDelivery retries & replayRepair webhook delivery without creating a second business event.