Developer integration coverage
Find the implementation guide, contract-derived code recipe and API Reference for every public operation.
Start with Build your integration, then Implement a backend client. This map connects every external integration operation in the current API to its integration guide and code recipe.
Recipes contain source examples and documented response statuses; they do not prove a live deployment supports every capability. Read Limitations, especially for dashboard and reserve data, policy simulation, machine authentication and automation execution outcomes. Use only the areas your integration needs; administrator operations are not prerequisites for every token operation.
Guided walkthroughs
Start with Connect and read a balance, then browse Recipes for provisioning, token operations, webhooks, approvals and recovery. Every walkthrough includes JavaScript and Python.
How to use the examples
- Read the linked guide for prerequisites, responsibilities and lifecycle behaviour.
- Open the code recipe for the method, required parameters, source request example and a potential response.
- Follow the API Reference link for every schema field, alternative example and error response. Try It remains available there.
- Replace example identifiers with your own environment's values, then track asynchronous outcomes separately from acceptance.
Examples are regenerated from the external-integration projection of api/openapi.yaml during publishing. Quant platform provisioning, global SYSTEM-template writes and the separate institution-identifier product are excluded; customer team administration and tenant-owned templates remain included. Existing guide prose remains reviewed content. A new API area must be mapped to an integration guide before publication can pass.
Audit events
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/audit/events | List audit events | search |
GET /api/audit/events/export | Export the filtered audit events as CSV | export |
GET /api/audit/events/{eventId} | Read one audit event in full | getById |
Auth
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/auth/login | Sign in | login |
POST /api/auth/refresh | Refresh the access token | refresh |
POST /api/auth/new-password | Set your first password | completeNewPassword |
POST /api/auth/activate | Activate an invited account in one call | activate |
Machine clients
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/auth/m2m-secret/{token} | Reveal client secret (one time only) | revealM2mSecret |
Team members
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/tenants/{id}/users | Invite a member | createTenantUser |
GET /api/tenants/{id}/users | List team members | listTeamMembers |
DELETE /api/tenants/{id}/users/USERID | Remove a team member | removeTeamMember |
PATCH /api/tenants/{id}/users/USERID/role | Change a member's role | changeUserRole |
Roles
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/tenants/{id}/roles | Create a custom role | createRole |
GET /api/tenants/{id}/roles | List roles | listRoles |
GET /api/tenants/{id}/roles/{roleId} | View a role and who holds it | getRole |
PUT /api/tenants/{id}/roles/{roleId}/permissions | Replace a custom role's permissions | updateRolePermissions |
Permissions
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/permissions | The permission catalog | getPermissions |
Approval groups
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/tenants/{id}/groups | Create an approval group | createGroup |
GET /api/tenants/{id}/groups | List approval groups | listGroups |
GET /api/tenants/{id}/groups/{groupId} | View a group and its members | getGroup |
PUT /api/tenants/{id}/groups/{groupId} | Rename or re-describe a group | updateGroup |
DELETE /api/tenants/{id}/groups/{groupId} | Deactivate a group | deactivateGroup |
POST /api/tenants/{id}/groups/{groupId}/members | Add a member | addGroupMember |
DELETE /api/tenants/{id}/groups/{groupId}/members/USERID | Remove a member | removeGroupMember |
Users
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/users/me | The caller's own profile | getCurrentUser |
PATCH /api/users/me | Change the caller's own name | updateCurrentUserName |
GET /api/users/{id} | Get a user by id | getUser |
Reserves
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/reserves/attestation | Retrieve the current reserve attestation per currency | getReserveAttestation |
GET /api/reserves/attestation/snapshot | Point-in-time reserve attestation snapshot | getSnapshot |
Dashboard
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/dashboard/summary | Dashboard summary with KPIs, instruments, compliance, and FX rates | getSummary |
GET /api/dashboard/issuance | Issuance breakdown by period | getIssuance |
GET /api/dashboard/activity | Recent activity events | getActivity |
Webhooks
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/webhooks | List the organisation's webhook registrations | listWebhooks |
POST /api/webhooks | Register a webhook destination | registerWebhook |
GET /api/webhooks/{id} | Read one webhook registration | getWebhook |
PATCH /api/webhooks/{id} | Change a registration's status or subscribed event types | updateWebhook |
DELETE /api/webhooks/{id} | Delete a webhook registration | deleteWebhook |
POST /api/webhooks/{id}/secret/rotate | Issue a new HMAC secret, keeping the previous one briefly valid | rotateSecret |
POST /api/webhooks/{id}/test | Send one signed test delivery now, and return the outcome | sendTestDelivery |
Delivery history
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/webhook-events | List the events queued for this organisation, with their deliveries | listWebhookEvents |
GET /api/webhook-events/{id} | One event by id, with every delivery of it | getWebhookEvent |
POST /api/webhook-events/{id}/redeliver | Queue one event to be delivered again | redeliverWebhookEvent |
POST /api/webhook-events/redeliver | Queue every settled delivery a filter selects to be delivered again | redeliverWebhookEventsMatching |
Automations
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/automations | List automations | listAutomations |
POST /api/automations | Create an automation | createAutomation |
DELETE /api/automations/{automationId} | Delete an automation | deleteAutomation |
GET /api/automations/{automationId}/history | Get an automation's status change history | getAutomationHistory |
PATCH /api/automations/{automationId}/status | Update an automation's status | updateAutomationStatus |
Executions
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/automations/{automationId}/executions | Run an on demand automation | requestExecution |
Scripts
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/scripts | Import a script | importScript |
GET /api/scripts/{scriptId} | Get a script | getScript |
PATCH /api/scripts/{scriptId} | Update a script | updateScript |
DELETE /api/scripts/{scriptId} | Delete a script | deleteScript |
GET /api/scripts/{scriptId}/versions | List a script's versions | getScriptVersions |
GET /api/scripts/{scriptId}/download | Download a script's source | downloadScript |
POST /api/scripts/{scriptId}/clone | Clone a script | cloneScript |
Policies
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/policies | List policies | listPolicies |
POST /api/policies | Create a policy | createPolicy |
GET /api/policies/{policyId} | Get a policy | getPolicy |
PATCH /api/policies/{policyId} | Update policy name and description | updatePolicy |
GET /api/policies/{policyId}/versions | List versions | listPolicyVersions |
POST /api/policies/{policyId}/versions | Create a new version | createPolicyVersion |
POST /api/policies/{policyId}/activate | Activate a policy | activatePolicy |
PUT /api/policies/{policyId}/current-version | Set the current version | setCurrentVersion |
POST /api/policies/{policyId}/archive | Archive a policy | archivePolicy |
Templates
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/templates | List templates visible to the tenant | listTemplates |
POST /api/templates | Create a TENANT template | createTenantTemplate |
GET /api/templates/{templateKey} | Get one template | getTemplate |
PUT /api/templates/{templateKey} | Update a TENANT template | updateTenantTemplate |
POST /api/templates/{templateKey}/deprecate | Deprecate a TENANT template | deprecateTenantTemplate |
Approvals
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/approvals/tasks | The caller's inbox | listMyTasks |
GET /api/approvals/requests | List approval requests | listRequests |
POST /api/approvals/requests | Create an approval request directly | createRequest |
GET /api/approvals/requests/{requestId} | Get one approval request | getRequest |
POST /api/approvals/requests/{requestId}/cancel | Cancel a pending request | cancelRequest |
POST /api/approvals/tasks/{taskId}/approve | Approve a task | approveTask |
POST /api/approvals/tasks/{taskId}/reject | Reject a task | rejectTask |
POST /api/approvals/tasks/{taskId}/reassign | Move a pending task to a different approver or group | reassignTask |
Contracts
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/contracts | Deploy the token contract for an asset | deployContract |
GET /api/contracts | List contracts | listContracts |
PATCH /api/contracts/{assetId} | Activate or deactivate a contract | updateContractStatus |
Customers
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/customers | Register a customer | registerCustomer |
GET /api/customers | List customers | listCustomers |
GET /api/customers/{customerRef} | Get a customer | getCustomer |
PATCH /api/customers/{customerRef} | Activate or deactivate a customer | updateCustomerStatus |
Accounts
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/accounts | Register an account | registerAccount |
GET /api/accounts | List accounts | listAccounts |
GET /api/accounts/{accountRef} | Get an account | getAccount |
PATCH /api/accounts/{accountRef} | Activate or deactivate an account | updateAccountStatus |
POST /api/accounts/{accountRef}/controls | Freeze or unfreeze an account | control |
Transactions
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
POST /api/transactions | Submit a token operation | submitTransaction |
GET /api/transactions | List token operations | listTransactions |
GET /api/transactions/breaks | List the operations that failed or never got an answer | listOutstandingBreaks |
GET /api/transactions/{transactionId} | Get one token operation | getTransaction |
Balances
Integration guide · Code recipes
| Operation | API Reference | Code recipe |
|---|---|---|
GET /api/accounts/{accountRef}/balances | Get an account's balances | balances |
Coverage: 95 operations across 23 API areas, derived from API version 1.0.0.
Updated about 2 hours ago