Certn API
Search
K
Links

Property Management

How to make requests and generate reports as a property management client in the Certn API.

Demo Environment

When sending test data to the following endpoints, change the domain to https://demo-api.certn.co.
To view a list of all application parameters, visit Application parameters.

Applications

An application is a single request containing a variety of checks for one applicant. These endpoints allow you to create, upgrade, and retrieve the applications associated with your team.
post
https://api.certn.co
/api/v1/pm/applications/invite/
Invite an applicant
post
https://api.certn.co
/api/v1/pm/applications/quick/
Screen an applicant instantly
Screen an applicant using only the information in the body of your request.
Get the applicant's consent before running the screen.
Parameters
Body
information*
object
owner_id*
string <uuid>
ID of user ordering the application
{request_flag}*
boolean
position_or_property_location*
object
email
string
Applicant's email address
tag
string
Group related applications by tag
enhanced_identity_verification
object
Responses
201: Created
PM application successfully created
400: Bad Request
Missing field, wrong data type, account not configured
500: Internal Server Error
Wrong data type
put
https://api.certn.co
/api/v1/pm/applicants/{applicant_id}/packages/
Upgrade an application
get
https://api.certn.co
/api/v1/pm/applicants/
Retrieve applicant list
get
https://api.certn.co
/api/v1/pm/applicants/{applicant_id}/
Retrieve an application

Reports

A report shows the final results of the requested checks. These endpoints allow you to retrieve your reports in the format of your choice.
get
https://api.certn.co
/api/v1/pm/reports/{applicant_id}/pdf
Download a PDF report
get
https://api.certn.co
/api/v1/pm/reports/{applicant_id}/link
Create a hosted PDF report
get
https://api.certn.co
/api/v1/pm/reports/{applicant_id}/web/
Download an HTML report

Properties

A property is a specific location with an address that you are renting. These endpoints allow you to create and retrieve the properties associated with your team.
get
https://api.certn.co
/api/v1/pm/properties/
Retrieve your properties
post
https://api.certn.co
/api/v1/pm/properties
Create a property

Listings

A listing is a specific unit that you have placed up for rent. These endpoints allow you to create and retrieve the listings associated with your team.
get
https://api.certn.co
/api/v1/pm/listings/
Retrieve your listings
post
https://api.certn.co
/api/v2/listings/
Create a listing

Examples

Invite an applicant
{
"request_softcheck": true,
"email": "[email protected]",
"owner_id" : "bd78a737-16cf-496a-9c3a-7b9e5533cfce"
}
Screen an applicant instantly
{
"request_softcheck": true,
"email": "[email protected]",
"information": {
"first_name": "Will",
"last_name": "Nettke",
"date_of_birth": "1970-06-28",
"addresses": [
{
"address": "4412 King Alfred Court",
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"current": true
}
]
},
"position_or_property_location": {
"address": "Tiffany & Co., 97 Greene St",
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "v8t3n9",
"location_type": "Property Location"
},
"owner_id": "bd78a737-16cf-496a-9c3a-7b9e5533cfce"
}
The Certn Group of companies includes Certn, Credence & InterCheck. For educational purposes, these companies are referred to as “Certn” in this website. For questions about any of the aforementioned companies, contact [email protected]. ©2023 Certn.