Regional Base URLs for OnboardMe API

OnboardMe hosts each practice in a single region. Learn which base URL to use for ANZ, UK, and South Africa, and how regions affect your requests.

Every OnboardMe practice is hosted in exactly one region. You must direct all API requests to the base URL that matches where the practice is hosted. Using the wrong regional URL will result in authentication failures or empty responses.

Supported regions

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

How to determine the correct region

Ask the practice administrator which region their OnboardMe account is hosted in. If you are integrating with multiple practices, each one may be in a different region — you must use the correct base URL for each.

Constructing API requests

All API paths are relative to the regional base URL. For example:

GET https://ukapi.onboardme.app/api/v1/auth/validate
GET https://anzapi.onboardme.app/api/v1/entities/list
POST https://zaapi.onboardme.app/api/v1/entities

There is no cross-region routing. If a practice is in the ANZ region, calls to ukapi.onboardme.app will not return that practice’s data.

Multi-practice integrations

If your system integrates with practices across multiple regions, store the base URL alongside each practice’s credentials. Use the appropriate base URL for every request to that practice.

Practices do not span regions. A single practice’s data is always in one region only.