POST
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
personal-data
Create Employee Personal Data
curl --request POST \
  --url https://api.example.com/organizations/{organization_id}/employees/{employee_id}/personal-data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeName": "<string>"
}
'
{
  "id": 123,
  "employeeId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "employeeName": "<string>",
  "employmentCountry": "GB",
  "gender": "M",
  "maritalStatus": "Single",
  "nationality": "<string>",
  "residenceAddress": "<string>",
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
required
​
employee_id
required

Body

application/json

Schema for personal data of UK employee. Change tracked personal data.

​
employeeName
string
required

Employee name

Examples:

"Hans Mueller"

"John Smith"

​
employmentCountry
string
default:GB
Allowed value: "GB"
​
gender
enum<string> | null

Gender

Available options:
M,
F
​
maritalStatus
enum<string> | null

Marital status

Available options:
Single,
Married
​
nationality
string | null

Nationality

Example:

"German"

​
residenceAddress
string | null

Residence address

Example:

"Taigschuster 11, 82380 Peissenberg, Germany"

​
validFrom
string<date> | null
​
validTo
string<date> | null

Response

Successful Response

Response model for personal data with metadata fields.

​
id
required
​
employeeId
string
required
​
createdAt
string<date-time> | null
required
​
updatedAt
string<date-time> | null
required
​
employeeName
string
required

Employee name

​
employmentCountry
string
default:GB
Allowed value: "GB"
​
gender
enum<string> | null

Gender

Available options:
M,
F
​
maritalStatus
enum<string> | null

Marital status

Available options:
Single,
Married
​
nationality
string | null

Nationality

​
residenceAddress
string | null

Residence address

​
validFrom
string<date> | null
​
validTo
string<date> | null