urlscan.io logo urlscan.io
SecurityTrails logo

claims-api.qover.com Open in urlscan Pro
52.44.190.221  Public Scan

Back to summary
URL: https://claims-api.qover.com/
Submission: On August 08 via automatic, source certstream-suspicious — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Public


Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL



QOVER CLAIMS API

 * Introduction


Claim Schema

Claims Management

Claims Creation - Examples

Document Asset Management
Qover Claims API


INTRODUCTION

Insurance is about being there for your customers when they need it most.

And that means being able to process and manage claims quickly and efficiently.

That’s why, at Qover, we built an API that enables our partners to offer the
best claims experience to their customers.

Qover’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.

With our claims API:

   
 * Customers can create an insurance claim in your UX.
   
 * Customers can see the status of their claim in real time.
   
 * You can see a full list of claims made by any given customer.
   
 * You can see the status of any claim.
   

Check out our documentation below to learn more.

If 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.


A QUICK OVERVIEW OF OUR API

   
 * Qover’s claims API is JSON REST API compatible with the JSON:API
   specifications
   
 * When performing any API request, you must specify application/json in the
   content-type header
   
 * Authentication to Qover’s API is done via a public and private API key. It
   must be provided in all requests you make.
   
 * Your ‘personal’ API keys will be shared with you during the implementation
   phase by the appointed project manager.
   


HOW DOES IT WORK

THE PROCESS

   
 * We configure your access in our Qover back office.
   
 * We send you your sandbox API key
   
 * You start toying with our API and fully integrate it.
   
 * Your customers can file insurance claims within your ecosystem (app, website,
   etc.) for a top-notch claims experience.
   

SUBMITTING A CLAIM

There are multiple way to configure the necessary questions for your customers:

   
 * If the insurance product is a standard Qover product, you can check the GET
   First Notification Of Loss endpoint to get the list of questions that
   customers need to answer.
   
 * If it’s a custom insurance product, you can check the GET First Notification
   Of Loss endpoint to get the list of questions that customers need to answer.
   One of our project managers will also support you during implementation.
   

How 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.

CLAIMANT DETAILS

When a customer submits a claim, we ask for the claimant’s personal details
regardless of the type of insurance product.

These personal details will need to be provided within the “claimant” section of
the POST claim endpoint.

If you already have their personal data in your system, then you don’t need to
ask them in the claim form – less questions means a faster claims process for
your users.

Qover accepts the below information about the claimant:

View More

"claimant": {
    "email": "john.doe@qover.com",
    "phone": "+3211239011",
    "firstName": "John",
    "lastName": "Doe",
    "birthdate": "1989-04-05",
    "address": {
        "country": "BE",
        "city": "Brussels",
        "zip": "1000",
        "street": "Rue du Commerce",
        "number": "31",
        "box": "a"
    },
    "entityType": "ENTITY_TYPE_PERSON",
    "iban":"FR01234567893"
}







UPLOADING FILES

For most insurance products, we require customers to provide documents and other
evidence with their claim.

Then, 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.



Claim Schema


GET

Retrieve validation schema by product and country

https://api.sbx.qover.io/claims/claim-schemas/FINTECHX/BE?apikey={{yourSecretKey}}


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.


USAGE

   

 * 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.

   

 * The product and country are required.

   

PARAMS

apikey
{{yourSecretKey}}


Example Request
Purchase Protection

curl --location -g --request GET 'https://api.sbx.qover.io/claims/claim-schemas/FINTECHX/BE?apikey={{yourSecretKey}}'

Example Response
200 OK
Body
Header(25)
View More

