Deel: EOR worker compliance schemas
9 Deel schemas with complete fields and constraints.
← EOR worker compliance operations · All schemas
Download employee compliance document template — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Download employee compliance document template — 200 response body — data |
Referenced models: Download employee compliance document template — 200 response body — data
Download employee compliance document template — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | string | Alternative | Expiration date time of download URL. Format: date-time |
expires_at (anyOf 2) | null | Alternative | Expiration date time of download URL. Format: date-time |
updated_at | string | Optional | Last modified date of the template file Format: date-time |
url | string | Optional | The URL for the requested compliance document template. |
Download submitted compliance document — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Download submitted compliance document — 200 response body — data |
Referenced models: Download submitted compliance document — 200 response body — data
Download submitted compliance document — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_at | string | Optional | Expiration date time of download URL. Format: date-time |
url | string | Optional | The URL for the requested compliance document. |
List of employee compliance documents — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand List of employee compliance documents — 200 response body — data |
Referenced models: List of employee compliance documents — 200 response body — data
List of employee compliance documents — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | array | Required within parent | List of compliance documents required for the worker. |
documents[] | Model | Each item | Expand List of employee compliance documents — 200 response body — data documents item |
Referenced models: List of employee compliance documents — 200 response body — data documents item
List of employee compliance documents — 200 response body — data documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | 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 |
Upload employee compliance document — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload employee compliance document — 200 response body — data |
Referenced models: Upload employee compliance document — 200 response body — data
Upload employee compliance document — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
success | boolean | Optional | A flag denoting if the file upload was successful. |