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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addresses | JSON | Optional | |
addresses (anyOf 1) | array | Alternative | Array of addresses associated with the worker. |
addresses (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item |
addresses (anyOf 2) | null | Alternative | Array of addresses associated with the worker. |
addresses (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item |
date_of_birth | JSON | Optional | |
date_of_birth (anyOf 1) | string | Alternative | The date of birth of the worker. Format: date |
date_of_birth (anyOf 2) | null | Alternative | The date of birth of the worker. Format: date |
demographics | JSON | Optional | Demographic information for the worker, including gender and ethnicity. |
demographics (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender |
demographics (anyOf 2) | null | Alternative | |
emergency_contacts | array | Required within parent | Array of emergency contacts associated with the worker. |
emergency_contacts[] | Model | Each item | Expand Get personal information by id — 200 response body — data emergency contacts item |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external id of the worker. Maximum length: 100 |
external_id (anyOf 2) | null | Alternative | The external id of the worker. Maximum length: 100 |
id | string | Required within parent | Unique identifier for the worker. Format: uuid |
kyc | Model | Optional | Expand Get personal information by id — 200 response body — data kyc KYC (Know Your Customer) verification information for the worker. |
legal_first_name | JSON | Optional | |
legal_first_name (anyOf 1) | string | Alternative | The legal first name of the worker. Maximum length: 100 |
legal_first_name (anyOf 2) | null | Alternative | The legal first name of the worker. Maximum length: 100 |
legal_last_name | JSON | Optional | |
legal_last_name (anyOf 1) | string | Alternative | The legal last name of the worker. Maximum length: 100 |
legal_last_name (anyOf 2) | null | Alternative | The legal last name of the worker. Maximum length: 100 |
nationalities | JSON | Optional | |
nationalities (anyOf 1) | array | Alternative | Array of nationalities associated with the worker. |
nationalities (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item |
nationalities (anyOf 2) | null | Alternative | Array of nationalities associated with the worker. |
nationalities (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item |
ooo | JSON | Optional | Out of office information for the worker, including leave type and dates. |
ooo (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE |
ooo (anyOf 2) | null | Alternative | |
personal_email | JSON | Optional | |
personal_email (anyOf 1) | string | Alternative | The personal email of the worker. Format: email Maximum length: 255 |
personal_email (anyOf 2) | null | Alternative | The personal email of the worker. Format: email Maximum length: 255 |
phone_numbers | JSON | Optional | |
phone_numbers (anyOf 1) | array | Alternative | Array of phone numbers associated with the worker. |
phone_numbers (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item |
phone_numbers (anyOf 2) | null | Alternative | Array of phone numbers associated with the worker. |
phone_numbers (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item |
preferred_name | JSON | Optional | |
preferred_name (anyOf 1) | string | Alternative | The preferred name of the worker. Maximum length: 255 |
preferred_name (anyOf 2) | null | Alternative | The preferred name of the worker. Maximum length: 255 |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the worker. Format: email Maximum length: 255 |
work_email (anyOf 2) | null | Alternative | The work email of the worker. Format: email Maximum length: 255 |
worker_id | JSON | Required within parent | |
worker_id (anyOf 1) | integer | Alternative | The worker id. |
worker_id (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Out of office information for the worker, including leave type and dates. |
end_date | string | Required within parent | The worker out of office end date. Maximum length: 10 |
leave_type | string | Required within parent | The worker leave type. Known values: LONG_TERM_LEAVE, SHORT_TERM_LEAVE |
name | string | Required within parent | The worker out of office name. |
start_date | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. Maximum length: 255 |
city (anyOf 2) | null | Alternative | The city. Maximum length: 255 |
country | string | Required within parent | The country. Maximum length: 255 |
id | string | Required within parent | Unique identifier for the address. Format: uuid |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. Maximum length: 255 |
state (anyOf 2) | null | Alternative | The state. Maximum length: 255 |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. Maximum length: 255 |
street (anyOf 2) | null | Alternative | The street address. Maximum length: 255 |
type | string | Required within parent | The type of the address. Known values: HOME, POSTAL, CONTRACT |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. Maximum length: 255 |
zip (anyOf 2) | null | Alternative | The zip code. Maximum length: 255 |
Get personal information by id — 200 response body — data demographics ethnicity, gender
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Demographic information for the worker, including gender and ethnicity. |
ethnicity | JSON | Required within parent | Ethnicity information for the worker. |
ethnicity (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker |
ethnicity (anyOf 2) | null | Alternative | |
gender | JSON | Required within parent | Gender information for the worker. |
gender (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker |
gender (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Ethnicity information for the worker. |
id | string | Required within parent | Unique identifier for the ethnicity. Format: uuid |
name | string | Required within parent | The name of the ethnicity. Maximum length: 100 |
other_name | JSON | Required within parent | |
other_name (anyOf 1) | string | Alternative | Ethnicity added by user when "Other" option was chosen. Maximum length: 100 |
other_name (anyOf 2) | null | Alternative | Ethnicity 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Gender information for the worker. |
id | string | Required within parent | Unique identifier for the gender. Format: uuid |
name | string | Required within parent | The name of the gender. Maximum length: 100 |
other_name | JSON | Required within parent | |
other_name (anyOf 1) | string | Alternative | Gender added by user when "Other" option was chosen. Maximum length: 100 |
other_name (anyOf 2) | null | Alternative | Gender added by user when "Other" option was chosen. Maximum length: 100 |
Get personal information by id — 200 response body — data emergency contacts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | The email of the emergency contact. Format: email Maximum length: 255 |
email (anyOf 2) | null | Alternative | The email of the emergency contact. Format: email Maximum length: 255 |
id | string | Required within parent | Unique identifier for the emergency contact. Format: uuid |
name | string | Required within parent | The name of the emergency contact. Maximum length: 255 |
phone | string | Required within parent | The phone number of the emergency contact. Maximum length: 30 |
preferred_language | JSON | Required within parent | The preferred language in which the emergency contact should be contacted. |
preferred_language (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data emergency contacts item preferred language id, language |
preferred_language (anyOf 2) | null | Alternative | |
relationship | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The preferred language in which the emergency contact should be contacted. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier for the preferred language. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
language | string | Required within parent | The name of the language. Maximum length: 32 |
Get personal information by id — 200 response body — data kyc
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | KYC (Know Your Customer) verification information for the worker. |
is_kyc_approved | boolean | Required within parent | Boolean to identify if the user is KYC verified |
kyc_approval_date | JSON | Required within parent | |
kyc_approval_date (anyOf 1) | string | Alternative | The Date the user was KYC verified if applicable |
kyc_approval_date (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Unique 2-letters ISO country code. Maximum length: 2 |
name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dial_code | string | Required within parent | The dial code (also known as country code). Maximum length: 10 |
phone_number | string | Required within parent | The phone number. Maximum length: 30 |
type | string | Required within parent | The type of the phone number. Known values: PERSONAL, WORK, HOME |
Profiles — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Profiles — 200 response body — data |
Referenced models: Profiles — 200 response body — data
Profiles — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | The preferred currency for the profile. |
first_name | string | Optional | The first name of the profile. |
last_name | string | Optional | The last name of the profile. |
phone | string | Optional | The contact number for the profile. |
preferred_name | string | Optional | The preferred name of the profile. |
timezone | string | Optional | The timezone of the profile. |
Update personal information by external id — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_birth | string | Optional | The date of birth of the worker. Format: YYYY-MM-DD. Format: date |
legal_first_name | string | Optional | The legal first name of the worker. Maximum length: 100 |
legal_last_name | string | Optional | The legal last name of the worker. Maximum length: 100 |
personal_email | string | Optional | The personal email of the worker. Format: email Maximum length: 255 |
preferred_name | string or null | Optional | The preferred name of the worker. Maximum length: 255 |
Update personal information — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_birth | string | Optional | The date of birth of the worker. Format: YYYY-MM-DD. Format: date |
legal_first_name | string | Optional | The legal first name of the worker. Maximum length: 100 |
legal_last_name | string | Optional | The legal last name of the worker. Maximum length: 100 |
personal_email | string | Optional | The personal email of the worker. Format: email Maximum length: 255 |
phone_numbers | array | Optional | |
phone_numbers[] | Model | Each item | Expand Update personal information — request body — body data phone numbers item |
preferred_name | string or null | Optional | The preferred name of the worker. Maximum length: 255 |
work_email | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dial_code | string | Required within parent | The dial code (also known as country code). Maximum length: 10 |
phone_number | string | Required within parent | The phone number. Maximum length: 30 |
type | string | Required within parent | The type of the phone number. One of: PERSONAL, WORK, HOME |