Deel: Documents schemas
31 Deel schemas with complete fields and constraints.
← Documents operations · All schemas
Add Files To Legal Entity Registration Document — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Required within parent | Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4. |
files[] | Model | Each item | Expand Upload Organization Secure Vault Files — request body — body data files item |
Referenced models: Upload Organization Secure Vault Files — request body — body data files item
Create Organization Secure Vault Folder — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create Organization Secure Vault Folder — 201 response body — data The created folder. |
Referenced models: Create Organization Secure Vault Folder — 201 response body — data
Create Organization Secure Vault Folder — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created folder. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the created folder. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the created folder. Format: uuid |
Create Organization Secure Vault Folder — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The folder to create. |
description | string or null | Optional | Optional folder description. Maximum length: 2000 |
name | string | Required within parent | Folder name. Maximum length: 255 Minimum length: 1 |
parent_folder_id | string or null | Optional | Public UUID of the parent folder. Omit to create a root folder. Format: uuid |
Delete Legal Entity Registration Document Files — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_ids | array | Required within parent | Public UUIDs of the files to remove. |
file_ids[] | string | Each item | Format: uuid |
Download Legal Entity Registration Document File — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Download Legal Entity Registration Document File — 200 response body — data |
Referenced models: Download Legal Entity Registration Document File — 200 response body — data
Download Legal Entity Registration Document File — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Required within parent | Time-limited download URL. Expires shortly after issue, so fetch it rather than storing it. |
Get Legal Entity Registration Document — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get Legal Entity Registration Document — 200 response body — data |
Referenced models: Get Legal Entity Registration Document — 200 response body — data
Get Legal Entity Registration Document — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | When the submission was archived. Format: date-time |
archived_at (anyOf 2) | null | Alternative | When the submission was archived. Format: date-time |
archived_submissions_count | JSON | Optional | |
archived_submissions_count (anyOf 1) | integer | Alternative | How many superseded revisions exist. Minimum: 0 |
archived_submissions_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
children | array | Optional | Superseded revisions of this submission, newest first. |
children[] | Model | Each item | Expand Get Legal Entity Registration Document — 200 response body — data children item |
files | array | Optional | Files attached to this submission. |
files[] | Model | Each item | Expand Get Legal Entity Registration Document — 200 response body — data files item |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the submission. Null when nothing has been submitted for this requirement yet. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the submission. Null when nothing has been submitted for this requirement yet. Format: uuid |
legal_entity | JSON | Optional | The legal entity the document belongs to. |
legal_entity (anyOf 1) | Model | Alternative | Expand Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to |
legal_entity (anyOf 2) | null | Alternative | |
parent | JSON | Optional | The submission this one replaced, when it is a resubmission. |
parent (anyOf 1) | Model | Alternative | Expand Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED |
parent (anyOf 2) | null | Alternative | |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Why the submission was rejected, when applicable. |
rejection_reason (anyOf 2) | null | Alternative | Why the submission was rejected, when applicable. |
requirement | JSON | Optional | The document requirement this submission answers. |
requirement (anyOf 1) | Model | Alternative | Expand Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers |
requirement (anyOf 2) | null | Alternative | |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | When the document was reviewed. Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | When the document was reviewed. Format: date-time |
status | string | Required within parent | Current review status. Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED |
submission_due_date | JSON | Optional | |
submission_due_date (anyOf 1) | string | Alternative | When the document is due. Format: date-time |
submission_due_date (anyOf 2) | null | Alternative | When the document is due. Format: date-time |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | When the document was submitted. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the document was submitted. Format: date-time |
Referenced models: Get Legal Entity Registration Document — 200 response body — data children item, Get Legal Entity Registration Document — 200 response body — data files item, Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to, Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED, Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers
Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The submission this one replaced, when it is a resubmission. |
id | string | Optional | Public UUID of the superseded submission. Format: uuid |
status | string | Optional | Status of the superseded submission. Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED |
Get Legal Entity Registration Document — 200 response body — data children item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | When the submission was archived. Format: date-time |
archived_at (anyOf 2) | null | Alternative | When the submission was archived. Format: date-time |
files | array | Optional | Files attached to this submission. |
files[] | Model | Each item | Expand Get Legal Entity Registration Document — 200 response body — data files item |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the submission. Null when nothing has been submitted for this requirement yet. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the submission. Null when nothing has been submitted for this requirement yet. Format: uuid |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Why the submission was rejected, when applicable. |
rejection_reason (anyOf 2) | null | Alternative | Why the submission was rejected, when applicable. |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | When the document was reviewed. Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | When the document was reviewed. Format: date-time |
status | string | Required within parent | Current review status. Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | When the document was submitted. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the document was submitted. Format: date-time |
Referenced models: Get Legal Entity Registration Document — 200 response body — data files item
Get Legal Entity Registration Document — 200 response body — data files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | JSON | Optional | |
content_type (anyOf 1) | string | Alternative | MIME type of the file. |
content_type (anyOf 2) | null | Alternative | MIME type of the file. |
id | string | Required within parent | Public UUID of the file. Format: uuid |
original_filename | string | Required within parent | Filename as uploaded. |
uploaded_at | JSON | Optional | |
uploaded_at (anyOf 1) | string | Alternative | When the file was uploaded. Format: date-time |
uploaded_at (anyOf 2) | null | Alternative | When the file was uploaded. Format: date-time |
Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The legal entity the document belongs to. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | ISO country code of the entity address. |
country (anyOf 2) | null | Alternative | ISO country code of the entity address. |
id | string | Optional | Public UUID of the legal entity. Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Legal entity name. |
name (anyOf 2) | null | Alternative | Legal entity name. |
Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The document requirement this submission answers. |
applicable_at | JSON | Optional | When the document becomes due. |
applicable_at (anyOf 1) | string | Alternative | When the document becomes due. Known values: BEFORE_FIRST_PAYROLL, ANYTIME |
applicable_at (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | What the requirement asks for. |
description (anyOf 2) | null | Alternative | What the requirement asks for. |
has_template | boolean | Optional | Whether a template is provided. Fetch it from the requirement template endpoint. |
how_client_obtains_document | JSON | Optional | |
how_client_obtains_document (anyOf 1) | string | Alternative | How to obtain it. |
how_client_obtains_document (anyOf 2) | null | Alternative | How to obtain it. |
how_the_document_is_used | JSON | Optional | How the document is used once submitted. |
how_the_document_is_used (anyOf 1) | string | Alternative | How the document is used once submitted. Known values: PAYROLL_PURPOSE, ENTITY_ONBOARDING |
how_the_document_is_used (anyOf 2) | null | Alternative | |
id | string | Required within parent | Public UUID of the requirement. Format: uuid |
is_approval_required | boolean | Optional | Whether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED. |
is_disabled | boolean | Optional | Whether the requirement is no longer requested. |
is_submission_required | boolean | Optional | Whether the document is mandatory rather than optional. |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Requirement name. |
name (anyOf 2) | null | Alternative | Requirement name. |
product_type | JSON | Optional | Product the requirement applies to. |
product_type (anyOf 1) | string | Alternative | Product the requirement applies to. Known values: EMBEDDED_PAYROLL, GLOBAL_PAYROLL, PEO |
product_type (anyOf 2) | null | Alternative | |
reference_url | JSON | Optional | |
reference_url (anyOf 1) | string | Alternative | External reference for the requirement. |
reference_url (anyOf 2) | null | Alternative | External reference for the requirement. |
why_the_document_is_needed | JSON | Optional | |
why_the_document_is_needed (anyOf 1) | string | Alternative | Why the document is required. |
why_the_document_is_needed (anyOf 2) | null | Alternative | Why the document is required. |
Get Organization Secure Vault Folder — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get Organization Secure Vault Folder — 200 response body — data The folder. |
Referenced models: Get Organization Secure Vault Folder — 200 response body — data
Get Organization Secure Vault Folder — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The folder. |
ancestors | array | Required within parent | Ancestor folders ordered from the root down to the direct parent. |
ancestors[] | Model | Each item | Expand Get Organization Secure Vault Folder — 200 response body — data ancestors item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Folder description. |
description (anyOf 2) | null | Alternative | Folder description. |
has_upload_permission | boolean | Optional | Whether the caller may upload files into this folder. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the folder. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the folder. Format: uuid |
is_sub_folder | boolean | Optional | Whether the folder is nested under another folder. |
item_type | JSON | Optional | Kind of folder. |
item_type (anyOf 1) | string | Alternative | Kind of folder. Known values: CUSTOM_FOLDER, REGISTRATION_DOC_FOLDER, DOCUMENTS_TO_SIGN_FOLDER |
item_type (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Folder name. |
name (anyOf 2) | null | Alternative | Folder name. |
parent_folder_id | JSON | Optional | |
parent_folder_id (anyOf 1) | string | Alternative | Public UUID of the parent folder. Format: uuid |
parent_folder_id (anyOf 2) | null | Alternative | Public UUID of the parent folder. Format: uuid |
Referenced models: Get Organization Secure Vault Folder — 200 response body — data ancestors item
Get Organization Secure Vault Folder — 200 response body — data ancestors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An ancestor folder. |
id | string | Optional | Public UUID of the ancestor folder. Format: uuid |
name | string | Optional | Name of the ancestor folder. |
List Legal Entity Registration Documents — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Documents for this page. |
data[] | Model | Each item | Expand Get Legal Entity Registration Document — 200 response body — data |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to pass as `cursor` for the next page. Null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to pass as `cursor` for the next page. Null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of matching documents. Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get Legal Entity Registration Document — 200 response body — data
List Organization Secure Vault Folder Items — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Folders and files for this page. |
data[] | Model | Each item | Expand List Organization Secure Vault Folder Items — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page. Null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of matching records. Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List Organization Secure Vault Folder Items — 200 response body — data item
List Organization Secure Vault Folder Items — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | JSON | Optional | |
content_type (anyOf 1) | string | Alternative | MIME type. Files only. |
content_type (anyOf 2) | null | Alternative | MIME type. Files only. |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Creation timestamp. Format: date-time |
created_at (anyOf 2) | null | Alternative | Creation timestamp. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Folder description. Null for files. |
description (anyOf 2) | null | Alternative | Folder description. Null for files. |
folder_id | JSON | Optional | |
folder_id (anyOf 1) | string | Alternative | Public UUID of the containing folder. Files only. Format: uuid |
folder_id (anyOf 2) | null | Alternative | Public UUID of the containing folder. Files only. Format: uuid |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the folder or file. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the folder or file. Format: uuid |
is_sub_folder | boolean | Optional | Whether the folder is nested under another folder. Folders only. |
item_type | JSON | Optional | Specific kind of folder or file. |
item_type (anyOf 1) | string | Alternative | Specific kind of folder or file. Known values: CUSTOM_FOLDER, REGISTRATION_DOC_FOLDER, DOCUMENTS_TO_SIGN_FOLDER, REGISTRATION_DOC_FILE, SECURE_FILE_VAULT_FILE, DOCUMENTS_TO_SIGN_FILE |
item_type (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Folder name, or the original filename for a file. |
name (anyOf 2) | null | Alternative | Folder name, or the original filename for a file. |
parent_folder_id | JSON | Optional | |
parent_folder_id (anyOf 1) | string | Alternative | Parent folder public UUID. Folders only. Format: uuid |
parent_folder_id (anyOf 2) | null | Alternative | Parent folder public UUID. Folders only. Format: uuid |
type | string | Required within parent | Discriminates folders from files. Known values: FOLDER, FILE |
uploaded_by | JSON | Optional | Who uploaded the file. Files only. |
uploaded_by (anyOf 1) | Model | Alternative | Expand List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only |
uploaded_by (anyOf 2) | null | Alternative |
Referenced models: List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only
List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who uploaded the file. Files only. |
name | string | Optional | Display name of the uploader. |
Submit Legal Entity Registration Documents — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The created submissions, in request order. |
data[] | Model | Each item | Expand Get Legal Entity Registration Document — 200 response body — data |
Referenced models: Get Legal Entity Registration Document — 200 response body — data
Submit Legal Entity Registration Documents — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | array | Required within parent | One entry per requirement being answered. |
documents[] | Model | Each item | Expand Submit Legal Entity Registration Documents — request body — body data documents item |
Referenced models: Submit Legal Entity Registration Documents — request body — body data documents item
Submit Legal Entity Registration Documents — request body — body data documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Required within parent | Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4. |
files[] | Model | Each item | Expand Upload Organization Secure Vault Files — request body — body data files item |
requirement_id | string | Required within parent | Public UUID of the requirement. Format: uuid |
Referenced models: Upload Organization Secure Vault Files — request body — body data files item
Update Legal Entity Registration Document Files — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Required within parent | Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4. |
files[] | Model | Each item | Expand Upload Organization Secure Vault Files — request body — body data files item |
submission_reason | string | Optional | Optional note explaining what changed since the previous submission. Maximum length: 2000 |
Referenced models: Upload Organization Secure Vault Files — request body — body data files item
Update Organization Secure Vault Folder — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Fields to update on the folder. |
description | string or null | Optional | New folder description. Maximum length: 2000 |
name | string | Required within parent | New folder name. Maximum length: 255 Minimum length: 1 |
Upload Organization Secure Vault Files — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload Organization Secure Vault Files — 201 response body — data Result of the upload. |
Referenced models: Upload Organization Secure Vault Files — 201 response body — data
Upload Organization Secure Vault Files — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of the upload. |
file_ids | array | Required within parent | Public UUIDs of the created Organization Secure Vault files, in upload order. |
file_ids[] | string | Each item | Format: uuid |
folder | JSON | Optional | Folder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder. |
folder (anyOf 1) | Model | Alternative | Expand Upload Organization Secure Vault Files — 201 response body — data folder id, name |
folder (anyOf 2) | null | Alternative |
Referenced models: Upload Organization Secure Vault Files — 201 response body — data folder id, name
Upload Organization Secure Vault Files — 201 response body — data folder id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Folder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Public UUID of the folder. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the folder. Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Folder name. |
name (anyOf 2) | null | Alternative | Folder name. |
Upload Organization Secure Vault Files — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The files to attach to the Organization Secure Vault. |
files | array | Required within parent | Files previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, zip, mov, mp4. |
files[] | Model | Each item | Expand Upload Organization Secure Vault Files — request body — body data files item |
Referenced models: Upload Organization Secure Vault Files — request body — body data files item
Upload Organization Secure Vault Files — request body — body data files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | string | Required within parent | MIME type. Maximum length: 255 |
file_id | string | Required within parent | File Service file id. Format: uuid |
one_time_secret | string | Required within parent | File Service one-time secret. Maximum length: 1024 Minimum length: 1 |
original_filename | string | Required within parent | Original filename. Maximum length: 500 |