Subsections
Documents
Manage documents attached to an agent record.
Notes
Add and manage internal notes on an agent record.
What’s included
Core
| Endpoint | Description |
|---|---|
| List agents | Retrieve a paginated list of agents |
| Create agent | Create a new agent record |
| Get agent | Retrieve a single agent by ID |
| Update agent | Update an existing agent’s profile |
| Update status | Transition an agent to a new status (activate, deactivate, close) |
| Decrypt sensitive data | Decrypt a protected field (e.g. SSN, bank account number) on demand |
Documents
| Endpoint | Description |
|---|---|
| List documents | Retrieve all documents attached to an agent |
| Create document | Attach a new document to an agent |
| Get document | Retrieve a single document |
| Update document | Update document metadata |
| Delete document | Remove a document from an agent |
Notes
| Endpoint | Description |
|---|---|
| List notes | Retrieve all notes on an agent record |
| Create note | Add a note to an agent record |
| Get note | Retrieve a single note |
| Update note | Edit a note on an agent record |