Skip to content

Deel: Worker information schemas

24 Deel schemas with complete fields and constraints.

← Worker information operations · All schemas

Add GP Workers Additional Information — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Add GP Workers Additional Information — 201 response body — data

Referenced models: Add GP Workers Additional Information — 201 response body — data

Add GP Workers Additional Information — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalDatetime of submission of the additional information

Add GP Workers Additional Information — request body — body data value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternativeMaximum length: 1000
$ (oneOf 2)numberAlternativeFormat: double
$ (oneOf 3)booleanAlternative

Add bank account — worker Information create Gpworker Bank — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add bank account — worker Information create Gpworker Bank — 201 response body — data

Referenced models: Add bank account — worker Information create Gpworker Bank — 201 response body — data

Add bank account — worker Information create Gpworker Bank — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp of when the bank account was created, in ISO-8601 format.
Format: date-time
idstringRequired within parentUnique identifier for the newly added bank account.
Format: uuid
statusstringRequired within parentThe status of the newly added bank account.
updated_atstringRequired within parentTimestamp of the last update to the bank account, in ISO-8601 format.
Format: date-time

Modify bank account — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Modify bank account — 200 response body — data

Referenced models: Modify bank account — 200 response body — data

Modify bank account — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp of when the bank account was created, in ISO-8601 format.
Format: date-time
idstringRequired within parentUnique identifier for the modified bank account.
Format: uuid
statusstringRequired within parentThe status of the modified bank account.
updated_atstringRequired within parentTimestamp of the last update to the bank account, in ISO-8601 format.
Format: date-time

Modify bank account — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringOptionalThe user's bank account number.
account_typestringOptionalBank account type.
ach_routing_numberstringOptionalThe ACH (Automated Clearing House) Routing Number.
address_line1stringOptionalThe primary address line.
address_line2stringOptionalThe secondary address line.
bank_branch_namestringOptionalThe name of the user's bank branch.
bank_codestringOptionalThe bank code.
bank_country_codestringOptionalThe country code where the bank is located.
bank_namestringOptionalName of the user's bank.
branch_codestringOptionalThe branch code of the user's bank.
citystringOptionalThe city of the user's address.
country_codestringOptionalThe country code of the user's address.
currency_codestringOptionalThe currency code for transactions.
emailstringOptionalThe user's email address.
full_namestringOptionalFull name of the user.
ibanstringOptionalThe International Bank Account Number (IBAN).
original_namestringOptionalThe original name of the user.
phonestringOptionalThe user's phone number.
postalstringOptionalThe user's postal or ZIP code.
province_statestringOptionalThe state or province of the user's address.
rib_numberstringOptionalThe RIB (Relevé d'Identité Bancaire).
swift_bicstringOptionalSWIFT/BIC code for the bank.
tax_idstringOptionalThe user's tax identification number.

Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body — data item

Referenced models: Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body — data item

Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringOptionalThe user's bank account number.
account_typestringOptionalBank account type.
ach_routing_numberstringOptionalThe ACH (Automated Clearing House) Routing Number.
address_line1stringOptionalThe primary address line.
address_line2stringOptionalThe secondary address line.
bank_branch_namestringOptionalThe name of the user's bank branch.
bank_codestringOptionalThe bank code.
bank_country_codestringOptionalThe country code where the bank is located.
bank_namestringOptionalName of the user's bank.
branch_codestringOptionalThe branch code of the user's bank.
citystringOptionalThe city of the user's address.
country_codestringOptionalThe country code of the user.
created_atstringRequired within parentLong date-time format following ISO-8601.
Format: date-time
currency_codestringOptionalThe currency code for transactions.
emailstringOptionalThe user's email address.
full_namestringOptionalFull name of the user.
ibanstringOptionalThe International Bank Account Number (IBAN).
idstringRequired within parentUnique identifier of this resource.
original_namestringOptionalThe original name of the user.
phonestringOptionalThe user's phone number.
postalstringOptionalThe user's postal or ZIP code.
province_statestringOptionalThe state or province of the user's address.
rib_numberstringOptionalThe RIB(Relevé d'Identité Bancaire).
sort_codestringOptionalUK sort code.
statusstringOptionalCurrent status of bank account.
swift_bicstringOptionalSWIFT/BIC code for the bank.
tax_idstringOptionalThe user's tax identification number.
updated_atstringRequired within parentLong date-time format following ISO-8601.
Format: date-time

Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body — data item

Referenced models: Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body — data item

Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentThe unique key representing the field.
labelstringOptionalThe label or display name for this field.
requiredbooleanRequired within parentIndicates whether the field is required.
typestringOptionalThe type of the field, such as 'Text' or 'Dropdown'.
validationsarrayOptionalAn array of validation rules applied to the field.
validations[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
values_allowedarrayOptionalAn array of allowed values for the field (e.g., for dropdown fields).
values_allowed[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item, Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item

Update GP worker additional information — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update GP worker additional information — 200 response body — data

Referenced models: Update GP worker additional information — 200 response body — data

Update GP worker additional information — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
is_additional_data_donebooleanRequired within parentTrue when all required additional information fields for EDM onboarding have been provided.
is_updatedbooleanRequired within parentIndicates if the contract was updated.
missing_keysarrayRequired within parentPublic API keys of required fields still missing. Empty when is_additional_data_done is true.
missing_keys[]stringEach item

Update PTO policy — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update PTO policy — 200 response body — data

Referenced models: Update PTO policy — 200 response body — data

Update PTO policy — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
updatedbooleanRequired within parentIndicates if the PTO policy was successfully updated.

Update PTO policy — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
accrual_start_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD). For example: '2022-12-31'.
Format: date
yearly_allowancestringRequired within parentEnter the number of holidays. Example: '15' for 15 days.

Update address — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update address — 201 response body — data

Referenced models: Update address — 201 response body — data

Update address — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternativeCity name.
city (anyOf 2)nullAlternativeCity name.
countrystringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
stateJSONOptional
state (anyOf 1)stringAlternativeState name.
state (anyOf 2)nullAlternativeState name.
streetJSONOptional
street (anyOf 1)stringAlternativeStreet name.
street (anyOf 2)nullAlternativeStreet name.
updated_atstringOptionalLong date-time format following ISO-8601
Format: date-time
zipJSONOptional
zip (anyOf 1)stringAlternativeZip code.
zip (anyOf 2)nullAlternativeZip code.

Update address — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalCity name.
streetstringOptionalStreet name.
zipstringOptionalZip code.

Update compensation — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Update compensation — 200 response body — data item

Referenced models: Update compensation — 200 response body — data item

Update compensation — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
effective_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
salarystringOptionalCompensation salary.
scalestringOptionalThe scale to which a given salary applies.
Known values: YEAR, MONTH, HOUR
statusstringOptionalThe status of a salary amendment.
Known values: ACTIVE, UPCOMING, OUTDATED

Update compensation — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
effective_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
salarynumberRequired within parentCompensation salary.
Format: double
scalestringRequired within parentThe scale to which a given salary applies.
One of: YEAR, MONTH, HOUR

Update employee information — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
employee_numberstringOptionalEmployee's unique number.

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.