Retrieve an insurance contract

curl --request GET \
  --url https://thirdparty.qonto.com/v2/insurance_contracts/{id} \
  --header 'Authorization: Bearer <token>'

{
  "insurance_contract": {
    "id": "888e4567-e89b-12d3-a456-426614174123",
    "name": "ProLiability Plan 2024",
    "contract_id": "12345",
    "origin": "insurance_hub",
    "provider_slug": "axa",
    "type": "business_liability",
    "status": "active",
    "troubleshooting_url": "https://patner.com/troubleshoot",
    "service_url": "https://partner.com/service",
    "expiration_date": "2025-12-31",
    "start_date": "2024-12-31",
    "renewal_date": "2025-12-31",
    "payment_frequency": "month",
    "price": {
      "value": "99.99",
      "currency": "EUR"
    },
    "documents": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Contract Axa",
        "type": "contract"
      }
    ]
  }
}

GET

insurance_contracts

{id}

Retrieve an insurance contract

curl --request GET \
  --url https://thirdparty.qonto.com/v2/insurance_contracts/{id} \
  --header 'Authorization: Bearer <token>'

{
  "insurance_contract": {
    "id": "888e4567-e89b-12d3-a456-426614174123",
    "name": "ProLiability Plan 2024",
    "contract_id": "12345",
    "origin": "insurance_hub",
    "provider_slug": "axa",
    "type": "business_liability",
    "status": "active",
    "troubleshooting_url": "https://patner.com/troubleshoot",
    "service_url": "https://partner.com/service",
    "expiration_date": "2025-12-31",
    "start_date": "2024-12-31",
    "renewal_date": "2025-12-31",
    "payment_frequency": "month",
    "price": {
      "value": "99.99",
      "currency": "EUR"
    },
    "documents": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Contract Axa",
        "type": "contract"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token

string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Path Parameters

string

required

UUID of the insurance contract

Response

Returns the insurance contract identified by the id path parameter.

insurance_contract

object

required

Insurance contract data provided by Partner

Show child attributes

insurance_contract.id

string

UUID of the insurance contract

Example:

"888e4567-e89b-12d3-a456-426614174123"

insurance_contract.name

string

Name of the insurance contract signed by the customer

Example:

"ProLiability Plan 2024"

insurance_contract.contract_id

string

ID of the contract created by partner

Example:

"12345"

insurance_contract.origin

enum<string>

Insurance contract origin

Available options:

insurance_hub,

qonto_other,

stello

Example:

"insurance_hub"

insurance_contract.provider_slug

string

Identifier representing insurance provider

Example:

"axa"

insurance_contract.type

string

Defined category of insurance taken by the customer

Example:

"business_liability"

insurance_contract.status

enum<string>

Insurance contract status

Available options:

active,

pending_payment,

pending_others,

action_required,

expired,

archived

Example:

"active"

insurance_contract.troubleshooting_url

string

Link for troubleshooting when contract status is not active

Example:

"https://patner.com/troubleshoot"

insurance_contract.service_url

string

Static link for customer to access their insurance management portal

Example:

"https://partner.com/service"

insurance_contract.expiration_date

string<date>

Date when the contract terminates unless it is renewed

Example:

"2025-12-31"

insurance_contract.start_date

string

Date when the insurance contract becomes active and coverage begins

Example:

"2024-12-31"

insurance_contract.renewal_date

string

Date when the policy is scheduled for renewal

Example:

"2025-12-31"

insurance_contract.payment_frequency

enum<string>

Payment frequency

Available options:

month,

quarter,

semester,

annual

Example:

"month"

insurance_contract.price

object

Price of the insurance

Show child attributes

insurance_contract.price.value

string

Example:

"99.99"

insurance_contract.price.currency

string

Example:

"EUR"

insurance_contract.documents

object[]

Insurance document(s) attached to the contract

Show child attributes

insurance_contract.documents.id

string<uuid>

UUID of the attachment

Example:

"123e4567-e89b-12d3-a456-426614174000"

insurance_contract.documents.name

string

The name of the file

Example:

"Contract Axa"

insurance_contract.documents.type

string

Type of the file

Example:

"contract"

Create an insurance contract Update an insurance contract

⌘I

Business API

Onboarding API

Retrieve an insurance contract

Authorizations

Headers

Path Parameters

Response