Deel: List of worker compliance documents — 200 response body — data documents item

API reference · Contract 2026-10-27

SDK schema: List of worker compliance documents — 200 response body — data documents item

Field	Type	Presence	Description and constraints
$	object	Root
country	JSON	Required within parent
country (anyOf 1)	string	Alternative	ISO 3166-1 alpha-2 country code where the document is required.
country (anyOf 2)	null	Alternative	ISO 3166-1 alpha-2 country code where the document is required.
description	string	Required within parent	Description of the document requirement. Empty string when no description exists.
filenames	array	Required within parent	List of uploaded file names. Empty array when no files have been uploaded.
filenames[]	string	Each item
fillable	boolean	Required within parent	Whether the document can be filled through the Deel platform.
has_template	boolean	Required within parent	Whether a template is available for this document.
id	string	Required within parent	Unique identifier for the compliance document requirement. Format: uuid
is_acknowledgement_only_document	boolean	Required within parent	Whether this document only requires acknowledgement without file upload.
is_consent_required	boolean	Optional	Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.
is_optional	boolean	Required within parent	Whether the document is optional for the worker. Also true when the document is required within 30 days.
name	string	Required within parent	Display name of the compliance document.
rejection_message	string	Required within parent	Plain text message explaining why the document was rejected. Empty string when no rejection message exists.
required_in_30_days	boolean	Required within parent	Whether the document is required within 30 days of employment start.
status	JSON	Required within parent	Review status of the uploaded document, null if no document has been uploaded yet.
status (anyOf 1)	string	Alternative	Review status of the uploaded document, null if no document has been uploaded yet. Known values: AWAITING_EX_REVIEW, AWAITING_EXTERNAL_REVIEW, REJECTED, APPROVED, ON_HOLD
status (anyOf 2)	null	Alternative
uploaded_at	JSON	Required within parent
uploaded_at (anyOf 1)	string	Alternative	ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded. Format: date-time
uploaded_at (anyOf 2)	null	Alternative	ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded. Format: date-time