SWswissfintechinnovations
person

Get details of an insured person

Changed on

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

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

Path parameters

personIdstring required

Technical ID of insured person used in API calls.

Example:JohnDoe_1234

Technical person ID.

Response

Details of insured person.

birthDatestring date required

Birth date.

firstNamestring required

First name(s).

lastNamestring 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
personIdstring required

Technical ID of insured person used in API calls.

policyIdsPolicyId[] required

List of IDs of policies that insured person has with this pension fund.

sex'male' | 'female' required

Sex:

  • male: male
  • female: female
ssninteger required

Social security number.

marriageDatestring date

Date of marriage (or registration of partnership). Required if maritalStatus is married.

Example response

{
  "birthDate": "2018-04-13",
  "firstName": "John",
  "lastName": "Doe",
  "maritalStatus": "married",
  "personId": "JohnDoe_1234",
  "policyIds": [
    "Pol_56789-2024"
  ],
  "sex": "male",
  "ssn": 7561234567890,
  "address": {
    "countryCode": "CH",
    "postalCode": "3944",
    "street": "Brandstrasse 2",
    "town": "Unterbäch",
    "poBox": "PO Box 42"
  },
  "marriageDate": "2018-04-13"
}

Changes