Skip to main content
PUT
Update Employee Insurance Details

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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