Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Employee Personal Details

Update employee personal details

Updates the authenticated employee's personal details (date of birth, national ID, nationality, etc.).

This endpoint requires country-specific data. Query the Show form schema endpoint with personal_details as the form name to discover the schema for a given country.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage personal details (personal_detail:write)
put/v1/employee/personal-details

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the personal_details form schema

Request body

personal_detailsobject required

Employment personal details. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code and employment_basic_information as path parameters.

Example request

{
  "personal_details": {
    "description": "Personal details, such as name and date of birth.",
    "status": "completed"
  }
}

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}