API docs by Redocly

Pohjola Insurance Policy Inquiry API (1.0.2)

Download OpenAPI specification:Download

Support: api@op.fi Terms of Service

The Pohjola Insurance Policy Inquiry API allows selected partners to query the insurance policies held by our corporate customers. This allows partner organizations to better identify and treat our customers.

The query is performed with customer SSN. You can limit the search results by giving a search date. To check the customer's information with the API, you need the customer’s consent. Therefore, add the consenter's SSN and the consent date to the API request.

This API is for selected healthcare partner organizations only.

Release notes

1.0.2 (03/2025)

  • Insurance coverage term updates

1.0.1 (03/2025)

  • Insurance coverage term updates
  • Updated documentation

Sandbox

Pohjola Insurance Policy Inquiry API is available in the sandbox for testing and integration free of charge. To use the API in the sandbox, create a new developer application and use the freshly created API key in your code.

Test data in sandbox environment

The sandbox environment includes the following insurances:

Test data for the sandbox environment
Insured SSN Policy Type Period Start Period End Notes
050469X901A Accident insurance 2023-06-01 2025-12-31 Has both Accident Insurance and Health Insurance
Health insurance 2021-01-01 Currently valid Has both Accident Insurance and Health Insurance
010106A983P Health insurance 2024-06-10 2025-03-07 The insurance period ends 2025-03-07
070601A937U Health insurance 2025-03-01 2026-03-01 The insurance period starts 2025-03-01
190285-934X Health insurance 2025-03-17 2027-03-16 The insurance period ends 2027-03-16
090482-936C Accident insurance 2025-03-20 Currently valid Has both Accident Insurance and Health Insurance
Health insurance 2025-03-20 Currently valid Has both Accident Insurance and Health Insurance
241289-955X Accident insurance 2025-06-06 2026-06-05 Has both Accident Insurance and Health Insurance. Accident Insurance starting from 2025-06-06
Health insurance 2025-03-01 2026-02-28 Has both Accident Insurance and Health Insurance. Health Insurance starting from 2025-03-01
140875-960T Accident insurance 2025-01-01 2026-07-14 The insurance period started 2025-01-01. Starting from 2025-07-15 additional insurance coverages are added to the insurance. Additional coverages starting from 2025-07-15 are "Treatment Of Dental Injuries" and "Medication and Wound Dressing"
060799-911E Accident insurance 2025-03-01 2025-08-05 Has both Accident Insurance and Health Insurance. Accident Insurance starting from 2025-03-01. Later insurance owner has requested to end the Accident Insurance and therefore insurance period ends 2025-08-05
Health insurance 2025-03-01 2025-11-01 Has both Accident Insurance and Health Insurance. Health Insurance starting from 2025-03-01

Request headers

Request headers may contain following fields.

  • x-request-id required header contains unique id for request. Value is of format "UUIDv4".
  • x-session-id required header contains unique id for session. Value is of format "UUIDv4".
  • Accept required header. Value must be "application/json".
  • Content-Type required header. Value must be "application/json".
  • Accept-Language optional header contains localization information. This selects language of the response terms. Possible values are:
    • fi for Finnish (default)
    • en for English
    • sv for Swedish
Example: 
x-request-id: 19f8a1c3-dcb4-4a46-9896-079b27687734
x-session-id: d2d6a688-74e4-11ef-b7c7-005056813af6
Accept: application/json
Content-Type: application/json
Accept-Language: en

Request body structure

Request body consists of two required fields:

  • payload contains the search parameters: SSN and a search date (optional).
  • consent contains the consenter’s SSN and the date when the consent was given.

The api will provide a boolean response based on if the SSN has active insurances at the given search date. If no search date is given current date will be used for query.

Example: 
{
  "payload": {
    "ssn": "050469X901A",
    "searchDate": "2024-12-09"
  },
  "consent": {
    "consentor": "050469X901A",
    "consentDate": "2024-11-27"
  }
}

Example response

Example of successful query response: 
{
  "data": {
    "insurances": [
      {
        "policyId": "78-30000-00263-6",
        "productName": "Pohjola Sairausvakuutus",
        "productId": "SicknessCompany_OP",
        "insurancePeriodStart": "2024-06-17",
        "insurancePeriodEnd": "2026-01-01",
        "includesMaxCompensationPerIncident": true,
        "includesDeductible": true,
        "medicalTreatmentDeductibleType": "PerTerm",
        "sportExtensions": {
          "competitiveSport": true,
          "highRiskSport": true
        },
        "coverages": [
          {
            "id": "AHLAssistiveDevicesAndOrthopedicBraces_OP",
            "name": "Apuvälineet ja ortopediset tuet"
          },
          {
            "id": "AHLMedicalExpAndExam_OP",
            "name": "Lääkärin hoidot ja tutkimukset",
            "terms": [
              {
                "id": "AHLMedicalExpAndExam_OPGeneralPractitioner_OP",
                "name": "Yleislääkärin kulut",
                "includesMaxVisits": false
              },
              {
                "id": "AHLMedicalExpAndExam_OPExamAndTreatment_OP",
                "name": "Tutkimukset ja hoitotoimenpiteet",
                "includesMaxVisits": false
              },
              {
                "id": "AHLMedicalExpAndExam_OPSplMedicalPractitioner_OP",
                "name": "Erikoislääkärin kulut",
                "includesMaxVisits": false
              }
            ]
          },
          {
            "id": "AHLMusculoskeletal_OP",
            "name": "Tuki- ja liikuntaelinten hyvinvointi",
            "terms": [
              {
                "id": "AHLMusculoskeletal_OPNapraChiroOsteo_OP",
                "name": "Kiropraktikko-, naprapaatti- ja osteopaattikäynnit",
                "includesMaxVisits": false
              },
              {
                "id": "AHLMusculoskeletal_OPPhysioAndPodiat_OP",
                "name": "Fysioterapia ja jalkaterapia",
                "includesMaxVisits": false
              }
            ]
          },
          {
            "id": "AHLPsychological_OP",
            "name": "Mielen hyvinvointi"
          },
          {
            "id": "AHLSurgeries_OP",
            "name": "Leikkaukset",
            "terms": [
              {
                "id": "AHLSurgeries_OPSurgeryExpensesPublic_OP",
                "name": "Leikkaukset julkisessa terveydenhuollossa",
                "includesMaxVisits": false
              },
              {
                "id": "AHLSurgeries_OPSurgeryExpensesPrivate_OP",
                "name": "Leikkaukset yksityisissä hoitolaitoksissa",
                "includesMaxVisits": false
              }
            ]
          },
          {
            "id": "AHLTreatmentOfDentalInjuries_OP",
            "name": "Hammasturva",
            "terms": [
              {
                "id": "AHLTreatmentOfDentalInjuries_OPTreatDenInjury_OP",
                "name": "Hammastapaturmien hoito",
                "includesMaxVisits": false
              }
            ]
          }
        ]
      }
    ]
  }
}

Fetch insurance information for accident and illness insurances

Returns information about the insurances and coverage for the insured. Insurance and coverage information is checked for the search date if given, otherwise current date is used.

Authorizations:
APIKey
header Parameters
x-request-id
required
string
Value: "UUIDv4"
x-session-id
required
string
Value: "UUIDv4"
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Accept-Language
string
Default: fi
Enum: "fi" "en" "sv"
Request Body schema: application/json
required
required
object (Consent)

Consent contains the consenter SSN and the date when the consent was given.

required
object (Payload)

Payload contains the search parameters: SSN and a date (optional).

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "consent": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}