Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayRequired within parentFiles previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.
files[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe created folder.
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the created folder.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the created folder.
Format: uuid

Create Organization Secure Vault Folder — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe folder to create.
descriptionstring or nullOptionalOptional folder description.
Maximum length: 2000
namestringRequired within parentFolder name.
Maximum length: 255
Minimum length: 1
parent_folder_idstring or nullOptionalPublic UUID of the parent folder. Omit to create a root folder.
Format: uuid

Delete Legal Entity Registration Document Files — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
file_idsarrayRequired within parentPublic UUIDs of the files to remove.
file_ids[]stringEach itemFormat: uuid

Download Legal Entity Registration Document File — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parentTime-limited download URL. Expires shortly after issue, so fetch it rather than storing it.

Get Legal Entity Registration Document — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeWhen the submission was archived.
Format: date-time
archived_at (anyOf 2)nullAlternativeWhen the submission was archived.
Format: date-time
archived_submissions_countJSONOptional
archived_submissions_count (anyOf 1)integerAlternativeHow many superseded revisions exist.
Minimum: 0
archived_submissions_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
childrenarrayOptionalSuperseded revisions of this submission, newest first.
children[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data children item
filesarrayOptionalFiles attached to this submission.
files[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data files item
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
legal_entityJSONOptionalThe legal entity the document belongs to.
legal_entity (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to
legal_entity (anyOf 2)nullAlternative
parentJSONOptionalThe submission this one replaced, when it is a resubmission.
parent (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
parent (anyOf 2)nullAlternative
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeWhy the submission was rejected, when applicable.
rejection_reason (anyOf 2)nullAlternativeWhy the submission was rejected, when applicable.
requirementJSONOptionalThe document requirement this submission answers.
requirement (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers
requirement (anyOf 2)nullAlternative
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeWhen the document was reviewed.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeWhen the document was reviewed.
Format: date-time
statusstringRequired within parentCurrent review status.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
submission_due_dateJSONOptional
submission_due_date (anyOf 1)stringAlternativeWhen the document is due.
Format: date-time
submission_due_date (anyOf 2)nullAlternativeWhen the document is due.
Format: date-time
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeWhen the document was submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen 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

FieldTypePresenceDescription and constraints
$objectRootThe submission this one replaced, when it is a resubmission.
idstringOptionalPublic UUID of the superseded submission.
Format: uuid
statusstringOptionalStatus of the superseded submission.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED

Get Legal Entity Registration Document — 200 response body — data children item

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeWhen the submission was archived.
Format: date-time
archived_at (anyOf 2)nullAlternativeWhen the submission was archived.
Format: date-time
filesarrayOptionalFiles attached to this submission.
files[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data files item
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeWhy the submission was rejected, when applicable.
rejection_reason (anyOf 2)nullAlternativeWhy the submission was rejected, when applicable.
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeWhen the document was reviewed.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeWhen the document was reviewed.
Format: date-time
statusstringRequired within parentCurrent review status.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeWhen the document was submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen 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

FieldTypePresenceDescription and constraints
$objectRoot
content_typeJSONOptional
content_type (anyOf 1)stringAlternativeMIME type of the file.
content_type (anyOf 2)nullAlternativeMIME type of the file.
idstringRequired within parentPublic UUID of the file.
Format: uuid
original_filenamestringRequired within parentFilename as uploaded.
uploaded_atJSONOptional
uploaded_at (anyOf 1)stringAlternativeWhen the file was uploaded.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeWhen 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

FieldTypePresenceDescription and constraints
$objectRootThe legal entity the document belongs to.
countryJSONOptional
country (anyOf 1)stringAlternativeISO country code of the entity address.
country (anyOf 2)nullAlternativeISO country code of the entity address.
idstringOptionalPublic UUID of the legal entity.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeLegal entity name.
name (anyOf 2)nullAlternativeLegal entity name.

Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers

FieldTypePresenceDescription and constraints
$objectRootThe document requirement this submission answers.
applicable_atJSONOptionalWhen the document becomes due.
applicable_at (anyOf 1)stringAlternativeWhen the document becomes due.
Known values: BEFORE_FIRST_PAYROLL, ANYTIME
applicable_at (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeWhat the requirement asks for.
description (anyOf 2)nullAlternativeWhat the requirement asks for.
has_templatebooleanOptionalWhether a template is provided. Fetch it from the requirement template endpoint.
how_client_obtains_documentJSONOptional
how_client_obtains_document (anyOf 1)stringAlternativeHow to obtain it.
how_client_obtains_document (anyOf 2)nullAlternativeHow to obtain it.
how_the_document_is_usedJSONOptionalHow the document is used once submitted.
how_the_document_is_used (anyOf 1)stringAlternativeHow the document is used once submitted.
Known values: PAYROLL_PURPOSE, ENTITY_ONBOARDING
how_the_document_is_used (anyOf 2)nullAlternative
idstringRequired within parentPublic UUID of the requirement.
Format: uuid
is_approval_requiredbooleanOptionalWhether a submission against this requirement is reviewed. False means a submission is accepted immediately as COMPLETED.
is_disabledbooleanOptionalWhether the requirement is no longer requested.
is_submission_requiredbooleanOptionalWhether the document is mandatory rather than optional.
nameJSONOptional
name (anyOf 1)stringAlternativeRequirement name.
name (anyOf 2)nullAlternativeRequirement name.
product_typeJSONOptionalProduct the requirement applies to.
product_type (anyOf 1)stringAlternativeProduct the requirement applies to.
Known values: EMBEDDED_PAYROLL, GLOBAL_PAYROLL, PEO
product_type (anyOf 2)nullAlternative
reference_urlJSONOptional
reference_url (anyOf 1)stringAlternativeExternal reference for the requirement.
reference_url (anyOf 2)nullAlternativeExternal reference for the requirement.
why_the_document_is_neededJSONOptional
why_the_document_is_needed (anyOf 1)stringAlternativeWhy the document is required.
why_the_document_is_needed (anyOf 2)nullAlternativeWhy the document is required.

Get Organization Secure Vault Folder — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe folder.
ancestorsarrayRequired within parentAncestor folders ordered from the root down to the direct parent.
ancestors[]ModelEach itemExpand Get Organization Secure Vault Folder — 200 response body — data ancestors item
descriptionJSONOptional
description (anyOf 1)stringAlternativeFolder description.
description (anyOf 2)nullAlternativeFolder description.
has_upload_permissionbooleanOptionalWhether the caller may upload files into this folder.
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the folder.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the folder.
Format: uuid
is_sub_folderbooleanOptionalWhether the folder is nested under another folder.
item_typeJSONOptionalKind of folder.
item_type (anyOf 1)stringAlternativeKind of folder.
Known values: CUSTOM_FOLDER, REGISTRATION_DOC_FOLDER, DOCUMENTS_TO_SIGN_FOLDER
item_type (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeFolder name.
name (anyOf 2)nullAlternativeFolder name.
parent_folder_idJSONOptional
parent_folder_id (anyOf 1)stringAlternativePublic UUID of the parent folder.
Format: uuid
parent_folder_id (anyOf 2)nullAlternativePublic 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

FieldTypePresenceDescription and constraints
$objectRootAn ancestor folder.
idstringOptionalPublic UUID of the ancestor folder.
Format: uuid
namestringOptionalName of the ancestor folder.

List Legal Entity Registration Documents — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentDocuments for this page.
data[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as `cursor` for the next page. Null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to pass as `cursor` for the next page. Null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of matching documents.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentFolders and files for this page.
data[]ModelEach itemExpand List Organization Secure Vault Folder Items — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of matching records.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
content_typeJSONOptional
content_type (anyOf 1)stringAlternativeMIME type. Files only.
content_type (anyOf 2)nullAlternativeMIME type. Files only.
created_atJSONOptional
created_at (anyOf 1)stringAlternativeCreation timestamp.
Format: date-time
created_at (anyOf 2)nullAlternativeCreation timestamp.
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeFolder description. Null for files.
description (anyOf 2)nullAlternativeFolder description. Null for files.
folder_idJSONOptional
folder_id (anyOf 1)stringAlternativePublic UUID of the containing folder. Files only.
Format: uuid
folder_id (anyOf 2)nullAlternativePublic UUID of the containing folder. Files only.
Format: uuid
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the folder or file.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the folder or file.
Format: uuid
is_sub_folderbooleanOptionalWhether the folder is nested under another folder. Folders only.
item_typeJSONOptionalSpecific kind of folder or file.
item_type (anyOf 1)stringAlternativeSpecific 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)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeFolder name, or the original filename for a file.
name (anyOf 2)nullAlternativeFolder name, or the original filename for a file.
parent_folder_idJSONOptional
parent_folder_id (anyOf 1)stringAlternativeParent folder public UUID. Folders only.
Format: uuid
parent_folder_id (anyOf 2)nullAlternativeParent folder public UUID. Folders only.
Format: uuid
typestringRequired within parentDiscriminates folders from files.
Known values: FOLDER, FILE
uploaded_byJSONOptionalWho uploaded the file. Files only.
uploaded_by (anyOf 1)ModelAlternativeExpand List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only
uploaded_by (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootWho uploaded the file. Files only.
namestringOptionalDisplay name of the uploader.

Submit Legal Entity Registration Documents — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe created submissions, in request order.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayRequired within parentOne entry per requirement being answered.
documents[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayRequired within parentFiles previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.
files[]ModelEach itemExpand Upload Organization Secure Vault Files — request body — body data files item
requirement_idstringRequired within parentPublic 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

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayRequired within parentFiles previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, mov, mp4.
files[]ModelEach itemExpand Upload Organization Secure Vault Files — request body — body data files item
submission_reasonstringOptionalOptional 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

FieldTypePresenceDescription and constraints
$objectRootFields to update on the folder.
descriptionstring or nullOptionalNew folder description.
Maximum length: 2000
namestringRequired within parentNew folder name.
Maximum length: 255
Minimum length: 1

Upload Organization Secure Vault Files — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootResult of the upload.
file_idsarrayRequired within parentPublic UUIDs of the created Organization Secure Vault files, in upload order.
file_ids[]stringEach itemFormat: uuid
folderJSONOptionalFolder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder.
folder (anyOf 1)ModelAlternativeExpand Upload Organization Secure Vault Files — 201 response body — data folder id, name
folder (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootFolder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder.
idJSONOptional
id (anyOf 1)stringAlternativePublic UUID of the folder.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the folder.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeFolder name.
name (anyOf 2)nullAlternativeFolder name.

Upload Organization Secure Vault Files — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe files to attach to the Organization Secure Vault.
filesarrayRequired within parentFiles previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, zip, mov, mp4.
files[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
content_typestringRequired within parentMIME type.
Maximum length: 255
file_idstringRequired within parentFile Service file id.
Format: uuid
one_time_secretstringRequired within parentFile Service one-time secret.
Maximum length: 1024
Minimum length: 1
original_filenamestringRequired within parentOriginal filename.
Maximum length: 500

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.