Get Started with OnboardMe Partner API

Learn how to make your first OnboardMe API call in five steps: get credentials, pick a region, validate access, list clients, and run incremental sync.

Make your first successful calls against a real practice. Swap the base URL if the practice is hosted in the UK or South Africa.

Before you start

• Client ID and Client secret from the practice administrator
• The regional base URL for that practice
• An HTTP client (curl, Postman, or your language’s HTTP library)

1. Pick the regional host

   Region	Base URL
   Australia and New Zealand	https://anzapi.onboardme.app
   United Kingdom	https://ukapi.onboardme.app
   South Africa	https://zaapi.onboardme.app

   Wrong host means 401s or empty lists. Practices do not span regions.

2. Validate credentials

   cURL

   curl -sS "https://anzapi.onboardme.app/api/v1/auth/validate" \
     -H "X-OM-Auth-ID: YOUR_CLIENT_ID" \
     -H "X-OM-Auth-Key: YOUR_CLIENT_SECRET"
   

   {
     "authenticated": true,
     "message": "Access granted",
     "clientID": "your-client-id",
     "clientName": "My Integration",
     "canWrite": true,
     "timestamp": "2026-04-16T10:00:00Z"
   }
   

   If canWrite is false, POST routes return 403. Ask the administrator to enable write access when you need to create records or send forms.

3. List clients

   curl -sS "https://anzapi.onboardme.app/api/v1/entities/list?pageNumber=1" \
     -H "X-OM-Auth-ID: YOUR_CLIENT_ID" \
     -H "X-OM-Auth-Key: YOUR_CLIENT_SECRET"
   

   Store entityKey. That UUID is the foreign key for eForms, KYC, proposals, contacts, and bills.

4. Incremental sync

   After a full import, pass the UTC watermark of your last successful run:

   curl -sS "https://anzapi.onboardme.app/api/v1/entities/list?lastUpdated=2026-04-10T00:00:00Z" \
     -H "X-OM-Auth-ID: YOUR_CLIENT_ID" \
     -H "X-OM-Auth-Key: YOUR_CLIENT_SECRET"
   

   Do not send a future lastUpdated. That returns 400. See Pagination and sync.

5. Honour rate limits

   Default limits are 60/minute, 1000/hour, and 10000/day per Client ID. On 429, wait Retry-After seconds. Full table: Errors and rate limits.

Next

Sync clients

Full import, detail, integrations, and create.

Send an eForm

Templates, recipients, and mute mode.

Webhooks

Stop polling. Verify signatures.

API Reference

Interactive playground.