X1 Public API
The reference.
Both portals are built on this API, so there is no privileged internal route and nothing our own screens can do that you cannot. Two surfaces, the same conventions across every endpoint on both.
Four rules the whole API keeps.
Applied across all 114 endpoints rather than to whichever ones were written most recently.
Every mutation takes a key
No Idempotency-Key header, no write. It is required rather than optional, because the retry you did not plan for is the one that posts twice.
Money is a string
Amounts cross the wire as decimal strings with an explicit currency. Nothing here will hand you a float and hope.
Identifiers are opaque
Prefixed, sortable, and not a sequence. You cannot infer our volumes from an identifier, and neither can anybody else.
Errors name the rule
A rejection says which constraint refused and what it was evaluating, rather than returning a generic validation failure and a shrug.
Send it twice. Nothing happens twice.
The second call does not re-execute. It returns the stored response from the first, which is why the body is identical rather than merely equivalent.
Resources.
The shape of the surface. Each resource names the module behind it, so a question about behaviour has somewhere to go.
Parties
C3People and legal entities, the relationships between them, and the ownership graph those relationships form.
- POST
/v1/partiesCreate a natural person or legal entity - GET
/v1/parties/{id}Read a party with its current standing - PATCH
/v1/parties/{id}Amend attributes, recorded as a change - POST
/v1/parties/{id}/relationshipsRecord a holding or a role, with its source - GET
/v1/parties/{id}/ownershipEffective ownership, computed through every layer
Accounts and wallets
C2Product accounts, the per-currency wallets on them, and the balances those wallets project.
- POST
/v1/accountsOpen an account for a party - GET
/v1/accounts/{id}Read an account and its status - POST
/v1/accounts/{id}/walletsAdd a currency to an account - GET
/v1/accounts/{id}/balancesAvailable and pending, per currency - POST
/v1/accounts/{id}/restrictionsImpose a restriction with a basis and a reason
Transactions
C1The book of record. A transaction writes a set of entries that must sum to zero per currency, or it does not commit.
- POST
/v1/transfersPost a transfer between accounts - GET
/v1/transactions/{id}Read a transaction with its entries - GET
/v1/transactionsList and filter, with cursor pagination - POST
/v1/transactions/{id}/reversalsReverse by appending, never by editing
Instructions
M1Payments leaving and arriving, with the state machine that decides what happens when a rail stops answering.
- POST
/v1/instructionsSubmit an outbound payment instruction - GET
/v1/instructions/{id}Read its current state and history - POST
/v1/instructions/{id}/cancelCancel, where the state still allows it - GET
/v1/inbound/{id}Read an inbound receipt and its attribution - POST
/v1/inbound/{id}/allocateAttribute a receipt sitting in suspense
Applications
X2Onboarding: the application, the questionnaire answers, and the decision an officer records against it.
- POST
/client/v1/applicationsStart an application - GET
/client/v1/applications/{id}Read it with the sequence still to answer - POST
/client/v1/applications/{id}/answersAnswer, attributed to the applicant - POST
/v1/applications/{id}/decisionsAccept or refuse, attributed to an officer
Controls and cases
K1Evaluations, their recorded outcomes, and the cases a review opens.
- POST
/v1/evaluationsEvaluate a subject against a policy version - GET
/v1/evaluations/{id}Outcome, execution mode and what it read - GET
/v1/casesThe queue, filterable by control and assignee - POST
/v1/cases/{id}/resolveResolve with a note and a named decider
Evidence
F3The audit chain. Readable, verifiable, and not writable through any route.
- GET
/v1/evidenceThe chain for a subject, oldest first - GET
/v1/evidence/verifyVerify the chain against its anchors
Reporting
R5The trial balance, the GL export and the safeguarding position, computed rather than stored.
- GET
/v1/reports/trial-balanceAs at a date, from a replay of entries - GET
/v1/reports/general-ledgerJournal-level export that ties to it - GET
/v1/reports/safeguardingRequirement, holdings and the day's outcome
What the errors mean.
The ones worth knowing before you write the integration rather than after.
Build against it before you commit to it.
The sandbox runs the same code with deterministic rail simulators, so you can make a payment time out on purpose and see what your integration does.