Onboarding
/api/v1/vendor/onboardingAn onboarding workflow record for a vendor.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| vendor_id* | string | Id of the vendor being onboarded (e.g. 'sup_01HXABC'). |
| status | enum | pending | in_progress | completed | cancelledOnboarding status. Defaults to 'pending'. |
| started_at | date-time | When onboarding started. |
| completed_at | date-time | When onboarding completed. |
| assignee_id | uuid | Id of the user driving onboarding (e.g. 'usr_01HXABC'). |
| steps_completed | json | Array of completed onboarding step identifiers. |
| current_step | string | Current step in the onboarding workflow (e.g. 'security_review'). |
| notes | string | Free-form onboarding notes. |
| priority | enum | low | medium | highOnboarding priority. Defaults to 'medium'. |
API
client.vendor.onboarding.*Loading manifest…