Agent Onboarding API
The Agent Onboarding API powers the AgencyMax recruiting and onboarding experience. Use it to build your own onboarding front end, or to connect onboarding with other systems. It covers the agency's onboarding configuration (contracts, covenants, background questions and which information to collect) and the applications submitted by recruits.
| Current version | v1 |
| Base path | /agent-onboarding/{tenantIdentifier} |
| Scopes | agent-onboarding:app-configuration:read, agent-onboarding:applications:read, agent-onboarding:applications:write |
| Reference | API Portal |
Operations
| Operation | Scope | Description |
|---|---|---|
GET /app-configuration | agent-onboarding:app-configuration:read | The onboarding app configuration, including which information to collect. |
GET /background-questions | agent-onboarding:app-configuration:read | Published background questions. |
GET /contract | agent-onboarding:app-configuration:read | The current published contract. |
GET /contract/versions/{id} | agent-onboarding:app-configuration:read | A specific contract version. |
GET /contract-covenants | agent-onboarding:app-configuration:read | Published contract covenants that the recruit must affirm. |
GET /applications | agent-onboarding:applications:read | A paged list of applications. |
GET /applications/{id} | agent-onboarding:applications:read | A single application. |
POST /applications | agent-onboarding:applications:write | Create an application. |
PUT /applications/{id} | agent-onboarding:applications:write | Replace an application. |
POST /applications/{id}/validation | agent-onboarding:applications:write | Check whether an application is ready to submit. |
Typical flow
Once an application is complete, it moves through the agency's review process and, when approved, is turned into an agent in the Agency Management API.