Simpl integration API (1.0)

Introduction

API meant to be used for integrating with Simpl.rent.

It allows generating verification links for potential tenants - used later to confirm their identity, credibility, affordability and viewing the results.

Authentication

Every API request must contain valid API key in HTTP header 'Authorization'.

User API keys are available on the integration page after signing into account (https://simpl.rent/integracje)

Account

Accessing user related data

Check balance

Get available credits for account

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "credits": 0
}

Verifications

Generating verification links and tracking their progress

Get verifications

Get list of all verifications which user owns. Optionally include referenceId as parameter to retrieve specific one.

query Parameters
referenceId
string

referenceId

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Create verification

Create new verification and get it's link to share with potential tenants.

Request Body schema: application/json

verificationLinkApiRequestDTO

propertyAddress
string
referenceId
string
rentalAmount
number

Responses

Request samples

Content type
application/json
{
  • "propertyAddress": "string",
  • "referenceId": "string",
  • "rentalAmount": 0
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "verificationId": "string",
  • "verificationUrl": "string"
}