Skip to content

Deel: EOR worker information schemas

9 Deel schemas with complete fields and constraints.

← EOR worker information operations · All schemas

Add additional information — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add additional information — 200 response body — data

Referenced models: Add additional information — 200 response body — data

Add additional information — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
updatedbooleanRequired within parentIndicates if contract was updated

Add additional information — request body — body data

FieldTypePresenceDescription and constraints
$objectRootAdditional fields are country/state-specific and validated against the worker additional fields form for the employment country.
citystringRequired within parentCity
is_compliance_access_allowedbooleanRequired within parentWorker access to compliance documents
is_payslip_access_allowedbooleanRequired within parentWorker access to payslips
phonestringRequired within parentWorker phone
statestringOptionalState/province (required for countries with provinces/states).
streetstringRequired within parentStreet
tax_residencestringRequired within parentWorker tax residence
zip_codestringRequired within parentZipcode/Post code

Add bank account — eor Worker Information create Eorworker Bank Account — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add bank account — eor Worker Information create Eorworker Bank Account — 201 response body — data

Referenced models: Add bank account — eor Worker Information create Eorworker Bank Account — 201 response body — data

Add bank account — eor Worker Information create Eorworker Bank Account — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID of Bank Account.

Add bank account — eor Worker Information create Eorworker Bank Account — request body — body data item

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentThe key of the bank account properties.
valuestringRequired within parentThe value for that key property.

List of tax documents for an employee — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List of tax documents for an employee — 200 response body — data item

Referenced models: List of tax documents for an employee — 200 response body — data item

List of tax documents for an employee — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalCountry of the tax document
idstringOptionalId of the tax document
typestringOptionalType of the tax document
urlstringOptionalURL of the tax document
yearJSONOptional
year (anyOf 1)numberAlternativeYear of tax document
Format: double
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update additional information — request body — body data

FieldTypePresenceDescription and constraints
$objectRootYou can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).
citystringOptionalCity
dobstringOptionalDate of birth (ISO 8601 date)
is_compliance_access_allowedbooleanOptionalWorker access to compliance documents
is_payslip_access_allowedbooleanOptionalWorker access to payslips
phonestringOptionalWorker phone
statestringOptionalState/province
streetstringOptionalStreet
tax_residencestringOptionalWorker tax residence
zip_codestringOptionalZipcode/Post code

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.