---
title: "Get details of an insured person"
method: GET
path: "/insured-persons/{personId}"
tags: ["person"]
---

# Get details of an insured person

`GET /insured-persons/{personId}`

## Request

- Base URL: `https://pension.common-api.ch`
- URL: `https://pension.common-api.ch/insured-persons/{personId}`
- Auth: OAuth 2
  - Authorization code: `https://example.com/oauth/authorize`
  - Token URL: `https://example.com/oauth/token` scopes: `read:basic_pension_data`

Provides the details of the insured person, including name, address and additional data relevant in the Swiss social security system
(birth date, sex etc.)

## Path parameters

- `personId` string, required: Technical ID of insured person used in API calls.

## Response `200`

Details of insured person.

- InsuredPerson: Details of insured person.
  - `birthDate` string, date, required: Birth date.
  - `firstName` string, required: First name(s).
  - `lastName` string, required: Last name / family name.
  - `maritalStatus` 'single' | 'married' | 'divorced' | 'widowed' | 'registeredPartnership' | 'dissolvedRegisteredPartnership' | 'unknown', required: Marital status: * `single`: single * `married`: married * `divorced`: divorced * `widowed`: widowed * `registeredPartnership`: living in a registered partnership * `dissolvedRegisteredPartnership`: registered partnership has been dissolved * `unknown`: marital status is not known
  - `personId` string, required: Technical ID of insured person used in API calls.
  - `policyIds` PolicyId[], required: List of IDs of policies that insured person has with this pension fund.
  - `sex` 'male' | 'female', required: Sex: * `male`: male * `female`: female
  - `ssn` integer, required: Social security number.
  - `address` Address: Postal/residence address.
    - `countryCode` string, required: ISO country code.
    - `postalCode` string, required: Postal code.
    - `street` string, required: Street and house number.
    - `town` string, required: Town.
    - `poBox` string: PO box.
  - `marriageDate` string, date: Date of marriage (or registration of partnership). Required if `maritalStatus` is `married`.

## Other responses

- `401`: Access token is missing or invalid.
- `404`: Invalid ID / no authorization to access data.
- `500`: Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

## Changes

- **2025-04-17** `0c781dae9ac9`: 1 info
  - the response property `policyIds` became required for the status `200`
- **2025-02-07** `87835f5abbb4`: 1 info
  - added the non-success response with the status `500`
- **2025-01-16** `daf666928ad4`: 2 warning, 1 info
  - removed the optional property `disabilityDegree` from the response with the `200` status
  - removed the optional property `healthReservations` from the response with the `200` status
  - the endpoint scheme security `OAuth2` was added to the API

[Operation history](https://skmtc.dev/swissfintechinnovations/apis/pension-2/changes/insured-persons/:personId/get.md)

---

[API](https://skmtc.dev/swissfintechinnovations/apis/pension-2.md) - [All operations](https://skmtc.dev/swissfintechinnovations/apis/pension-2/llms.txt) - [OpenAPI document](https://skmtc.dev/swissfintechinnovations/apis/pension-2/revisions/ce7234453575?raw)