{
  "items": [
    {
      "schema": {
        "$id": "f78b0c5f-4672-44d7-a4c3-6ee36df50345_v1",
        "additionalProperties": false,
        "required": [
          "configId",
          "type",
          "claimant",
          "language"

Claims Management

In this section, we’ll explain how you can:

   
 * Submit a claim
   
 * Retrieve all claims
   
 * Retrieve details of a specific claim
   
 * Retrieve a PDF summary of a claim
   


POST

Create claim

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}


DESCRIPTION

You can use this endpoint to submit a claim to Qover.

If 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.


USAGE

   
 * Please check the mandatory fields required below
   
 * Depending on the insurance product and coverage, you’ll have to provide
   different information.
   
 * Thanks to the 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.
   


VALIDATION

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.


PAYLOAD DESCRIPTION & RULES

The list below is valid for any type of insurance product. Depending on the
insurance product, specific details will be requested.

View More

Path of the keyMandatoryDescriptionFormatRuleconfigIdMandatoryThe id of the
configuration that is used to validate the claim requestStringNo
rulecountryMandatoryThe country for which the claim is submittedStringNo
rulespolicyNumberNot mandatoryThe policy number for which the claim is
submittedStringNo rulestypeMandatoryProduct agnostic type. Used for theft,
accident, refund, tpl, ...StringNo rulessubTypeNot mandatoryProduct agnostic sub
type. Used for theft, accident, refund, tpl, ...StringNo
rulessubmissionDateMandatoryDateTime on which the user submitted his
claimstringDate in the ISO 8601 Date and time in UTC (ex:
2020-12-04T09:29:40Z)consentDateNot mandatoryDateTime on which the user gave his
consent to process his claim regarding GDRP/Medical consent/...stringDate in the
ISO 8601 Date and time in UTC (ex:
2020-12-04T09:29:40Z)claimant.entityTypeMandatoryType of entity that is
submitting claimstringOne of: ENTITY_TYPE_UNSPECIFIED, ENTITY_TYPE_PERSON,
ENTITY_TYPE_COMPANYclaimant.firstNameMandatory if claimant.entityType =
ENTITY_TYPE_PERSONFirst name of claimantstringNo rulesclaimant.lastNameMandatory
if claimant.entityType = ENTITY_TYPE_PERSONLast name of claimantstringNo
rulesclaimant.companyNameMandatory if claimant.entityType =
ENTITY_TYPE_COMPANYName of companystringNo rulesclaimant.emailMandatoryEmail of
claimantstringNo rulesclaimant.birthdateMandatory if claimant.entityType =
ENTITY_TYPE_PERSONBirth date of claimantstringRequired for
personclaimant.vatInMandatory if claimant.entityType = ENTITY_TYPE_COMPANYVatIn
of claimantstringRequired for companyclaimant.phoneNot mandatoryPhone number of
claimantstringNo rulesclaimant.address.countryMandatoryCountry of
claimantstringNo rulesclaimant.address.localityNot mandatoryLocality of
claimantstringNo rulesclaimant.address.zipNot mandatoryZip number of
claimantstringNo rulesclaimant.address.cityNot mandatoryCity of claimantstringNo
rulesclaimant.address.streetNot mandatoryStreet of claimantstringNo
rulesclaimant.address.numberNot mandatoryNumber of claimantstringNo
rulesclaimant.address.boxNot mandatoryBox of claimantstringNo
rulesattachments.typeNot mandatoryType of attachmentstringIf attachments is sent
this field is mandatoryattachments.assetIdNot mandatoryId of assetstringOne of
assetId or URIattachments.uriNot mandatoryURI of attachmentstringOne of assetId
or URIattachments.descriptionNot mandatoryDescription of attachmentstringNo
rulesincidentDetailsNot mandatorySpecific to the claim config, schema will be
defined by the used claim config idObjectNo rulesincidentDateMandatoryDate on on
which the user declared incident happened, used to link right version of
insurance policydateDate in the ISO 8601 DateincidentTimeOptionalTime of the
incidentTimeIn local timezone (timezone of the incident)metadataNot
mandatoryMetadataObjectNo ruleslanguageMandatoryLanguagestringIt must be an
accepted language for the given productsettings.sendNotificationsToClaimantNot
mandatorySignify do we want to send email to claimantbooleanIf not sent default
is false

PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
   "configId":"80cfcf4d-0acc-4757-ab57-e533fcc25491",
   "claimant":{
    "email":"Jacky.Integrata@qover.com",
      "phone":"+32496441122",
      "firstName":"Jacky",
      "lastName":"Integreta",
      "birthdate":"1992-04-21",
      "address":{
         "country":"FR",
         "city":"Paris",



Example Request
Create claim
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
   "configId":"80cfcf4d-0acc-4757-ab57-e533fcc25491",
   "claimant":{
    "email":"Jacky.Integrata@qover.com",
      "phone":"+32496441122",
      "firstName":"Jacky",
      "lastName":"Integreta",
      "birthdate":"1992-04-21",
      "address":{
         "country":"FR",

GET

Claim Report

https://api.sbx.qover.io/claims/v1/claims/{{claimID}}.pdf?apikey={{yourSecretKey}}


DESCRIPTION

This endpoint is used to retrieve a generated claim report for a specific claim.

The user gets redirected to a URL to download the PDF.


USAGE

Use the claim ID to retrieve a generated claim report.
PARAMS
apikey
{{yourSecretKey}}


Example Request
Claim Report

curl --location -g --request GET 'https://api.sbx.qover.io/claims/v1/claims/{{claimID}}.pdf?apikey={{yourSecretKey}}'

GET

Retrieve claim by id

https://api.sbx.qover.io/claims/v1/claims/{{claimID}}?apikey={{yourSecretKey}}


DESCRIPTION

This endpoint is used to retrieve a specific claim.


USAGE

You can retrieve information for a specific claim by including its claim ID in
the request url.
PARAMS
apikey
{{yourSecretKey}}


Example Request
Retrieve claim by id

curl --location -g --request GET 'https://api.sbx.qover.io/claims/v1/claims/{{claimID}}?apikey={{yourSecretKey}}'

Claims Creation - Examples

In this section, we give some indicative examples of claims payload for some of
our insurance products.

Please note that depending on the product and country, we may have to adapt the
required information and documents.

We can easily adjust our API in real time via our Claims API configuration tool
– which does not require any development or deployment.



Purchase Protection

Purchase protection is a powerful tool for FinTechs to attract and retain users,
as well increase transactions. Read more about our purchase protection product
here.


POST

Theft

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}
PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "theft",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {
        "email": "jacky.integreta@qover.com",



Example Request
Theft
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "theft",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {

POST

Refund

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}
PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "refund",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {
        "email": "kim@qover.com",



Example Request
Refund
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "refund",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {

POST

Damages

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}
PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "damages",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {
        "email": "macGyver@qover.com",



Example Request
Damages
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "country": "FR",
    "language": "fr",
    "type": "damages",
    "submissionDate": "2022-07-12T10:00:53.146Z",
    "settings":{
        "sendNotificationsToClaimant":true
    },
    "claimant": {

Fleet


POST

Accident

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}
PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "country": "BE",
    "language": "en",
    "claimant": {
        "email": "Lewis.homiltan@qover.com",
        "phone": "+3412345667",
        "firstName": "Lewis",
        "lastName": "Homiltan",
        "birthdate": "1985-07-01",
        "address": {
            "country": "UK",



Example Request
Accident
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "country": "BE",
    "language": "en",
    "claimant": {
        "email": "Lewis.homiltan@qover.com",
        "phone": "+3412345667",
        "firstName": "Lewis",
        "lastName": "Homiltan",
        "birthdate": "1985-07-01",
        "address": {

Travel

Our modular approach to travel insurance ensures that your customers are covered
when they’re far from home.


POST

Travel

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}
PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "country": "BE",
    "language": "en",
    "claimant": {
        "email": "john.doeh@qover.com",
        "phone": "+3211239011",
        "firstName": "John",
        "lastName": "Doe",
        "birthdate": "1989-04-05",
        "address": {
            "country": "BE",



Example Request
Travel
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "country": "BE",
    "language": "en",
    "claimant": {
        "email": "john.doeh@qover.com",
        "phone": "+3211239011",
        "firstName": "John",
        "lastName": "Doe",
        "birthdate": "1989-04-05",
        "address": {

Document Asset Management

Uploading files as supporting evidence is a key part of any claims process.

We have 2 ways of handling files:

   
 * Either you provide us with the URL of the file when submitting a claim
   
 * Or you can use our Document Asset Management system
   

When 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.


POST

Create asset

https://api.sbx.qover.io/dam/v1/assets?apikey={{apiKey}}

This endpoint is used to create assets in Qover's system. You can provide the
following information:

   
 * Name of the file
   
 * Free text description
   
 * Type of file (e.g. "image/png")
   

The Qover API will return:

   
 * the ID of the asset in Qover system. You will need to keep this asset id
   because you will have to provide it when creating the claim.
   
 * _links.content.href the URL of the file once uploaded
   
 * _links.upload.href the link of the bucket where the file will be uploaded
   

Please note that the link to the bucket will be valid for 15 minutes only.

PARAMS
apikey
{{apiKey}}
BODYraw

{ 
    "filename":"test",
    "description":"this is a test",
    "mediaType":"image/png"
}



Example Request
Create asset

curl --location -g --request POST 'https://api.sbx.qover.io/dam/v1/assets?apikey={{apiKey}}' \
--data-raw '{ 
    "filename":"test",
    "description":"this is a test",
    "mediaType":"image/png"
}'

PUT

Upload asset

{{uploadURL}}

This endpoint is used to upload your file in our system. The URL will have been
provided to you upon creation of the asset.

BODYfile


Example Request
Upload asset

curl --location -g --request PUT '{{uploadURL}}' \
--header 'Content-Type: text/plain' \
--data-binary '@/Users/cedric_francois/Downloads/logos-qover/logo-qover.png'

POST

Create a claim with attachments by using the asset manager

https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}


DESCRIPTION

See above for the description of the endpoint.

PARAMS
apikey
{{apiKey}}
BODYraw
View More

{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "claimant": {
        "email": "Jacky.Integrata@qover.com",
        "phone": "+32496441122",
        "firstName": "Jacky",
        "lastName": "Integreta",
        "birthdate": "1992-04-21",
        "address": {
            "country": "FR",
            "city": "Paris",



Example Request
Create a claim with attachments by using the asset manager
View More

curl --location -g --request POST 'https://api.sbx.qover.io/claims/v1/claims?apikey={{apiKey}}' \
--data-raw '{
    "configId": "80cfcf4d-0acc-4757-ab57-e533fcc25491",
    "claimant": {
        "email": "Jacky.Integrata@qover.com",
        "phone": "+32496441122",
        "firstName": "Jacky",
        "lastName": "Integreta",
        "birthdate": "1992-04-21",
        "address": {
            "country": "FR",