POST
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
insurance-details
Create Employee Insurance Details
curl --request POST \
  --url https://api.example.com/organizations/{organization_id}/employees/{employee_id}/insurance-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "insuranceCategory": "A"
}
'
{
  "id": 123,
  "employeeId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "insuranceCategory": "A",
  "employmentCountry": "GB",
  "insuranceNumber": "<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
​
insuranceCategory
enum<string>
required

NIC Letter Categories

Available options:
A,
B,
C,
D,
E,
F,
H,
I,
J,
K,
L,
M,
N,
S,
V,
X,
Z
​
employmentCountry
string
default:GB
Allowed value: "GB"
​
insuranceNumber
string | null

EN: Health insurance number | DE: Versicherungsnummer

​
validFrom
string<date> | null

EN: Valid from date | DE: Gültig ab Datum

​
validTo
string<date> | null

EN: Valid to date | DE: Gültig bis Datum

Response

Successful Response

Response model for insurance details with metadata fields.

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

NIC Letter Categories

Available options:
A,
B,
C,
D,
E,
F,
H,
I,
J,
K,
L,
M,
N,
S,
V,
X,
Z
​
employmentCountry
string
default:GB
Allowed value: "GB"
​
insuranceNumber
string | null
​
validFrom
string<date> | null

EN: Valid from date | DE: Gültig ab Datum

​
validTo
string<date> | null

EN: Valid to date | DE: Gültig bis Datum