Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Deactivate a client company, revoking its API key and preventing further operations.
POST /v2/companies/{companyId}/offboard (Partner Key)
Partner ──POST /v2/companies/{companyId}/offboard──> API
──> Validate Partner owns this Company
──> Deactivate Company + Revoke API Key
<── 200 OK { companyId, status: "Inactive", offboardedAt, message }
After offboarding — Company Key is invalid:
Partner ──GET /v2/documents/{id}/status (Company Key)──> API
<── 401 Unauthorized
| Field | Type | Description |
|---|---|---|
reason | string | Optional — reason for offboarding |
retainData | bool | Default: true — if false, schedules data deletion after retention period |
{
"companyId": "01HXYZ...",
"status": "Inactive",
"offboardedAt": "2026-02-11T12:00:00Z",
"dataRetentionUntil": "2026-05-11T12:00:00Z",
"message": "Company offboarded successfully"
}