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 string length: 1
​
type
string
Allowed value: "employee-personal-record"
​
url
string<uri>
​
employee
employee-reference · object

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
Example:

"unknown"

​
birthDate
null | string<date>
Pattern: ^\d{4}-\d{2}-\d{2}$
​
insuranceNumber
insurance-number · object

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 array length: 1

Three letters ISO 3166-1 alpha-3 country code.

Available options:
FRA,
ESP,
DEU,
CHE,
ITA,
GBR,
USA,
BEL,
CAN,
AFG,
ALA,
ALB,
DZA,
ASM,
AND,
AGO,
AIA,
ATA,
ATG,
ARG,
ARM,
ABW,
AUS,
AUT,
AZE,
BHS,
BHR,
BGD,
BRB,
BLR,
BLZ,
BEN,
BMU,
BTN,
BOL,
BIH,
BWA,
BVT,
BRA,
VGB,
IOT,
BRN,
BGR,
BFA,
BDI,
KHM,
CMR,
CPV,
CYM,
CAF,
TCD,
CHL,
CHN,
HKG,
MAC,
CXR,
CCK,
COL,
COM,
COG,
COD,
COK,
CRI,
CIV,
HRV,
CUB,
CYP,
CZE,
DNK,
DJI,
DMA,
DOM,
ECU,
EGY,
SLV,
GNQ,
ERI,
EST,
ETH,
FLK,
FRO,
FJI,
FIN,
GUF,
PYF,
ATF,
GAB,
GMB,
GEO,
GHA,
GIB,
GRC,
GRL,
GRD,
GLP,
GUM,
GTM,
GGY,
GIN,
GNB,
GUY,
HTI,
HMD,
VAT,
HND,
HUN,
ISL,
IND,
IDN,
IRN,
IRQ,
IRL,
IMN,
ISR,
JAM,
JPN,
JEY,
JOR,
KAZ,
KEN,
KIR,
PRK,
KOR,
KWT,
KGZ,
LAO,
LVA,
LBN,
LSO,
LBR,
LBY,
LIE,
LTU,
LUX,
MKD,
MDG,
MWI,
MYS,
MDV,
MLI,
MLT,
MHL,
MTQ,
MRT,
MUS,
MYT,
MEX,
FSM,
MDA,
MCO,
MNG,
MNE,
MSR,
MAR,
MOZ,
MMR,
NAM,
NRU,
NPL,
NLD,
NCL,
NZL,
NIC,
NER,
NGA,
NIU,
NFK,
MNP,
NOR,
OMN,
PAK,
PLW,
PSE,
PAN,
PNG,
PRY,
PER,
PHL,
PCN,
POL,
PRT,
PRI,
QAT,
REU,
ROU,
RUS,
RWA,
BLM,
SHN,
KNA,
LCA,
MAF,
SXM,
SPM,
VCT,
WSM,
SMR,
STP,
SAU,
SEN,
SRB,
SYC,
SLE,
SGP,
SVK,
SVN,
SLB,
SOM,
ZAF,
SGS,
SSD,
LKA,
SDN,
SUR,
SJM,
SWZ,
SWE,
SYR,
TWN,
TJK,
TZA,
THA,
TLS,
TGO,
TKL,
TON,
TTO,
TUN,
TUR,
TKM,
TCA,
TUV,
UGA,
UKR,
ARE,
UMI,
URY,
UZB,
VUT,
VEN,
VNM,
VIR,
WLF,
ESH,
YEM,
ZMB,
ZWE
Required string length: 3
​
bankAccount
object

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

Example:
{
  "format": "iban",
  "bankName": "BNP Paribas",
  "accountIdentifier": "FR7630006000011234567890189",
  "bankIdentifier": null
}
​
phoneNumber
string<phone> | null

Personal phone number of the employee.

Pattern: ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
Example:

"+3356565656"

​
email
null | string<email>

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.

Example:

"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.

Example:

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

​
links
object