Skip to main content
POST
Create family member

Overview

Creates a family member for a specific employee. The request requires name, surname, type, gender, birthDate, incapacityLevel, and nationality. The public API currently supports child as the family member type. nationality must be an uppercase ISO 3166-1 alpha-2 country code, such as ES or PT. legalId is optional for family members under 18 years old. It is required when the family member is 18 years old or older.

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

The unique identifier of the company

employeeId
string<uuid>
required

The unique identifier of the employee

Body

application/json

Family member data to be created. legalId is required when the family member is 18 years old or older.

name
string
required

The family member's first name

surname
string
required

The family member's surname

type
enum<string>
required

The type of family member

Available options:
child
gender
enum<string>
required

The family member's gender

Available options:
male,
female
birthDate
string<date>
required

The family member's date of birth in ISO 8601 format (YYYY-MM-DD)

nationality
string
required

The family member's nationality as an ISO 3166-1 alpha-2 country code in uppercase

Pattern: ^[A-Z]{2}$
Example:

"ES"

incapacityLevel
enum<string>
required

The family member's incapacity level

Available options:
0%,
33%,
66%

The family member's legal identifier. Optional for family members under 18 years old and required for family members aged 18 or older.

Response

Family member successfully created

id
string<uuid>
required

The unique identifier of the family member

name
string
required

The family member's first name

surname
string
required

The family member's surname

type
enum<string>
required

The type of family member

Available options:
child
gender
enum<string>
required

The family member's gender

Available options:
male,
female
birthDate
string<date>
required

The family member's date of birth in ISO 8601 format (YYYY-MM-DD)

nationality
string
required

The family member's nationality as an ISO 3166-1 alpha-2 country code in uppercase

Pattern: ^[A-Z]{2}$
Example:

"ES"

incapacityLevel
enum<string>
required

The family member's incapacity level

Available options:
0%,
33%,
66%

The family member's legal identifier