Skip to main content

The employee-personal-record resource represents the confidential attributes of an employee, i.e. sensitive personal information about them which gives details of their background, identity proofs, and qualifications.

​
id
string
Minimum length: 1
​
type
string
Allowed value: "employee-personal-record"
​
url
string<uri>
​
employee
object

Read-only. Reference to an employee resource.

​
title
enum<string>
default:unknown
  • unknown: Not indicated. Equivalent to a technical null.
  • mister: Either married or unmarried man. French: 'Monsieur'.
  • miss: Unmarried woman. French: 'Mademoiselle'.
Available options:
unknown,
mister,
miss
​
legalGender
enum<string>
default:unknown

"Unknown" is equivalent to "unspecified" or "null".

"Diverse" may be legally acknowledged in some countries (e.g. Germany).

Available options:
unknown,
male,
female,
diverse
Examples:

"unknown"

​
birthDate
string<date> | null
​
insuranceNumber
object | null

Validation depends on selected format. Value for "other" format is not validated.

​
nationalitiesCountryCodes
enum<string>[]

Array of ISO 3166-1 alpha-3 country codes.

Maximum length: 1
​
bankAccount
object | null

Represents a bank account in any format, including IBAN, SWIFT, and region-specific routing details.

Examples:
{
  "format": "iban",
  "bankName": "BNP Paribas",
  "accountIdentifier": "FR7630006000011234567890189",
  "bankIdentifier": null
}
{
  "format": "other",
  "bankName": "JPMorgan Chase Bank",
  "accountNumber": "123456789",
  "routingNumber": "021000021"
}
​
phoneNumber
string<phone> | null

Phone number.

Examples:

"+3356565656"

​
email
string<email> | null

Personal email address of the employee.

Required string length: 3 - 255
​
createdAt
string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Examples:

"2023-01-23T12:45:23.1234Z"

​
lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Examples:

"2023-01-23T12:45:23.1234Z"

​
links
object