DevelopersOsai website ↗
API v1
Institutional operations

Workspace & invitations

Use company access links, approved membership and scoped sessions.

Company workspace links

The company slug resolves institution context through /api/auth/company/{slug}. Begin sign-in through its /start action and configured identity provider. Access derives from workspace and membership records, not a caller-controlled institution field.

Invitation lifecycle

Administrators create, inspect, cancel and reissue invitations using required versions and reasons. Pending delivery, sent delivery and accepted membership are distinct. An invitation record alone does not prove email delivery.

Roles and revocation

Inspect roles and permissions, enforce required MFA and audit membership changes. Sign-in and transaction approval are separate controls. Suspended membership and revoked checker authority affect subsequent authorization.

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.