Insurance

Get Pricing

POST/v2/insurance-pricing

Get insurance pricing for a given variant and params. List of variants and required parameters available in the section below.

Request body

variantstring

Insurance variant.

parametersarray

Parameters required to calculate the insurance price.

namestring

Name of the parameter.

valuestring

Value of the parameter.

Returns

fullstring

Full insurance price.

Request Example


curl --location --request POST 'https://api-test.simpl.rent/v2/insurance-pricing' \
     --header 'Authorization: <API key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "variant": "tenant_insurance_basic",
        "parameters": [
          {
            "name": "liability_sum",
            "value": "100000"
          }
        ]
    }'

Issue Insurance

POST/v2/issue-insurance

Issue insurance for a given variant. Please refer to the section for available variants and required parameters.

Request body

variantstringRequired

Insurance variant.

entitiesarrayRequired

List of insurance entities.

typestringRequired

Type of an entity on insurance (insured | policyholder | insured_and_policyholder).

namestringOptional

Name of the entity. Required if the entity is a person.

surnamestringOptional

Surname of the entity. Required if the entity is a person.

peselNumberstringOptional

PESEL number of the entity. Required if the entity is a person and Polish citizen.

citizenshipstringOptional

Citizenship of the entity. Required if the entity is not a Polish citizen and does not have a PESEL number.

birthDatestringOptional

Birth date of the entity. Required if the entity is not a Polish citizen and does not have a PESEL number.

regonNumberstringOptional

REGON number of the entity. Required if the entity is a company.

companyNamestringOptional

Name of the company. Required if the entity is a company.

addressobjectRequired

Address of the entity.

postalCodestringRequired

citystringRequired

streetstringRequired

houseNumberstringRequired

flatNumberstringOptional

parametersarrayRequired

List of parameters required for the specific insurance variant (see section below).

namestringRequired

valuestringRequired

Returns

policyNumberstring

Policy number.

Request Example


curl --location --request POST 'https://api-test.simpl.rent/v2/issue-insurance' \
     --header 'Authorization: <API key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "variant": "tenant_insurance_basic",
        "entities": [
          {
            "type": "insured",
            "name": "John",
            "surname": "Doe",
            "peselNumber": "12345678901",
            "address": {
              "city": "Warszwa",
              "street": "Krucza",
              "houseNumber": "1",
              "flatNumber": "1",
              "postalCode": "00-000"
            }
          },
          {
            "type": "policyholder",
            "companyName": "Company Name",
            "regonNumber": "1234567890",
            "address": {
              "city": "Warszwa",
              "street": "Piwna",
              "houseNumber": "1",
              "flatNumber": "1",
              "postalCode": "00-000"
            }
          }
        ],
        "parameters": [
          {
            "name": "start_date",
            "value": "2025-01-01"
          },
          {
            "name": "liability_sum",
            "value": "100000"
          },
        ]
    }'

Cancel Insurance

POST/v2/cancel-insurance

Insurance cancellation.

Request body

policyNumberstringRequired

Policy number.

cancelAtstringRequired

Date (YYYY-MM-DD) at which insurance should be cancelled.

Request Example


curl --location --request POST 'https://api-test.simpl.rent/v2/cancel-insurance' \
     --header 'Authorization: <API key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
       "policyNumber": "TXS00000001",
       "cancelAt": "2025-01-01"
    }'

Insurance Variants

Tenant Insurance

tenant_insurance_basic

start_datestring

Start date of the insurance (YYYY-MM-DD).

liability_sumstring

Liability sum value. Required for pricing calculation.

Landlord Insurance

landlord_insurance

start_datestring

Start date of the insurance (YYYY-MM-DD).

rent_contract_start_datestring

Start date of the rent contract (YYYY-MM-DD).

rent_contract_end_datestring

End date of the rent contract (YYYY-MM-DD) (optional if indefinite lease).

rent_sumstring

Rent sum.

rent_protection_sumstring

Rent guarantee sum (max 3x rent sum or 24000 PLN / min 6000 PLN). Required for pricing calculation.

property_citystring

City of the insured property.

property_streetstring

Street of the insured property.

property_house_numberstring

House number of the insured property.

property_flat_numberstring

Flat number of the insured property.

property_postal_codestring

Postal code of the insured property.

cancel_atstringOptional

Date (YYYY-MM-DD) at which insurance should be cancelled.