Document data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
document_url | string | No | download link, expires after 1 hour |
document_data | string | No | base64 encoded file contents for create/update |
filename | string | No | |
type | enum | No | unified, normalized document type (OTHER when unmappable) Values: CONTRACT, OFFER_LETTER, POLICY, TAX, ID, VISA, PAYSLIP, BENEFITS, CERTIFICATION, PERFORMANCE_REVIEW, ONBOARDING, TERMINATION, MEDICAL, OTHER |
user_id | string | No | pointer to the HR Employee object that owns this document (reference to HrisEmployee) |
company_id | string | No | (reference to HrisCompany) |
Are we missing anything? Let us know