Introduction
REST overview, regional base URLs, and the headers every request needs.
Quick Start
Validate credentials, list clients, and make your first incremental sync in minutes.
OpenAPI spec
Download the OpenAPI 3 document for every Partner API operation.
Building blocks
Entity, lead, proposal, eForm, onboarding, bill, and webhook shapes.
Webhooks
Subscribe to events such as
proposal.accepted and eform.submitted, and verify HMAC signatures.What you can build
Clients and contacts
Full import, incremental
lastUpdated sync, create clients, and map XPM, Karbon, FYI, and QuickBooks IDs.Leads and deals
Create leads, convert them to Active clients, and keep a CRM pipeline in step with OnboardMe.
eForms
List templates and send a form to a stored client or an ad-hoc recipient, including mute mode.
Identity and AML
Trigger KYC, optional AML, standalone AML checks, and download verification certificates.
Onboarding jobs
Create jobs, track recipients, and download required documents as files or a zip.
Proposals
List, create, duplicate, renew, and read services, packages, XPM jobs, and FYI jobs.
Bills
List invoices, download PDFs, create adhoc bills, and read recurring billing schedules.
Errors and rate limits
Status codes,
Retry-After, and the per-Client-ID limits you should design for.How a solid integration works
1
Get credentials
Ask the practice administrator to create an API client. You receive a Client ID and Client secret.
2
Call the right region
Every practice lives in one region. Use ANZ, UK, or ZA for all requests. There is no cross-region routing.
3
Validate once
Call
GET /api/v1/auth/validate during setup. Read canWrite before any POST. Do not call validate before every downstream request.4
Full import, then incremental
Page through list endpoints once, store a UTC watermark, then pass
lastUpdated on later runs.5
Subscribe to events
Register webhooks for the workflow events you care about instead of polling.
Need credentials or a sandbox practice? Email [email protected].