Status: Planned for future release. Not yet implemented.Deactivate a client company, revoking its API key and preventing further operations. Planned Endpoint:
POST /v1/companies/{companyId}/offboard (Partner Key)
| Field | Type | Description |
|---|---|---|
reason | string | Optional — reason for offboarding |
retainData | bool | Default: true — if false, schedules data deletion after retention period |
- Uses Partner Key (not Company Key) — the partner controls offboarding
- Company API key is immediately revoked upon offboarding
- Data retained by default (90-day retention) for compliance/audit purposes
- Company data becomes inaccessible via API after offboarding