Pohjola Claims Handling API (1.1.0)
Download OpenAPI specification:Download
The Pohjola Claims Handling API allows selected partners to query the available insurances of our common customers. The API provides information about the contents of the insurance policies, such as coverage and copayments. This allows partner organisations to better identify and treat our common customers, as well as simplify the payment and insurance reimbursement process for the customer
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 or their guardian’s consent. Therefore, add the consenter's SSN and the consent date to the API request.
We will continue to develop the API based on feedback, and will release updates regularly.
Pohjola Claims Handling 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.
You can apply for production access while creating a new application. After you create your application, we will contact you for further details. OP will approve partners whose business model complements OP's goals.
Request body consists of two required fields:
payload
contains the search parameters: SSN and a date (optional).consent
contains the consenter’s SSN and the date when the consent was given.
An SSN that has no insurance available will return an empty list. Use the SSN '250791-2189' in the sandbox environment to replicate this behaviour.
Example:
{
"payload": {
"ssn": "100408A206C",
"searchDate": "2021-07-31"
},
"consent": {
"consentor": "100408A206C",
"consentDate": "2021-08-31"
}
}
Fetch insurance policies
Fetches a list of valid insurance policies for a specified SSN. The returned insurance policies are valid at the given search date. If no search date is given, the current date is used instead.
Authorizations:
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" |
Request Body schema: application/json
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
- Payload
- CURL
{- "payload": {
- "ssn": "110783-2474",
- "searchDate": "2021-08-31"
}, - "consent": {
- "consentor": "110783-2474",
- "consentDate": "2021-08-31"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- 504
[- {
- "policyId": "14-07711-1",
- "specTypeName": "Toimeentulovakuutus"
}
]