v24

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-06-25129690.0 KB
person

Retrieve a list of insured persons that are accessible with the presented access token

Returns the list of person identifier(s) (personId) that the authenticated user can access via the API.

A valid OAuth2 access token, obtained through a user consent flow, is required. No specific scope is enforced for this endpoint, but the presence of a valid consent is mandatory.

The returned list acts as a mapping between the authenticated user (represented by the access token) and the insured persons that are technically accessible through this API. The service provider MUST ensure that only those person IDs are returned which are both:

  1. authorized for the user in the provider’s system, AND
  2. explicitly permitted for API access under the user’s current consent.

This prevents exposing additional person IDs that the user might be entitled to in the backend but which are not covered by the API consent agreement.

In most cases, only a single personId will be returned. Multiple person IDs MAY be returned if the user is authorized and has consented to access data for more than one insured person. If no accessible persons remain under the current consent, the endpoint returns an empty list.

get/insured-persons

Response

A list of insured persons.

personIdstring required

Technical ID of insured person used in API calls.

Example response

[
  {
    "personId": "JohnDoe_1234"
  }
]
All 12 operations