AgencyMax developer documentation
The AgencyMax platform exposes REST APIs so you can integrate your systems with AgencyMax. All of the APIs are reached through a single API gateway.
- The API Portal is the interactive API reference. Use it to browse the OpenAPI definitions, try operations and manage your subscription keys.
- This site covers what an API definition can't: concepts, business rules, worked examples and guidance that applies across the APIs.
The APIs
| API | What it's for |
|---|---|
| Agency Management | Agents, their certifications (licenses), payees, W9s, contact details, teams and upline hierarchy, plus reference data. |
| Agent Onboarding | Agent applications, onboarding app configuration, contracts, covenants and background questions. |
| Business Insights | Pre-built business queries such as leader bulletins and license listings, and tabular report recipes. |
| Identity Management | AgencyMax user accounts and roles. |
| Webhooks | Subscriptions that deliver HTTPS notifications when AgencyMax events occur. |
Quick start
- Get access. Ask your AgencyMax representative for a subscription to the API products you need and for OAuth client credentials for your agency (tenant). Start in the Test environment. See Developing against Test.
- Find your subscription key in the API Portal. See Subscription keys.
- Request an access token that includes your tenant scope and the API scopes you need. See Authentication.
- Call the API in Test. Send both the key and the token:
curl https://api-test.agencymax.example.com/agency-management/acme/agents?pageSize=10 \
-H "Ocp-Apim-Subscription-Key: $SUBSCRIPTION_KEY" \
-H "Authorization: Bearer $ACCESS_TOKEN"
- Read the API fundamentals before you build a production integration. They cover errors, paging, rate limits, partial updates and other behavior shared by every API.
Keeping up to date
- Release Notes list every API release, what changed and when it reached Test and Production.
- The Blog covers upcoming changes and our thinking on AgencyMax matters.