Introduction

Welcome to the OnboardMe Partner API. REST, JSON, regional hosting, and API key authentication for practice integrations.

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. Need a sandbox practice? Email [e-mail].

Capabilities

Area	What you can do
Clients	List, get, create; read integration IDs (XPM, Karbon, FYI, QuickBooks, FreeAgent)
Contacts	List people linked to a client; create and update contacts
Leads	List, create, add notes, convert a lead to an Active client
Deals	List, get, create, and attach notes
eForms	List templates; send to a stored client or ad-hoc recipient
Identity	Send KYC (optional AML); standalone AML; download certificates
Onboarding	Create jobs, track recipients, list and download documents
Proposals	List, get, PDF, create, duplicate, renew, services, packages, XPM/FYI catalogs
Bills	List by date range, get, PDF, create adhoc bills, ledger lookups
Webhooks	Subscribe, list events, test deliveries, verify HMAC signatures

A practice is hosted in exactly one region. Use that region’s base URL for every request. See Regions.

Base URL

https://anzapi.onboardme.app

Headers

{
  "X-OM-Auth-ID": "YOUR_CLIENT_ID",
  "X-OM-Auth-Key": "YOUR_CLIENT_SECRET",
  "Accept": "application/json",
  "Content-Type": "application/json"
}