Skip to content

Deel: Personal information schemas

17 Deel schemas with complete fields and constraints.

← Personal information operations · All schemas

Get personal information by id — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get personal information by id — 200 response body — data

Referenced models: Get personal information by id — 200 response body — data

Get personal information by id — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
addressesJSONOptional
addresses (anyOf 1)arrayAlternativeArray of addresses associated with the worker.
addresses (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item
addresses (anyOf 2)nullAlternativeArray of addresses associated with the worker.
addresses (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item
date_of_birthJSONOptional
date_of_birth (anyOf 1)stringAlternativeThe date of birth of the worker.
Format: date
date_of_birth (anyOf 2)nullAlternativeThe date of birth of the worker.
Format: date
demographicsJSONOptionalDemographic information for the worker, including gender and ethnicity.
demographics (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender
demographics (anyOf 2)nullAlternative
emergency_contactsarrayRequired within parentArray of emergency contacts associated with the worker.
emergency_contacts[]ModelEach itemExpand Get personal information by id — 200 response body — data emergency contacts item
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external id of the worker.
Maximum length: 100
external_id (anyOf 2)nullAlternativeThe external id of the worker.
Maximum length: 100
idstringRequired within parentUnique identifier for the worker.
Format: uuid
kycModelOptionalExpand Get personal information by id — 200 response body — data kyc
KYC (Know Your Customer) verification information for the worker.
legal_first_nameJSONOptional
legal_first_name (anyOf 1)stringAlternativeThe legal first name of the worker.
Maximum length: 100
legal_first_name (anyOf 2)nullAlternativeThe legal first name of the worker.
Maximum length: 100
legal_last_nameJSONOptional
legal_last_name (anyOf 1)stringAlternativeThe legal last name of the worker.
Maximum length: 100
legal_last_name (anyOf 2)nullAlternativeThe legal last name of the worker.
Maximum length: 100
nationalitiesJSONOptional
nationalities (anyOf 1)arrayAlternativeArray of nationalities associated with the worker.
nationalities (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item
nationalities (anyOf 2)nullAlternativeArray of nationalities associated with the worker.
nationalities (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item
oooJSONOptionalOut of office information for the worker, including leave type and dates.
ooo (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE
ooo (anyOf 2)nullAlternative
personal_emailJSONOptional
personal_email (anyOf 1)stringAlternativeThe personal email of the worker.
Format: email
Maximum length: 255
personal_email (anyOf 2)nullAlternativeThe personal email of the worker.
Format: email
Maximum length: 255
phone_numbersJSONOptional
phone_numbers (anyOf 1)arrayAlternativeArray of phone numbers associated with the worker.
phone_numbers (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item
phone_numbers (anyOf 2)nullAlternativeArray of phone numbers associated with the worker.
phone_numbers (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item
preferred_nameJSONOptional
preferred_name (anyOf 1)stringAlternativeThe preferred name of the worker.
Maximum length: 255
preferred_name (anyOf 2)nullAlternativeThe preferred name of the worker.
Maximum length: 255
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the worker.
Format: email
Maximum length: 255
work_email (anyOf 2)nullAlternativeThe work email of the worker.
Format: email
Maximum length: 255
worker_idJSONRequired within parent
worker_id (anyOf 1)integerAlternativeThe worker id.
worker_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item, Get personal information by id — 200 response body — data demographics ethnicity, gender, Get personal information by id — 200 response body — data emergency contacts item, Get personal information by id — 200 response body — data kyc, Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item, Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE, Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item

Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE

FieldTypePresenceDescription and constraints
$objectRootOut of office information for the worker, including leave type and dates.
end_datestringRequired within parentThe worker out of office end date.
Maximum length: 10
leave_typestringRequired within parentThe worker leave type.
Known values: LONG_TERM_LEAVE, SHORT_TERM_LEAVE
namestringRequired within parentThe worker out of office name.
start_datestringRequired within parentThe worker out of office start date.
Format: date

Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONRequired within parent
city (anyOf 1)stringAlternativeThe city.
Maximum length: 255
city (anyOf 2)nullAlternativeThe city.
Maximum length: 255
countrystringRequired within parentThe country.
Maximum length: 255
idstringRequired within parentUnique identifier for the address.
Format: uuid
stateJSONRequired within parent
state (anyOf 1)stringAlternativeThe state.
Maximum length: 255
state (anyOf 2)nullAlternativeThe state.
Maximum length: 255
streetJSONRequired within parent
street (anyOf 1)stringAlternativeThe street address.
Maximum length: 255
street (anyOf 2)nullAlternativeThe street address.
Maximum length: 255
typestringRequired within parentThe type of the address.
Known values: HOME, POSTAL, CONTRACT
zipJSONRequired within parent
zip (anyOf 1)stringAlternativeThe zip code.
Maximum length: 255
zip (anyOf 2)nullAlternativeThe zip code.
Maximum length: 255

Get personal information by id — 200 response body — data demographics ethnicity, gender

FieldTypePresenceDescription and constraints
$objectRootDemographic information for the worker, including gender and ethnicity.
ethnicityJSONRequired within parentEthnicity information for the worker.
ethnicity (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker
ethnicity (anyOf 2)nullAlternative
genderJSONRequired within parentGender information for the worker.
gender (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker
gender (anyOf 2)nullAlternative

Referenced models: Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker, Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker

Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker

FieldTypePresenceDescription and constraints
$objectRootEthnicity information for the worker.
idstringRequired within parentUnique identifier for the ethnicity.
Format: uuid
namestringRequired within parentThe name of the ethnicity.
Maximum length: 100
other_nameJSONRequired within parent
other_name (anyOf 1)stringAlternativeEthnicity added by user when "Other" option was chosen.
Maximum length: 100
other_name (anyOf 2)nullAlternativeEthnicity added by user when "Other" option was chosen.
Maximum length: 100

Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker

FieldTypePresenceDescription and constraints
$objectRootGender information for the worker.
idstringRequired within parentUnique identifier for the gender.
Format: uuid
namestringRequired within parentThe name of the gender.
Maximum length: 100
other_nameJSONRequired within parent
other_name (anyOf 1)stringAlternativeGender added by user when "Other" option was chosen.
Maximum length: 100
other_name (anyOf 2)nullAlternativeGender added by user when "Other" option was chosen.
Maximum length: 100

Get personal information by id — 200 response body — data emergency contacts item

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternativeThe email of the emergency contact.
Format: email
Maximum length: 255
email (anyOf 2)nullAlternativeThe email of the emergency contact.
Format: email
Maximum length: 255
idstringRequired within parentUnique identifier for the emergency contact.
Format: uuid
namestringRequired within parentThe name of the emergency contact.
Maximum length: 255
phonestringRequired within parentThe phone number of the emergency contact.
Maximum length: 30
preferred_languageJSONRequired within parentThe preferred language in which the emergency contact should be contacted.
preferred_language (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data emergency contacts item preferred language id, language
preferred_language (anyOf 2)nullAlternative
relationshipstringRequired within parentThe type of relationship between the owner and the emergency contact.
Maximum length: 100

Referenced models: Get personal information by id — 200 response body — data emergency contacts item preferred language id, language

Get personal information by id — 200 response body — data emergency contacts item preferred language id, language

FieldTypePresenceDescription and constraints
$objectRootThe preferred language in which the emergency contact should be contacted.
idJSONRequired within parent
id (anyOf 1)integerAlternativeUnique identifier for the preferred language.
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
languagestringRequired within parentThe name of the language.
Maximum length: 32

Get personal information by id — 200 response body — data kyc

FieldTypePresenceDescription and constraints
$objectRootKYC (Know Your Customer) verification information for the worker.
is_kyc_approvedbooleanRequired within parentBoolean to identify if the user is KYC verified
kyc_approval_dateJSONRequired within parent
kyc_approval_date (anyOf 1)stringAlternativeThe Date the user was KYC verified if applicable
kyc_approval_date (anyOf 2)nullAlternativeThe Date the user was KYC verified if applicable

Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentUnique 2-letters ISO country code.
Maximum length: 2
namestringRequired within parentThe name of the country.
Maximum length: 100

Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item

FieldTypePresenceDescription and constraints
$objectRoot
dial_codestringRequired within parentThe dial code (also known as country code).
Maximum length: 10
phone_numberstringRequired within parentThe phone number.
Maximum length: 30
typestringRequired within parentThe type of the phone number.
Known values: PERSONAL, WORK, HOME

Profiles — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Profiles — 200 response body — data

Referenced models: Profiles — 200 response body — data

Profiles — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalThe preferred currency for the profile.
first_namestringOptionalThe first name of the profile.
last_namestringOptionalThe last name of the profile.
phonestringOptionalThe contact number for the profile.
preferred_namestringOptionalThe preferred name of the profile.
timezonestringOptionalThe timezone of the profile.

Update personal information by external id — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
date_of_birthstringOptionalThe date of birth of the worker. Format: YYYY-MM-DD.
Format: date
legal_first_namestringOptionalThe legal first name of the worker.
Maximum length: 100
legal_last_namestringOptionalThe legal last name of the worker.
Maximum length: 100
personal_emailstringOptionalThe personal email of the worker.
Format: email
Maximum length: 255
preferred_namestring or nullOptionalThe preferred name of the worker.
Maximum length: 255

Update personal information — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
date_of_birthstringOptionalThe date of birth of the worker. Format: YYYY-MM-DD.
Format: date
legal_first_namestringOptionalThe legal first name of the worker.
Maximum length: 100
legal_last_namestringOptionalThe legal last name of the worker.
Maximum length: 100
personal_emailstringOptionalThe personal email of the worker.
Format: email
Maximum length: 255
phone_numbersarrayOptional
phone_numbers[]ModelEach itemExpand Update personal information — request body — body data phone numbers item
preferred_namestring or nullOptionalThe preferred name of the worker.
Maximum length: 255
work_emailstringOptionalThe personal email of the worker.
Format: email
Maximum length: 255

Referenced models: Update personal information — request body — body data phone numbers item

Update personal information — request body — body data phone numbers item

FieldTypePresenceDescription and constraints
$objectRoot
dial_codestringRequired within parentThe dial code (also known as country code).
Maximum length: 10
phone_numberstringRequired within parentThe phone number.
Maximum length: 30
typestringRequired within parentThe type of the phone number.
One of: PERSONAL, WORK, HOME

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.