Insurance Invitations

Create Tenant Insurance Invitation

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.

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

POST /v2/tenant-insurance-invitations

Request Body
{
  "tenant": {
    "name": string,
    "surname": string,
    "peselNumber": string,
    "citizenship": string,
    "birthDate": string,
    "address": {
      "city": string,
      "street": string,
      "houseNumber": string,
      "flatNumber": string,
      "postalCode": string
    }
  },
  "insuranceStartDate": string,
  "referenceId": string,
  "callbackUrl": string,
  "email": string
}
Request Response
{
  "invitationUrl": string
}
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

id - string referenceId provided during tenant insurance invitation creation.

Request Response
{
  "referenceId": string,
  "invitationState": NEW|INSURED|REJECTED|DELETED,
  "variant": string,
  "tenant": {
    "name": string,
    "surname": string,
    "policyId": string,
    "insuranceStartDate": string,
    "insuranceEndDate": string,
  }
}
Request Example
curl --location --request GET 'https://api-test.simpl.rent/v2/tenant-insurance-invitations/123' \
--header 'Authorization: <API key>'

Cancel Tenant Insurance Invitation

Cancel the tenant insurance invitation.

DELETE /v2/tenant-insurance-invitations/:id

id - string 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

Cancel the tenant insurance invitation that is not in INSURED state.

POST /v2/tenant-insurance-invitations/:id/resend

id - string referenceId provided during tenant insurance invitation creation.

Request Body
{
    "email": string,
}
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",
}'

Create Landlord Insurance Invitation

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.

POST /v2/landlord-insurance-invitations

Request Body
{
  "certificateId": string,
  "referenceId": string,
  "callbackUrl": string,
  "email": string
}
Request Response
{
  "invitationUrl": string
}
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

Fetch insurance invitation data.

GET /v2/landlord-insurance-invitations/:id

id - string referenceId provided during landlord insurance invitation creation.

Request Response
{
  "referenceId": string,
  "invitationState": NEW|INSURED|REJECTED|DELETED,
  "landlord": {
    "name": string,
    "surname": string
  },
  "insurance": {
    "policyId": string,
    "startDate": string,
    "endDate": string
  }
}
Example Request
curl --location --request GET 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/123' \
--header 'Authorization: <API key>'

Cancel Landlord Insurance Invitation

Cancel the landlord insurance invitation.

DELETE /v2/landlord-insurance-invitations/:id

id - string 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

Cancel the landlord insurance invitation that is not in INSURED state.

POST /v2/landlord-insurance-invitations/:id/resend

id - string referenceId provided during landlord insurance invitation creation.

Request Body
{
    "email": string,
}
Example Request
curl --location --request DELETE 'https://api-test.simpl.rent/v2/landlord-insurance-invitations/12345/resend' \
--header 'Authorization: <API key>'
Tenant VerificationPayment Invitations