Skip to main content
The Organizations API manages the identity and organization context used by the rest of the Anthid platform.

​
Access

User profile, organization creation, organization updates, and organization deletion require a user bearer token:
Selected organization reads also accept organization API keys or scoped service tokens. Onboarding updates accept users who belong to the organization or services with organization:read; API keys cannot update onboarding. Check each endpoint’s authentication section before choosing a credential.

​
Create an organization

Organization creation is a reconciled workflow. The API returns the new internal organization ID after it records the request; the backing identity-provider organization and related records are created asynchronously. Every request requires a caller-generated UUID in idempotency_key. Reuse the same key when retrying the same logical creation request, and generate a new key for a different organization.

​
Onboarding

The onboarding resource records when an organization completes these milestones:
  • ConnectedBroker
  • CreatedApiKey
  • SubmittedFirstOrder
  • ViewedDocs
  • ConfiguredControls
Mark a milestone complete with PATCH /v1/organizations/{org_id}/onboarding. The operation returns 204 No Content.

​
Deletes

DELETE /v1/organizations/{org_id} returns a body rather than an empty response:
An authorized retry returns 200 with the original deleted_at. Authorization is checked again, so a retry can fail if the caller no longer has access to the organization. resource is drawn from one vocabulary shared across the platform rather than written as free text, so a caller handling deletes from several APIs branches on the field instead of on which URL it called. The vocabulary names resources this API does not delete itself, including trading_account and test_trading_account from the Trading Accounts API. DELETE /v1/users/me is the exception and returns 204 No Content.

​
Endpoint groups