Reference data
Each agency keeps its own lists of reference values, which other resources refer to by code. Reading them needs read:agents, and changing them needs write:agents.
This data rarely changes, so cache it in your integration.
| Resource | Operations | Key |
|---|---|---|
| Certification types | GET/POST /certification-types, PATCH/DELETE /certification-types/{code} | code |
| Jurisdictions | GET/POST /jurisdictions, GET/PATCH/DELETE /jurisdictions/{id} | id, e.g. US-TX |
| Pay statuses | GET/POST /pay-statuses, GET/PATCH/DELETE /pay-statuses/{name} | name |
| Tags | GET/POST /tags, GET/PATCH/DELETE /tags/{name} | name |
| Agent levels | GET/POST /teams/{team}/agent-levels, GET/PATCH/DELETE /teams/{team}/agent-levels/{value} | value (integer) |
Certification types
The kinds of certification an agency tracks, such as LIFE, HEALTH or AML. The type on a certification must be one of these codes. An unknown code gives The specified certification type is not recognized.
Jurisdictions
The states, provinces and territories the agency works in, in the US-TX form. They're used by certifications, addresses and agent filters.
Pay statuses
The pay statuses defined by the agency, used by payees. Each status says whether an agent with that status counts as active, which drives the isActive filter on GET /agents.
Tags
Labels that can be assigned to agents.
Agent levels
The numeric levels, or ranks, in a team's hierarchy, each with a display name. The level in team membership must be one of these values.
Deleting reference data
Reference values that are still in use generally can't be deleted. Remove or change the records that use them first.