Qover is an API-first company (our team has even been known to dream about APIs in their sleep).
\nWe strongly believe APIs are changing the world of insurance and we want to be part of that change.
\nOur set of embedded insurance APIs can be integrated into any system, enabling you to offer insurance while maintaining the most seamless user experience.
\nTo see our APIs in action, book a live demo with our tech team or request your API key and someone from our product team will happily assist you.
\nOur API is ultimately determined by the product configuration – which we figure out together with each of our partners and corresponding insurers.
\nThis essentially means that we can configure the API endpoints to meet your needs.
\nThe main principle of our APIs, however, remains the same, regardless of the insurance product, country, insurer or distribution platform.
\nOur claims API enables you to fully embed the claims experience in your ecosystem, offering your customers the best UX. With it, your users can easily file a claim from your app or website, track its status and contact support
\nOur policy API enables you to manage all aspects of an insurance policy.
\nThanks to our API, you can add or remove risk items dynamically and in real time. In this documentation, we use the wording \"risk-item\" or \"subject\" to qualify an insured property.
\nThis API is particularly helpful for vehicle fleets, fintech cardholders, bike customers – we can configure our platform for anything you’d like to insure.
\nTo make a very Belgian analogy (hey, we stay true to our roots): our APIs are like fries and mayo – they work great on their own, but they’re even better together.
\nBoth our claims and policy APIs can be linked to allow automations such as claims eligibility checks.
\nQover's REST API incorporates a robust security mechanism to ensure the integrity and confidentiality of your data.
\nAuthentication is facilitated through API keys, which must be included in the header of each API request you make. Each API key serves as a unique identifier, functioning as a secure access token for authenticating and authorizing requests.
\nAs an ISO certified company, prioritizing the security of sensitive data is paramount for us. Therefore, we strongly emphasize the need to treat your API key with the utmost confidentiality, as it plays a critical role in ensuring secure and authorized access to our services.
\nKeep those keys under wraps—avoid sharing API keys with external parties or entities outside your organization. Furthermore, refrain from storing your API key in publicly accessible locations, such as public GitHub repositories, client-side code, documentation files, and similar areas.
\nRest assured, during the project's implementation phase, your API key will be securely shared with you.
\nQover will first grant access to our Sandbox environment. Following a thorough review and testing phase, we will provide you with the production API key through a secure protocol.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"A quick overview of our APIs","slug":"a-quick-overview-of-our-apis"},{"content":"Authorization","slug":"authorization"}],"owner":"2979342","collectionId":"b493dfe0-129a-4ed2-b5d2-454cddbbc7f0","publishedId":"2s8YevqApY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2F44DD"},"publishDate":"2022-11-17T08:22:17.000Z"},"item":[{"name":"Claims","item":[{"name":"Claim Schema","item":[{"name":"Retrieve validation schema by product and country","id":"a0c5b6b0-f643-4ce2-a9a7-8d1620802c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sbx.qover.io/claims/claim-schemas/FINTECHX/BE","description":"This endpoint is used to retrieve all validation schemas for specific products and countries.
The schema is used to validate the claim submission request.
It is generated on the fly based on claims configuration for specific claim submissions.\n\n
When the schema is retrieved, you can see what the claim submission request will look like.
The schema will contain the configuration id (together with _v which represents the version of configuration), which needs to be sent when submitting the claim.\n
The product and country are required.\n
You can use this endpoint to submit a claim to Qover.
\n\nIf the claim is created, Qover will send you the full details and claim ID so that you can display it on your app or website.
sendNotificationToClaimant within the setting you can decide whether or not the customer will receive a confirmation email once the claim is created. If you set the flag to true, your customer will receive an email with a summary of the claim and attached PDF. If you set the flag to false, no email will be sent – you can send the email yourself if you’d like.We’ll perform some checks on the payload you send to our API. Your payload must be valid towards the “validation schema” linked to the product/claim type.
If what you send us isn’t valid, you’ll receive a clear error message back explaining what’s wrong.
The list below is valid for any type of insurance product. Depending on the insurance product, specific details will be requested.
\n| Path of the key | Mandatory | Description | Format | Rule |
|---|---|---|---|---|
| configId | Mandatory | The id of the configuration that is used to validate the claim request | String | No rule |
| country | Mandatory | The country for which the claim is submitted | String | No rules |
| policyNumber | Not mandatory | The policy number for which the claim is submitted | String | No rules |
| type | Mandatory | Product agnostic type. Used for theft, accident, refund, tpl, ... | String | No rules |
| subType | Not mandatory | Product agnostic sub type. Used for theft, accident, refund, tpl, ... | String | No rules |
| submissionDate | Mandatory | DateTime on which the user submitted his claim | string | Date in the ISO 8601 Date and time in UTC (ex: 2020-12-04T09:29:40Z) |
| consentDate | Not mandatory | DateTime on which the user gave his consent to process his claim regarding GDRP/Medical consent/... | string | Date in the ISO 8601 Date and time in UTC (ex: 2020-12-04T09:29:40Z) |
| claimant.entityType | Mandatory | Type of entity that is submitting claim | string | One of: ENTITY_TYPE_UNSPECIFIED, ENTITY_TYPE_PERSON, ENTITY_TYPE_COMPANY |
| claimant.firstName | Mandatory if claimant.entityType = ENTITY_TYPE_PERSON | First name of claimant | string | No rules |
| claimant.lastName | Mandatory if claimant.entityType = ENTITY_TYPE_PERSON | Last name of claimant | string | No rules |
| claimant.companyName | Mandatory if claimant.entityType = ENTITY_TYPE_COMPANY | Name of company | string | No rules |
| claimant.email | Mandatory | Email of claimant | string | No rules |
| claimant.birthdate | Mandatory if claimant.entityType = ENTITY_TYPE_PERSON | Birth date of claimant | string | Required for person |
| claimant.vatIn | Mandatory if claimant.entityType = ENTITY_TYPE_COMPANY | VatIn of claimant | string | Required for company |
| claimant.phone | Not mandatory | Phone number of claimant | string | No rules |
| claimant.address.country | Mandatory | Country of claimant | string | No rules |
| claimant.address.locality | Not mandatory | Locality of claimant | string | No rules |
| claimant.address.zip | Not mandatory | Zip number of claimant | string | No rules |
| claimant.address.city | Not mandatory | City of claimant | string | No rules |
| claimant.address.street | Not mandatory | Street of claimant | string | No rules |
| claimant.address.number | Not mandatory | Number of claimant | string | No rules |
| claimant.address.box | Not mandatory | Box of claimant | string | No rules |
| attachments.type | Not mandatory | Type of attachment | string | If attachments is sent this field is mandatory |
| attachments.assetId | Not mandatory | Id of asset | string | One of assetId or URI |
| attachments.uri | Not mandatory | URI of attachment | string | One of assetId or URI |
| attachments.description | Not mandatory | Description of attachment | string | No rules |
| incidentDetails | Not mandatory | Specific to the claim config, schema will be defined by the used claim config id | Object | No rules |
| incidentDate | Mandatory | Date on on which the user declared incident happened, used to link right version of insurance policy | date | Date in the ISO 8601 Date |
| incidentTime | Optional | Time of the incident | Time | In local timezone (timezone of the incident) |
| metadata | Not mandatory | Metadata | Object | No rules |
| language | Mandatory | Language | string | It must be an accepted language for the given product |
This endpoint is used to retrieve a generated claim report for a specific claim.\n
\nThe user gets redirected to a URL to download the PDF.\n
\n\nThis endpoint is used to retrieve a specific claim.
\n\nYou can retrieve information for a specific claim by including its claim ID in the request url.
","auth":{"type":"apikey","apikey":{"key":"This endpoint is used to retrieve the historical status of a claim
\n\nYou can retrieve information for a specific claim by including its claim ID in the request url.
","auth":{"type":"apikey","apikey":{"key":"In this section, we’ll explain how you can:
\nPurchase protection is a powerful tool for FinTechs to attract and retain users, as well increase transactions. Read more about our purchase protection product here.
\n","_postman_id":"bd38f045-1ec9-475e-8272-78b040da4d58","auth":{"type":"apikey","apikey":{"key":"Our modular approach to travel insurance ensures that your customers are covered when they’re far from home.
\n","_postman_id":"2ac8103e-44e4-444d-9b3b-f9c273ed4143","auth":{"type":"apikey","apikey":{"key":"If you created a risk-item (a risk-item is the insured subject, it can be basically anything that can be insured, see policies documentation for more information) via our policy API you can specify the policyNumber that is returned by our policy API in the create claim Payload.
Based on the policyNumber, our claim API will be able to:
\nIf you already created a risk-item (risk-item = the subject which is insured, see more details in the policies API) via our polices API. You can add the \"policyNumber\": \"xxxx\" field in the payload of the claim.
Based on that policyNumber, Qover system can:
\nIf you provide both claimant data and policyNumber, the claimant data will take precedence over the risk item data. In all cases, the risk item data will not be updated
\n","_postman_id":"28ef4ecd-5ade-4c69-abd5-032d3287efee","auth":{"type":"apikey","apikey":{"key":"In this section, we give some indicative examples of claims payload for some of our insurance products.
\nPlease note that depending on the product and country, we may have to adapt the required information and documents.
\nWe can easily adjust our API in real time via our Claims API configuration tool – which does not require any development or deployment.
\n\n","_postman_id":"4b29a0d6-c216-49e8-b88f-ea2e07a0dda0","auth":{"type":"apikey","apikey":{"key":"We can configure various Webhook in our system.
\nIn practice, when the status of a claim is changed in our system we can call any end point and send the current status of the claim with high level informations about the claim.
\nTypical use case is to show an \"in app\" notification when the status of the claim has changed.
\nOur API supports various authenication mechanism
\nPlease see below an example of webhook payload
\n{\n \"id\":\"ANONYMOUS_ID\",\n \"occurredOn\":\"2024-01-11T20:04:49.925Z\",\n \"type\":\"ANONYMOUS_TYPE\",\n \"data\":{\n \"id\":\"ANONYMOUS_DATA_ID\",\n \"version\":6,\n \"_links\":{\n \"self\":{\n \"href\":\"ANONYMOUS_LINK\"\n }\n },\n \"claimNumber\":\"ANONYMOUS_CLAIM_NUMBER\",\n \"reference\":null,\n \"productConfiguration\":{\n \"id\":\"ANONYMOUS_PRODUCT_ID\",\n \"version\":19,\n \"product\":\"ANONYMOUS_PRODUCT\"\n },\n \"country\":\"ANONYMOUS_COUNTRY\",\n \"partner\":{\n \"id\":\"ANONYMOUS_PARTNER_ID\",\n \"name\":\"ANONYMOUS_PARTNER\"\n },\n \"customerId\":\"ANONYMOUS_CUSTOMER_ID\",\n \"status\":{\n \"code\":\"ANONYMOUS_STATUS_CODE\",\n \"category\":\"ANONYMOUS_STATUS_CATEGORY\",\n \"name\":\"ANONYMOUS_STATUS_NAME\"\n },\n \"policyNumber\":\"ANONYMOUS_POLICY_NUMBER\",\n \"policy\":{\n \"type\":\"ANONYMOUS_POLICY_TYPE\",\n \"id\":\"ANONYMOUS_POLICY_ID\",\n \"number\":\"ANONYMOUS_POLICY_NUMBER\",\n \"version\":1,\n \"product\":\"ANONYMOUS_PRODUCT\",\n \"country\":\"ANONYMOUS_COUNTRY\",\n \"partner\":{\n \"id\":\"ANONYMOUS_PARTNER_ID\",\n \"name\":\"ANONYMOUS_PARTNER\"\n },\n \"effective\":true\n },\n \"claimant\":{\n \"entityType\":\"ANONYMOUS_ENTITY_TYPE\",\n \"customer\":{\n \"id\":\"ANONYMOUS_CUSTOMER_ID\"\n },\n \"email\":\"ANONYMOUS_EMAIL\",\n \"firstName\":\"ANONYMOUS_FIRST_NAME\",\n \"lastName\":\"ANONYMOUS_LAST_NAME\",\n \"birthdate\":\"ANONYMOUS_BIRTHDATE\",\n \"phone\":\"ANONYMOUS_PHONE\",\n \"address\":{\n \"country\":\"ANONYMOUS_COUNTRY\",\n \"zip\":\"ANONYMOUS_ZIP\",\n \"city\":\"ANONYMOUS_CITY\",\n \"street\":\"ANONYMOUS_STREET\",\n \"number\":\"ANONYMOUS_NUMBER\"\n }\n },\n \"type\":\"ANONYMOUS_TYPE\",\n \"subType\":\"ANONYMOUS_SUBTYPE\",\n \"submittedAt\":\"2023-12-27T13:41:57.182Z\"\n }\n}\n\n\nThis endpoint is used to create assets in Qover's system. You can provide the following information:
\nThe Qover API will return:
\nPlease note that the link to the bucket will be valid for 15 minutes only.
\n","auth":{"type":"apikey","apikey":{"key":"This endpoint is used to upload your file in our system. The URL will have been provided to you upon creation of the asset.
\n","auth":{"type":"apikey","apikey":{"key":"See above for the description of the endpoint.
","auth":{"type":"apikey","apikey":{"key":"Uploading files as supporting evidence is a key part of any claims process.
\nWe have 2 ways of handling files:
\n* Either you provide us with the URL of the file when submitting a claim\n* Or you can use our Document Asset Management system
\nWhen submitting a claim with the Document Asset Management system, you will need to create an asset per file, and provide us with its id. Our API will return the asset id, url of the file, and the url where you will need to upload the file.
\n\n","_postman_id":"1950f735-ba22-48d7-ab9b-81bd56f89281","auth":{"type":"apikey","apikey":{"key":"Insurance is about being there for your customers when they need it most. That means being able to process and manage claims quickly and efficiently.
\nThat’s why, at Qover, we built an API that enables our partners to offer the best claims experience to their customers.
\nClaim’s API can be integrated into any system, allowing users to create and track claims without ever leaving your UX – which all links back to you creating a seamless customer experience.
\nWith our claims API:
\nYour access to certain functionalities of the claims API might be restricted due to some reasons such as your status, the perimeter of the risk carrier's claims delegation or the data processed in the claims handling process of your customers' claims. However, we will be sure to accompany you the best way possible to satisfy your needs.
\nIf you’ve got questions or are interested in using our API, our team is here to help with everything from making sure you’ve got the right licence to assisting with implementation.
\n\nThere are multiple way to configure the necessary questions for your customers:
\nGET First Notification Of Loss endpoint to get the list of questions that customers need to answer.GET First Notification Of Loss endpoint to get the list of questions that customers need to answer.In all cases, one of our project managers will also support you during implementation.
\nHow you collect the information is totally up to you. If you already have customer data in your system such as names, emails, etc., then it doesn’t need to be included in the claim form.
\nWhen a customer submits a claim, we ask for the claimant’s personal details regardless of the type of insurance product.
\nThese personal details will need to be provided within the “claimant” section of the POST claim endpoint.
If you provide both claimant data and policyNumber, the claimant data will take precedence over the risk item data. The risk item data will not be updated
\nQover accepts the below information about the claimant:
\n\"claimant\": {\n \"email\": \"john.doe@qover.com\",\n \"phone\": \"+3211239011\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"birthdate\": \"1989-04-05\",\n \"address\": {\n \"country\": \"BE\",\n \"city\": \"Brussels\",\n \"zip\": \"1000\",\n \"street\": \"Rue du Commerce\",\n \"number\": \"31\",\n \"box\": \"a\"\n },\n \"entityType\": \"ENTITY_TYPE_PERSON\",\n \"iban\":\"FR01234567893\"\n}\n\nFor most insurance products, we require customers to provide documents and other evidence with their claim.
\nThen, you’ll need to send us the URL of the file the customer uploaded in the claim form. Once we receive the file, we’ll download it in Qover’s claims system.
\n","_postman_id":"86c7f59b-60ff-44b4-95fa-30f0ce99a29f","auth":{"type":"apikey","apikey":{"key":"