Document data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
document_urlstring
download link, expires after 1 hour
document_datastring
base64 encoded file contents for create/update
filenamestring
type enum
Valid values:
"CONTRACT"
"OFFER_LETTER"
"POLICY"
"TAX"
"ID"
unified, normalized document type (OTHER when unmappable)
user_idstring
pointer to the HR Employee object that owns this document (reference to HrisEmployee)
company_idstring
(reference to HrisCompany)
Are we missing anything? Let us know
Was this page helpful?