Insurance Invitation

Create Tenant Insurance Invitation

POST/v2/tenant-insurance-invitations

Create an insurance invitation link for a tenant. The tenant will be able to share insurance details, such as policy ID and insurance period, with the inviter.

Request body

referenceIdstringRequired

Unique ID in the client system.

insuranceStartDatestringRequired

Insurance start date.

tenantobjectOptional

Tenant's details.

namestringOptional

Tenant's name.

surnamestringOptional

Tenant's surname.

peselNumberstringOptional

Tenant's PESEL number.

citizenshipstringOptional

Tenant's citizenship.

birthDatestringOptional

Tenant's birth date.

addressobjectOptional

Tenant's address.

citystringOptional

Tenant's city.

streetstringOptional

Tenant's street.

houseNumberstringOptional

Tenant's house number.

flatNumberstringOptional

Tenant's flat number.

postalCodestringOptional

Tenant's postal code.

emailstringOptional

Email address to send an email with a insurance link.

languagestringOptional

Language used as initial in the process (pl|en|ua).

callbackUrlstringOptional

Callback URL for process updates (see tenant insurance invitation status object).

Returns

invitationUrlstring

URL to the insurance invitation.

Provided tenant details will be used to pre-fill an insurance form.

Request Example


curl --location --request POST 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/' \
     --header 'Authorization: <API key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "tenant": {
            "name": "Simpl",
            "surname": "Rent",
            "peselNumber": "55082282655",
            "citizenship": "PL",
            "birthDate": "1955-08-22",
            "address": {
                "city": "Warsaw",
                "street": "Kurza",
                "houseNumber": "34",
                "flatNumber": "3",
                "postCode": "02-832"
            }
        },
        "insuranceStartDate": "2022-01-20",
        "referenceId": "1234",
        "callbackUrl": "https://simpl.rent"
    }'

Get Tenant Insurance Invitation

Fetch insurance invitation data.

GET/v2/tenant-insurance-invitations/{id}

Get tenant insurance invitation data.

Path parameters

idstring

Unique ID (referenceId) provided during tenant insurance invitation creation.

Returns

Returns tenant insurance invitation status object.

Request Example


curl --location --request GET 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/123' \
--header 'Authorization: <API key>'

Get Tenant Insurance Certificate Policy

Fetch Insurance Certificate Policy if tenant shared his insurance.

GET/v2/tenant-insurance-invitations/{id}/certificate

Get tenant insurance certificate policy.

Path parameters

idstring

Unique ID (referenceId) provided during tenant insurance invitation creation.

Returns

pdfContent-Type: application/pdf

PDF file tenant insurance policy certificate.

Request Example


curl --location --request GET 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/123/certificate' \
--header 'Authorization: <API key>'

Cancel Tenant Insurance Invitation

DELETE/v2/tenant-insurance-invitations/{id}

Cancel the tenant insurance invitation.

Path parameters

idstring

Unique ID (referenceId) provided during tenant insurance invitation creation.

Example Request


curl --location --request DELETE 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/12345' \
--header 'Authorization: <API key>'

Resend Tenant Insurance Invitation

POST/v2/tenant-insurance-invitations/{id}/resend

Resend the tenant insurance invitation.

Path parameters

idstring

Unique ID (referenceId) provided during tenant insurance invitation creation.

Request body

emailstring

Recipient email address.

Example Request


curl --location --request POST 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/12345/resend' \
--header 'Authorization: <API key>
--data-raw '{
    "email":"test@test.com",
}'

Tenant Insurance Invitation Status Object

Callback object for insurance invitation process updates.

referenceIdstring

Unique ID in the client system.

invitationStatestring

Invitation state (NEW|INSURED|REJECTED|DELETED).

tenantobject

Tenant's details.

namestring

Tenant's name.

surnamestring

Tenant's surname.

policyIdstring

Tenant's policy ID.

insuranceStartDatestring

Tenant's insurance start date (YYYY-MM-dd).

insuranceEndDatestring

Tenant's insurance end date (YYYY-MM-dd).

Create Landlord Insurance Invitation

POST/v2/landlord-insurance-invitations

Create an invitation for landlord insurance. The landlord will be able to purchase landlord insurance with a discount for the provided tenant certificate and share insurance details with the inviter.

Request body

referenceIdstringRequired

Unique ID in the client system.

certificateIdstringOptional

When provided, the landlord will be able to purchase insurance with a tenant certificate discount.

emailstringOptional

If provided, an email with a insurance link will be sent to the landlord

callbackUrlstringOptional

Callback URL for process updates (see landlord insurance invitation status object).

Returns

invitationUrlstring

URL to the insurance invitation.

Example Request


curl --location --request POST 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/' \
--header 'Authorization: <API key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId":"12345",
    "callbackUrl":"https://simpl.rent",
    "certificateId": "r9kx"
}
'

Get Landlord Insurance Invitation

GET/v2/landlord-insurance-invitations/{id}

Fetch insurance invitation data.

Path parameters

idstring

Unique ID (referenceId) provided during landlord insurance invitation creation.

Returns

Returns landlord insurance invitation status object.

Example Request


curl --location --request GET 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/123' \
--header 'Authorization: <API key>'

Cancel Landlord Insurance Invitation

DELETE/v2/landlord-insurance-invitations/{id}

Cancel the landlord insurance invitation.

Path parameters

idstring

Unique ID (referenceId) provided during landlord insurance invitation creation.

Example Request


curl --location --request DELETE 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/12345' \
--header 'Authorization: <API key>'ż

Resend Landlord Insurance Invitation

POST/v2/landlord-insurance-invitations/{id}/resend

Resend the landlord insurance invitation.

Path parameters

idstring

Unique ID (referenceId) provided during landlord insurance invitation creation.

Request body

emailstring

Recipient email address.

Example Request


curl --location --request DELETE 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/12345/resend' \
--header 'Authorization: <API key>'

Landlord Insurance Invitation Status Object

Landlord insurance invitation data.

referenceIdstring

Unique ID in the client system.

invitationStatestring

Invitation state (NEW|INSURED|REJECTED|DELETED).

landlordobject or undefined

Landlord details (visible only if the landlord accepts to share data)

namestring

Landlord's name.

surnamestring

Landlord's surname.

insuranceobject or undefined

Landlord insurance details (visible only if the landlord accepts to share data)

policyIdstring

Insurance policy ID.

startDatestring

Insurance start date (YYYY-MM-dd).

endDatestring

Insurance end date (YYYY-MM-dd).