Skip to content

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

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

FieldTypePresenceDescription and constraints
$objectRoot
expires_atJSONOptional
expires_at (anyOf 1)stringAlternativeExpiration date time of download URL.
Format: date-time
expires_at (anyOf 2)nullAlternativeExpiration date time of download URL.
Format: date-time
updated_atstringOptionalLast modified date of the template file
Format: date-time
urlstringOptionalThe URL for the requested compliance document template.

Download submitted compliance document — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
expires_atstringOptionalExpiration date time of download URL.
Format: date-time
urlstringOptionalThe URL for the requested compliance document.

List of employee compliance documents — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayRequired within parentList of compliance documents required for the worker.
documents[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentISO 3166-1 alpha-2 country code where the document is required.
descriptionstringRequired within parentDescription of the document requirement. Empty string when no description exists.
filenamesarrayRequired within parentList of uploaded file names. Empty array when no files have been uploaded.
filenames[]stringEach item
fillablebooleanRequired within parentWhether the document can be filled through the Deel platform.
has_templatebooleanRequired within parentWhether a template is available for this document.
idstringRequired within parentUnique identifier for the compliance document requirement.
Format: uuid
is_acknowledgement_only_documentbooleanRequired within parentWhether this document only requires acknowledgement without file upload.
is_consent_requiredbooleanOptionalWhether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true.
is_optionalbooleanRequired within parentWhether the document is optional for the worker. Also true when the document is required within 30 days.
namestringRequired within parentDisplay name of the compliance document.
rejection_messagestringRequired within parentPlain text message explaining why the document was rejected. Empty string when no rejection message exists.
required_in_30_daysbooleanRequired within parentWhether the document is required within 30 days of employment start.
statusJSONRequired within parentReview status of the uploaded document, null if no document has been uploaded yet.
status (anyOf 1)stringAlternativeReview 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)nullAlternative
uploaded_atJSONRequired within parent
uploaded_at (anyOf 1)stringAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeISO 8601 timestamp when the document was uploaded, null if no document has been uploaded.
Format: date-time

Upload employee compliance document — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
successbooleanOptionalA flag denoting if the file upload was successful.

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.