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.

Invite an applicant

POST https://api.certn.co/api/v1/pm/applications/invite/

Invite an applicant to complete a screen.

Provide information in the body of the request to pre-fill the application forms.

To invite multiple applicants at once use the grouped_applicants parameter. Add each applicant as an object within the array, and provide an email (required) and a phone_number (optional).

Example

{

"request_softcheck": true,

"email": "qa2+testpm@certn.co",

"owner_id" : "bd78a737-16cf-496a-9c3a-7b9e5533cfce"

}

Request Body

NameTypeDescription

email*

string

Applicant's email address

tag

string

Group related applications by tag

phone_number

object

information

object

{request_flag}*

boolean

owner_id*

string <uuid>

ID of user ordering the application

application/json
{
  "id": string <uuid>,
  "created": string <date-time>,
  "modified": string <date-time>,
  "applicants": [
    {
      "id": string <uuid>,
      "status": string <Enum>,
      "first_name": string,
      "last_name": string,
      "email": string,
      "phone_number": {
        "phone_type": string <Enum>,
        "number": string",
        "country": string <ISO Country Code>
      }
    }
  ]
}

Screen an applicant instantly

POST https://api.certn.co/api/v1/pm/applications/quick/

Screen an applicant using only the information in the body of your request.

Get the applicant's consent before running the screen.

Request Body

NameTypeDescription

tag

string

Group related applications by tag

email

string

Applicant's email address

information*

object

{request_flag}*

boolean

position_or_property_location*

object

owner_id*

string <uuid>

ID of user ordering the application

enhanced_identity_verification

object

application/json
{
  "id": string <uuid>,
  "created": string <date-time>,
  "modified": string <date-time>,
  "tag": string,
  "(request_flags)": boolean 
  "last_updated": string <date-time>,
  "submitted_time": string <date-time>,
  "is_submitted": boolean,
  "applicant_type": string <Enum>,
  "report_status": string <Enum>,
  "status": string <Enum>,
  "status_label": string <Enum>,
  "result": string <Enum>,
  "result_label": string <Enum>,
  "certn_score": number,
  "certn_score_label": string <Enum>,
  "applicant_account": {
    "id": string,
    "email": string
  },
  "application": {
    object (Application) 
  },
  "country": "CA",
  "information": {
    object (Information)
  },
  "employment_verification": string <VerificationEnum>,
  "education_verification": string <VerificationEnum>,
  "credential_verification": string <VerificationEnum>,
  "reference_result": {
    object (BasePackageResult)
  },
  "information_result": {
    object (BasePackageResult)
  },
  "risk_result": {
    object (RiskResult)
  },
  "equifax_result": {
    object (EquifaxResult)
  },
  "identity_verified": boolean,
  "employment_verified": boolean,
  "identity_verification": {
    object (Identity Verification)
  },
  "enhanced_identity_verification": {
    object (EnhancedIdentityVerification)
  },
  "manual_id_verification": {
    object (ManualIDVerification)
  },
  "rcmp_result": {
    object (BasePackageResult)
  },
  "us_criminal_record_check_result": {
    object (USCriminalRecordCheckResult)
  },
  "verification_result": {
    object (VerificationResult)
  },
  "international_criminal_record_check_result": {
    object (BasePackageResult)
  },
  "motor_vehicle_record_result": {
    object (BasePackageResult)
  },
  "salary": number,
  "sufficient_salary": boolean,
  "high_risk_vulnerable_sector": boolean,
  "job_safety_undue_risk": boolean,
  "early_termination": number,
  "early_termination_label": string <Enum>,
  "reliability_risk": number,
  "reliability_risk_label": string <Enum>,
  "workplace_misconduct": number,
  "workplace_misconduct_label": string <Enum>
}