Key concepts
Partner account
Your top-level organisation profile. You authenticate with your registered email and a private 64-character OAuth key to receive a short-lived JWT Bearer token.
Connected accounts
The businesses, companies, or sole traders you onboard. Each gets a unique
account_id and its own multi-currency wallet balances.KYC magic links
Pre-authenticated hosted onboarding links. Your customer uploads documents and completes identity verification without seeing your API credentials.
Sandbox simulation
Instantly simulate a connected account’s KYC approval in the demo environment, so you don’t wait on manual verification while you build.
How a partner integration works
1
Authenticate
Exchange your email and OAuth key for a JWT Bearer token that lasts five minutes. Rotate your OAuth key at any time.Authenticate partner · Rotate auth key
2
Create a connected account and start KYC
Register your customer to get their
account_id, then generate a magic link so they can complete onboarding themselves.Create connected account · Get KYC magic link3
Check verification status
Check the account’s live verification state. In the demo environment, fast-track a test account to
ACTIVE with the simulation endpoint.Get connected account status · Simulate account status4
View balances and transactions
Read the account’s multi-currency wallet balances and its transaction ledger, with date filters and pagination.Get balances · Get transactions
5
Run batch payouts
Submit high-volume batch payouts over NPP or standard bank transfer, then track each line item.Batch payout · Batch status
Stay in sync
Subscribe to partner webhooks to hear about account and payout events as they happen.Get webhook events
See the events you can subscribe to.
Subscribe to events
Register an endpoint for the events you need.
Partner endpoints are available on API version 1.2.