Capabilities
Want an AI assistant to use OnboardMe? The MCP server wraps this API for Claude, ChatGPT, Cursor and other MCP clients.
A practice is hosted in exactly one region. Use that region’s base URL for every request. See Regions.
https://anzapi.onboardme.app
https://ukapi.onboardme.app
https://zaapi.onboardme.app
{
"X-OM-Auth-ID": "YOUR_CLIENT_ID",
"X-OM-Auth-Key": "YOUR_CLIENT_SECRET",
"Accept": "application/json",
"Content-Type": "application/json"
}
API documentation
Introduction
Welcome to the OnboardMe Partner API. REST, JSON, regional hosting, and API key authentication for practice integrations.
https://anzapi.onboardme.app
https://ukapi.onboardme.app
https://zaapi.onboardme.app
{
"X-OM-Auth-ID": "YOUR_CLIENT_ID",
"X-OM-Auth-Key": "YOUR_CLIENT_SECRET",
"Accept": "application/json",
"Content-Type": "application/json"
}
Welcome to the OnboardMe Partner API.
OnboardMe is a practice platform for onboarding, proposals, eForms, identity checks, and billing. This API gives you programmatic access so you can sync clients, send work to clients, and track status from your own product.
Whether you are building a native practice-management integration, automating compliance at scale, or connecting an internal system, the Partner API is designed to send, track, and update work with as little friction as possible.
The API is built on REST, uses standard HTTP methods and status codes, and communicates with JSON. Authentication uses a Client ID and Client secret on every request, either as headers or HTTP Basic. HTTPS only. Credentials belong to one practice.
To get started, ask the practice administrator for API credentials, then follow the Quick Start. The full contract is the OpenAPI specification. Need a sandbox practice? Email [email protected].