Summary: New person roles for the spouse and the children of a subsidy application, and new person fields (preview)

Persons

The new roles, fields and filter below are a preview API and may change without a deprecation period.

New Field: roles on Persons

You can now create the spouse and the children of a subsidy application as persons, with the new roles field on POST /persons. The roles decide which fields are required; see POST /persons for details.

Persons without roles work like before.

New Fields: gender, birth_name and social_security_number

• gender: you can now set the gender when you create a person. If not set, it is unknown.
• birth_name (optional): the person's last name at birth, if it is different from lastname.
• social_security_number (optional): the person's German social security number, or the subsidy number (Zulagenummer).

All three fields are returned by POST /persons, GET /persons/{person_id} and GET /persons, together with roles.

New Query Parameter: role on GET /persons

Use GET /persons?role=subsidy_application.spouse to list only the persons with this role.

Changed Response: registered_address is optional

Persons with only subsidy application roles can be created without a registered address. For these persons, registered_address is not returned.