POST
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
insurance-details
Create Employee Insurance Details
curl --request POST \
  --url https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

url = "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details"

payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};

fetch('https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([

]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details"

payload := strings.NewReader("{}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/insurance-details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
{
  "employee_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "employment_country": "DE",
  "insurance_number": "<string>",
  "contribution_group": "<string>",
  "insurance_provider": "<string>",
  "alternate_collection_agency": "<string>",
  "private_insurance_health_monthly": "0",
  "private_insurance_care_monthly": "0",
  "care_insurance_children": 0,
  "u1_exempt": false,
  "u2_exempt": false,
  "uv_risk_tariff": [
    {
      "tariff_code": "<string>",
      "tariff_description": "<string>",
      "tariff_percentage": "0"
    }
  ],
  "pension_details": {
    "employment_country": "DE",
    "received_mining_adjustment_payments": false,
    "pension_start_date": "2023-12-25",
    "waiver_declaration_status": "default",
    "waiver_receipt_date": "2023-12-25",
    "waiver_validity_date": "2023-12-25"
  },
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
required
employee_id
required

Body

application/json
employment_country
string
default:DE
Allowed value: "DE"
insurance_number
string | null

German Versicherungsnummer (12 chars: region-birthdate-name-serial-check). Validates according to VKVV § 2. See: https://www.gesetze-im-internet.de/vkvv/__2.html

Example:

"12345678A123"

contribution_group
string | null

EN: Contribution group | DE: Beitragsgruppe

Required string length: 4
person_group
enum<integer> | null

EN: Person group | DE: Personengruppe

Available options:
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
116,
117,
118,
119,
120,
121,
122,
123,
124,
127,
190,
140,
141,
142,
143,
144,
149,
150,
203,
204,
207,
208,
209,
210,
301,
302,
303,
304,
305,
306,
307
insurance_provider
string | null

EN: Health insurance provider | DE: Krankenkasse

alternate_collection_agency
string | null

EN: Alternate collection agency | DE: Einzugsstelle

private_insurance_health_monthly
default:0

EN:Private health insurance monthly|DE:Private Krankenversicherung monatlich

Required range: x >= 0
private_insurance_care_monthly
default:0

EN: Private care insurance monthly | DE: Private Pflegeversicherung monatlich

Required range: x >= 0
care_insurance_children
integer | null
default:0

EN: Children for care insurance | DE: Kinder für Pflegeversicherung

Required range: 0 <= x <= 5
u1_exempt
boolean | null

EN: U1 exemption | DE: U1 Befreiung

u2_exempt
boolean | null

EN: U2 exemption | DE: U2 Befreiung

uv_risk_tariff
RiskTariff · object[] | null

EN: UV risk tariff details | DE: UV-Risikotarifdetails

pension_details
PensionDetails · object | null

EN: Pension details for Annex 04a validation | DE: Rentendetails für Anlage 04a-Prüfung

valid_from
string<date> | null

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

valid_to
string<date> | null

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

birth_date_context
string<date> | null

Response

Successful Response

Response model for insurance details with metadata fields.

employee_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
id
required
employment_country
string
default:DE
Allowed value: "DE"
insurance_number
string | null
contribution_group
string | null
person_group
enum<integer> | null

An IntEnum representing the key numbers ('Schlüsselzahlen') for person groups in German social insurance notifications (DEÜV).

Available options:
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
116,
117,
118,
119,
120,
121,
122,
123,
124,
127,
190,
140,
141,
142,
143,
144,
149,
150,
203,
204,
207,
208,
209,
210,
301,
302,
303,
304,
305,
306,
307
insurance_provider
string | null
alternate_collection_agency
string | null
private_insurance_health_monthly
string | null
default:0

EN:Private health insurance monthly|DE:Private Krankenversicherung monatlich

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
private_insurance_care_monthly
string | null
default:0

EN: Private care insurance monthly | DE: Private Pflegeversicherung monatlich

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
care_insurance_children
integer | null
default:0
u1_exempt
boolean | null
default:false
u2_exempt
boolean | null
default:false
uv_risk_tariff
RiskTariff · object[] | null
pension_details
PensionDetails · object | null

Pension details for German employees according to Annex 04a specification. Required for extended plausibility checks of employed pensioners.

valid_from
string<date> | null

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

valid_to
string<date> | null

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