Deel: Retrieve one compliance document of a worker contract — 200 response body — data
Retrieve one compliance document of a worker contract: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve one compliance document of a worker contract — 200 response body — data
| 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 the requirement applies to. Null for a requirement that applies everywhere. |
country (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code the requirement applies to. Null for a requirement that applies everywhere. |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | When the submission was created. Carries the same value as `uploaded_at`. Format: date-time |
created_at (anyOf 2) | null | Alternative | When the submission was created. Carries the same value as `uploaded_at`. Format: date-time |
description | string | Required within parent | What the document asks for, in the worker language. Empty string when the requirement has no description. |
filenames | array | Required within parent | Names of the files submitted against this requirement. Empty array when nothing has been submitted. |
filenames[] | string | Each item | |
has_template | boolean | Required within parent | Whether a template is provided for this document. |
id | string | Required within parent | Public UUID of the compliance document requirement. Use it as `document_id` on the other endpoints. Format: uuid |
is_acknowledgement_only_document | boolean | Required within parent | Whether the document only has to be acknowledged, with no file to submit. |
is_consent_required | boolean | Optional | Whether the worker has to consent. Present only for acknowledgement-only documents that declare the flag. |
is_required | boolean | Required within parent | Whether the worker has to submit this document. A requirement with a 30-day grace period after the employment start reads `true`: it is required, only not immediately. |
name | string | Required within parent | Display name of the document, in the worker language. |
submission_status | JSON | Required within parent | |
submission_status (anyOf 1) | string | Alternative | Reads `REVIEWING` while a submission is not final yet. Null at every other time. |
submission_status (anyOf 2) | null | Alternative | Reads `REVIEWING` while a submission is not final yet. Null at every other time. |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | When the submission was last changed. Null when nothing has been submitted. Format: date-time |
updated_at (anyOf 2) | null | Alternative | When the submission was last changed. Null when nothing has been submitted. Format: date-time |
uploaded_at | JSON | Required within parent | |
uploaded_at (anyOf 1) | string | Alternative | When the submission was created. Null when nothing has been submitted. Format: date-time |
uploaded_at (anyOf 2) | null | Alternative | When the submission was created. Null when nothing has been submitted. Format: date-time |