Tenant Verification

Create Verification

Create a verification process.

POST /v2/verifications

Request Body
{
  "type": FULL_CHECK|IDENTITY_CREDIT_CHECK|IDENTITY_CHECK,
  "language": pl|en|ua,
  "numberOfTenants": number,
  "tenants": [
    {
      "email": string
    }
  ],
  "property": {
    "rent": number,
    "address": string,
    "city": string,
    "street": string,
    "houseNumber": string,
    "flatNumber": string,
    "postalCode": string
  },
  "contactPerson": {
    "name": string,
    "email": string,
    "phone": string
  },
  "referenceId": string,
  "callbackUrl": string
}
Success Response
{
  "verificationUrl": string
}
Request Example
curl --location --request POST 'https://api-test.simpl.rent/v2/verifications' \
     --header 'Authorization: <API key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "type": "FULL_CHECK",
        "language": "pl",
        "numberOfTenants": 1,
        "tenants": [
          {
            "email": "test@simpl.rent"
          }
        ],
        "property": {
          "rent": 1000,
          "city": "krakow",
          "street": "ul. Dluga",
          "houseNumber": "1",
          "flatNumber": "1",
          "postalCode": "00-000"
        },
        "contactPerson": {
          "name": "Marcin",
          "email": "Nowak",
          "phone": "500 400 100"
        },
        "referenceId": "123",
        "callbackUrl": "https://simpl.rent"
      }'

Get Verification

Fetch verification process data.

To obtain verification state explanations, use certificateId to download Tenant Certificate.

GET /v2/verifications/:id

id - string referenceId provided when creating the verification.

Response Response
{
  "referenceId": string,
  "tenants": [
    {
      "id": string,
      "certificateId": string,
      "email": string,
      "name": string,
      "surname": string,
      "identityCheck": NOT_STARTED|PENDING|PASSED|FAILED,
      "affordabilityCheck": NOT_STARTED|SUBMITTED|PENDING|PASSED|FAILED,
      "creditCheck": NOT_STARTED|SUBMITTED|PASSED|FAILED,
      "sanctionsCheck": NOT_STARTED|SUBMITTED|PASSED|FAILED,
      "finalStatus": NOT_STARTED|PENDING|PASSED|FAILED,
    }
  ]
}
Request Example
curl --location --request GET 'https://api-test.simpl.rent/v2/verifications/123' \
     --header 'Authorization: <API key>'

Cancel Verification

Cancel the verification process. The verification is cancelable only if the tenant has not performed any checks yet.

If the verification is not started, it will cancel itself after 5 days since the last update.

DELETE /v2/verifications/:id

id - string referenceId provided when creating the verification.

Request Example
curl --location --request DELETE 'https://api-test.simpl.rent/v2/verifications/123' \
     --header 'Authorization: <API key>'

Get Tenant Certificate

Fetch the Tenant Certificate PDF file.

GET /v2/certificates/:id/

id - string certificateId from tenant verification data.

Parameters:
lang - string (optional) Language of the certificate. Available options are 'en', 'pl', 'ua'. If not provided, the default language is 'pl'.

Response Content-Type: application/pdf

Request Example
curl --location --request GET 'https://api-test.simpl.rent/v2/certificates/zved?lang=pl' \
     --header 'Authorization: <API key>' --output certificate.pdf

Send Verification Invitation/Reminder

Send verification process invitation/reminder to a tenant (same email as on create verification action)

POST /v2/verifications/:id/invite

Request Body
{
  "tenant": {
    "email": string,
  }
}
Request Example
curl --location --request POST '/v2/verifications/123/invite' \
--header 'Authorization: <API key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenant": {
    "email": "test@simpl.rent"
  }
}'
AccountInsurance Invitations