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>
}

Upgrade an application

PUT https://api.certn.co/api/v1/pm/applicants/{applicant_id}/packages/

Add a screening request to an existing application.

To add screening requests to your application, wait for the report's status field to show Returned.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

Request Body

NameTypeDescription

tag

string

Group related applications by tag

{request_flag}*

boolean

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>
}

Retrieve applicant list

GET https://api.certn.co/api/v1/pm/applicants/

View the details of all your applications.

The results are sent via paginated response, in chronological order. To retrieve the next page, send a request to the URL under the field next, or add one to your page counter:

https://api.certn.co/api/v1/pm/applicants/?page=<pgNum>

You can retrieve the final report for an application when its report_status field is marked as COMPLETE.

Query Parameters

NameTypeDescription

page

int

Page number to retrieve

application__team__id

string <uuid>

The application's team id.

owner

string <uuid>

application/json
{
    "count": int,
    "next": URL,
    "previous": URL,
    "results": [
        {
            "request_identity_verification": boolean,
            "request_equifax": boolean,
            "request_base": boolean,
            "request_instant_verify_employment": boolean,
            "request_instant_verify_education": boolean,
            "request_instant_verify_credential": boolean,
            "request_international_criminal_record_check": boolean,
            "request_enhanced_identity_verification": boolean,
            "request_motor_vehicle_records": boolean,
            "request_criminal_record_check": boolean,
            "request_enhanced_criminal_record_check": boolean,
            "request_vulnerable_sector_criminal_record_check": boolean,
            "request_employer_references": boolean,
            "request_address_references": boolean,
            "request_employer_phone_references": boolean,
            "request_address_phone_references": boolean,
            "request_softcheck": boolean,
            "request_social_media_check": boolean,
            "request_soquij": boolean,
            "request_us_criminal_record_check_tier_1": boolean,
            "request_us_criminal_record_check_tier_2": boolean,
            "request_us_criminal_record_check_tier_3": boolean,
            "request_education_verification": boolean,
            "request_credential_verification": boolean,
            "request_employment_verification": boolean,
            "request_vaccination_check": boolean,
            "request_right_to_work": boolean,
            "request_uk_basic_dbs_check": boolean,
            "request_uk_basic_ds_check": boolean,
            "request_uk_right_to_work_check": boolean,
            "id": string <uuid>,
            "short_uid": string,
            "last_updated": string <date-time>,
            "report_status": string <Enum>,
            "is_cosigner": boolean,
            "information": {
                "first_name": string,
                "last_name": string
            },
            "applicant_account": {
                "id": string <uuid>,
                "email": string,
                "email_verified": boolean,
                "phone_number": string
            },
            "application": {
                "applicants": [
                    {
                        "id": string <uuid>,
                        "first_name": string,
                        "last_name": string,
                        "email": string,
                        "phone_number": string,
                        "share_of_rent": float,
                        "is_cosigner": boolean,
                        "application_url": URL,
                        "report_url": URL,
                        "status": string <Enum>
                    }
                ],
                "owner": {
                    "email": string
                },
                "is_active": boolean,
                "team": {
                    "name": string
                },
                "listing": object(Listing)
            },
            "can_upgrade": boolean,
            "is_equifax_eligible": boolean,
            "can_resend_email": boolean,
            "resend_email_time": string <date-time>,
            "report_summary": {
                "reference_result": object(BasePackageResult),
                "rcmp_result": object(RCMPResult),
                "equifax_result": object(EquifaxResult),
                "information_result": object(BasePackageResult),
                "instant_verify_result": object(BasePackageResult),
                "international_criminal_record_check_result": object(InternationalCriminalRecordCheckResult),
                "motor_vehicle_record_result": object(MotorVehicleRecordResult),
                "social_media_check_result": object(SocialMediaCheckResult),
                "risk_result": object(RiskResult),
                "soquij_result": object(SoquijResult),
                "uk_basic_dbs_check_result": object(UKBasicDBSCheckResult),
                "uk_basic_ds_check_result": object(UKBasicDSCheckResult),
                "uk_right_to_work_check_result": object(UKRightToWorkResult),
                "us_criminal_record_check_result": object(USCriminalRecordCheckResult),
                "vaccination_check_result": object(BasePackageResult),
                "right_to_work_result": object(RightToWorkResult),
                "certn_verification": object(BasePackageResult),
                "report_result": string <Enum>,
                "report_result_label": string <Enum>,
                "dispute": boolean,
                "report_status": string <Enum>,
                "report_status_label": string <Enum>
            },
            "is_viewed": boolean,
            "onboarding_link":  URL,
            "adjudication_status": string <Enum>,
            "adjudication_status_label": string <Enum>,
            "status": string <Enum>,
            "has_active_automated_reminders": boolean,
            "order_status": string <Enum>,
            "check_executions": [
                {
                    "id": string,
                    "check_name": string <Enum>,
                    "status": string <Enum>,
                },
            ]
        }
    ]
}

Retrieve an application

GET https://api.certn.co/api/v1/pm/applicants/{applicant_id}/

View the details of an application.

Check the status field to see if the application is done processing.

You can retrieve the final report when the report_status field is marked as COMPLETE.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

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>
}

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.

Download a PDF report

GET https://api.certn.co/api/v1/pm/reports/{applicant_id}/pdf

Download an application's report as a PDF file.

To download the report, wait for the application's status field to show Returned.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

application/pdf
string <binary>

Create a hosted PDF report

GET https://api.certn.co/api/v1/pm/reports/{applicant_id}/link

Create a PDF report hosted on Certn's servers. The URL returned can be used to view the report without downloading it. This link is valid for 1 hour only.

To create the hosted PDF report, wait for the application's status field to show Returned.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

{
  "report_url": string
}
{
    // Response
}

Download an HTML report

GET https://api.certn.co/api/v1/pm/reports/{applicant_id}/web/

Download an application's report as an HTML file.

To download the report, wait for the application's status field to show Returned.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

application/json
{
  "html": string
}

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.

Retrieve your properties

GET https://api.certn.co/api/v1/pm/properties/

View the details of all your properties.

The results are sent via paginated response. To retrieve the next page, send a request to the URL under the field next, or add one to your page counter:

https://api.certn.co/api/v2/properties/?page=<pgNum>

Query Parameters

NameTypeDescription

page

int

Page number to retrieve

{
    "count": int,
    "next": URL,
    "previous": URL,
    "results": [
        {
            "id": string <uuid>,
            "status": string <Enum>,
            "get_status_display": string <Enum>,
            "created": string <date-time>,
            "modified": string <date-time>,
            "last_updated": string <date-time>,
            "building": string,
            "building_code": string,
            "address": string,
            "city": string,
            "province_state": string <ISO Code>,
            "country": string <ISO Country Code>,
            "postal_code": string,
            "county": string,
            "is_active": boolean,
            "owner": {
                "id": string <uuid>,
                "email": string,
                "team": object(Team)
            },
            "listing_count": int,
            "full_address": string,
            "url_code": string <uuid>
      }
    ]
}

Create a property

POST https://api.certn.co/api/v1/pm/properties

Create a new property with the information provided in the body of your request.

Request Body

NameTypeDescription

building

string

Building's name

building_code

string

address*

string

city*

string

province_state*

string

country

string

is_active

boolean

owner_id*

string

Assign this property to a specific user

county*

string

US county, required for US addresses

application/json
{
  "id": string <uuid>,
  "status": string,
  "get_status_display": string,
  "created": string <date-time>,
  "modified": string <date-time>,
  "last_updated": string <date-time>,
  "building": string,
  "building_code": string,
  "address": string,
  "city": string,  
  "county": string,
  "province_state": string <ISO Code>,
  "country": string <ISO Country Code>,
  "postal_code": string,
  "is_active": boolean,
  "owner": {
    "id": string <uuid>,
    "email": string,
    "team": {
      "id": string <uuid>,
      "name": string,
      "country": string <ISO Country Code>,
      "industry": string,
      "team_type": string,
      "internal_name": string,
      "app_url": string,
      "compliance_region": {
        "id": string <uuid>,
        "name": string,
        "country": string <ISO Country Code>,
        "team_type": string,
        "sub_region": string,
        "default": boolean,
        "score_value_field": string,
        "score_label_field": string,
        "show_legal_us": boolean,
        "show_credit_report": boolean,
        "show_fcra": boolean,
        "require_address_history": boolean
      },
      "settings_config": {
        "get_org_name": string,
        "org_name": string,
        "org_logo_link": string,
        "org_primary_color": string,
        "whitelabel_report": boolean,
        "whitelabel_emails": boolean,
        "compact_pdf_report": boolean,
        "behavioural_test_req": boolean,
        "emergency_contact_req": boolean,
        "personal_ref_req": boolean,
        "education_req": boolean,
        "tenancy_years_amount_req": int,
        "tenancy_ref_amount_req": int,
        "tenancy_ref_email_req": boolean,
        "tenancy_ref_phone_req": boolean,
        "employer_years_amount_req": int,
        "employer_ref_req": boolean,
        "employer_ref_email_req": boolean,
        "employer_ref_phone_req": boolean,
        "document_required": boolean,
        "cover_letter_req": boolean,
        "government_id_req": boolean,
        "proof_of_income_req": boolean,
        "resume_req": boolean,
        "visa_req": boolean,
        "personal_ref_amount_req": int,
        "passport_req": boolean,
        "hide_detailed_financial": boolean,
        "hide_sin_ssn": boolean,
        "hide_date_of_birth": boolean,
        "enable_rcmp_reflow": boolean,
        "hide_id_verification_photos": boolean,
        "hide_current_address": boolean,
        "require_id_with_address": boolean,
        "hide_activity_log": boolean,
        "redirect_url": string,
        "custom_tracks": [],
        "my_crc_region": string,
        "hide_ssn_trace": boolean,
        "request_base": boolean,
        "request_behavioural": boolean,
        "request_softcheck": boolean,
        "request_equifax": boolean,
        "request_identity_verification": boolean,
        "request_enhanced_identity_verification": boolean,
        "request_criminal_record_check": boolean,
        "request_enhanced_criminal_record_check": boolean,
        "request_vulnerable_sector_criminal_record_check": boolean,
        "request_motor_vehicle_records": boolean,
        "request_education_verification": boolean,
        "request_employment_verification": boolean,
        "request_us_criminal_softcheck": boolean,
        "request_us_ssn_verification": boolean,
        "request_employer_references": boolean,
        "request_address_references": boolean,
        "request_employer_phone_references": boolean,
        "request_address_phone_references": boolean,
        "request_international_criminal_record_check": boolean,
        "request_soquij": boolean,
        "request_instant_verify_employment": boolean,
        "request_instant_verify_education": boolean,
        "request_instant_verify_credential": boolean,
        "employer_references_min": int,
        "employer_references_max": int,
        "address_references_min": int,
        "address_references_max": int,
        "employment_verification_min": int,
        "employment_verification_max": int,
        "education_verification_min": int,
        "education_verification_max": int,
        "credential_verification_min": int,
        "credential_verification_max": int,
        "credential_verification_level": string,
        "education_verification_level": string,
        "employer_references_years": int,
        "address_references_years": int,
        "employment_verification_years": int,
        "employment_verification_years_or_individually": string,
        "address_references_years_or_individually": string,
        "employer_references_years_or_individually": string,
        "us_criminal_record_check_years": int,
        "applicant_login": boolean,
        "exclude_softcheck_possible_matches": boolean,
        "workable_fast_complete": boolean,
        "review_all_negative_mvr_results": boolean,
        "limit_education_verifications": boolean
      },
      "billing_plan": {
      },
      "google_analytics_key": string,
      "adwords_key": string,
      "adwords_conversion_key": string,
      "external_domain": string
    }
  },
  "listing_count": int,
  "full_address": string,
  "url_code": string
}

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.

Retrieve your listings

GET https://api.certn.co/api/v1/pm/listings/

View the details of all your listings.

The results are sent via paginated response, in chronological order. To retrieve the next page, send a request to the URL under the field next, or add one to your page counter:

https://api.certn.co/api/v2/listings/?page=<pgNum>

Query Parameters

NameTypeDescription

page

int

Page number to retrieve

application/json
[
  {
    "name": string,
    "unit": string,
    "move_in_date": string <dateTime>,
    "move_in_immediately": boolean,
    "rent": number,
    "security_deposit_amount": number,
    "pet_deposit": boolean,
    "pet_deposit_amount": number,
    "storage_locker": boolean,
    "property_manager_terms": string,
    "is_active": boolean,
    "is_public": boolean,
    "url-code": string,
    "property_id": string <uuid>,
    "owner_id": string <uuid>,
    "notification_list_ids": [
      string <uuid>
    ]
  }
]

Create a listing

POST https://api.certn.co/api/v2/listings/

Create a new listing with the information provided in the body of your request.

Request Body

NameTypeDescription

name

string

Listing manager's name

pet_deposit

boolean

security_deposit_amount

number

rent*

number

move_in_immediately

boolean

move_in_date

string

Move in date YYYY-MM-DD

unit

string

pet_deposit_amount

number

url-code

string

is_active

boolean

property_manager_terms

string

storage_locker

boolean

notification_list_ids*

Array of strings <uuid>

List of user id for users who should receive notifications

owner_id*

string <uuid>

Assign this listing to a specific user

property_id*

string <uuid>

application/json
{
  "id": string <uuid>,
  "created": string <date-time>,
  "modified": string <date-time>,
  "last_updated": string <date-time>,
  "name": string,
  "unit": string,
  "move_in_date": string <date-time>,
  "move_in_immediately": boolean,
  "rent": string,
  "rent_range": string,
  "security_deposit_amount": string,
  "pet_deposit": boolean,
  "pet_deposit_amount": string,
  "storage_locker": boolean,
  "property_manager_terms": string,
  "is_active": boolean,
  "is_public": boolean,
  "url_code": string,
  "is_placeholder": boolean,
  "owner": {
    "id": string <uuid>,
    "email": string,
    "team": {
      "id": string <uuid>,
      "name": string,
      "country": string,
      "industry": string,
      "team_type": string,
      "internal_name": string,
      "app_url": string,
      "compliance_region": {
        "id": string <uuid>,
        "name": string,
        "country": string <ISO Country Code>,
        "team_type": string,
        "sub_region": string,
        "default": boolean,
        "score_value_field": string,
        "score_label_field": string,
        "show_legal_us": boolean,
        "show_credit_report": boolean,
        "show_fcra": boolean,
        "require_address_history": boolean
      },
      "settings_config": {
        "get_org_name": string,
        "org_name": string,
        "org_logo_link": string,
        "org_primary_color": string,
        "whitelabel_report": boolean,
        "whitelabel_emails": boolean,
        "compact_pdf_report": boolean,
        "behavioural_test_req": boolean,
        "emergency_contact_req": boolean,
        "personal_ref_req": boolean,
        "education_req": boolean,
        "tenancy_years_amount_req": int,
        "tenancy_ref_amount_req": int,
        "tenancy_ref_email_req": boolean,
        "tenancy_ref_phone_req": boolean,
        "employer_years_amount_req": int,
        "employer_ref_req": boolean,
        "employer_ref_email_req": boolean,
        "employer_ref_phone_req": boolean,
        "document_required": boolean,
        "cover_letter_req": boolean,
        "government_id_req": boolean,
        "proof_of_income_req": boolean,
        "resume_req": boolean,
        "visa_req": boolean,
        "personal_ref_amount_req": int,
        "passport_req": boolean,
        "hide_detailed_financial": boolean,
        "hide_sin_ssn": boolean,
        "hide_date_of_birth": boolean,
        "enable_rcmp_reflow": boolean,
        "hide_id_verification_photos": boolean,
        "hide_current_address": boolean,
        "require_id_with_address": boolean,
        "hide_activity_log": boolean,
        "redirect_url": string,
        "custom_tracks": [],
        "my_crc_region": string,
        "hide_ssn_trace": boolean,
        "request_base": boolean,
        "request_behavioural": boolean,
        "request_softcheck": boolean,
        "request_equifax": boolean,
        "request_identity_verification": boolean,
        "request_enhanced_identity_verification": boolean,
        "request_criminal_record_check": boolean,
        "request_enhanced_criminal_record_check": boolean,
        "request_vulnerable_sector_criminal_record_check": boolean,
        "request_motor_vehicle_records": boolean,
        "request_education_verification": boolean,
        "request_employment_verification": boolean,
        "request_us_criminal_softcheck": boolean,
        "request_us_ssn_verification": boolean,
        "request_employer_references": boolean,
        "request_address_references": boolean,
        "request_employer_phone_references": boolean,
        "request_address_phone_references": boolean,
        "request_international_criminal_record_check": boolean,
        "request_soquij": boolean,
        "request_instant_verify_employment": boolean,
        "request_instant_verify_education": boolean,
        "request_instant_verify_credential": boolean,
        "employer_references_min": int,
        "employer_references_max": int,
        "address_references_min": int,
        "address_references_max": int,
        "employment_verification_min": int,
        "employment_verification_max": int,
        "education_verification_min": int,
        "education_verification_max": int,
        "credential_verification_min": int,
        "credential_verification_max": int,
        "credential_verification_level": string,
        "education_verification_level": string,
        "employer_references_years": int,
        "address_references_years": int,
        "employment_verification_years": int,
        "employment_verification_years_or_individually": string,
        "address_references_years_or_individually": string,
        "employer_references_years_or_individually": string,
        "us_criminal_record_check_years": int,
        "applicant_login": boolean,
        "exclude_softcheck_possible_matches": boolean,
        "workable_fast_complete": boolean,
        "review_all_negative_mvr_results": boolean,
        "limit_education_verifications": boolean
      },
      "billing_plan": {},
      "google_analytics_key": string,
      "adwords_key": string,
      "adwords_conversion_key": string,
      "external_domain": string,
    }
  },
  "property": {
    "id": string <uuid>,
  "status": string,
  "get_status_display": string,
  "created": string <date-time>,
  "modified": string <date-time>,
  "last_updated": string <date-time>,
  "building": string,
  "building_code": string,
  "address": string,
  "city": string,
  "province_state": string <ISO Code>,
  "country": string <ISO Country Code>,
  "postal_code": string,
  "is_active": boolean,
  "owner": {
    "id": string <uuid>,
    "email": string,
    "team": {
      "id": string <uuid>,
      "name": string,
      "country": string <ISO Country Code>,
      "industry": string,
      "team_type": string,
      "internal_name": string,
      "app_url": string,
      "compliance_region": {
        "id": string <uuid>,
        "name": string,
        "country": string <ISO Country Code>,
        "team_type": string,
        "sub_region": string,
        "default": boolean,
        "score_value_field": string,
        "score_label_field": string,
        "show_legal_us": boolean,
        "show_credit_report": boolean,
        "show_fcra": boolean,
        "require_address_history": boolean
      },
      "settings_config": {
        "get_org_name": string,
        "org_name": string,
        "org_logo_link": string,
        "org_primary_color": string,
        "whitelabel_report": boolean,
        "whitelabel_emails": boolean,
        "compact_pdf_report": boolean,
        "behavioural_test_req": boolean,
        "emergency_contact_req": boolean,
        "personal_ref_req": boolean,
        "education_req": boolean,
        "tenancy_years_amount_req": int,
        "tenancy_ref_amount_req": int,
        "tenancy_ref_email_req": boolean,
        "tenancy_ref_phone_req": boolean,
        "employer_years_amount_req": int,
        "employer_ref_req": boolean,
        "employer_ref_email_req": boolean,
        "employer_ref_phone_req": boolean,
        "document_required": boolean,
        "cover_letter_req": boolean,
        "government_id_req": boolean,
        "proof_of_income_req": boolean,
        "resume_req": boolean,
        "visa_req": boolean,
        "personal_ref_amount_req": int,
        "passport_req": boolean,
        "hide_detailed_financial": boolean,
        "hide_sin_ssn": boolean,
        "hide_date_of_birth": boolean,
        "enable_rcmp_reflow": boolean,
        "hide_id_verification_photos": boolean,
        "hide_current_address": boolean,
        "require_id_with_address": boolean,
        "hide_activity_log": boolean,
        "redirect_url": string,
        "custom_tracks": [],
        "my_crc_region": string,
        "hide_ssn_trace": boolean,
        "request_base": boolean,
        "request_behavioural": boolean,
        "request_softcheck": boolean,
        "request_equifax": boolean,
        "request_identity_verification": boolean,
        "request_enhanced_identity_verification": boolean,
        "request_criminal_record_check": boolean,
        "request_enhanced_criminal_record_check": boolean,
        "request_vulnerable_sector_criminal_record_check": boolean,
        "request_motor_vehicle_records": boolean,
        "request_education_verification": boolean,
        "request_employment_verification": boolean,
        "request_us_criminal_softcheck": boolean,
        "request_us_ssn_verification": boolean,
        "request_employer_references": boolean,
        "request_address_references": boolean,
        "request_employer_phone_references": boolean,
        "request_address_phone_references": boolean,
        "request_international_criminal_record_check": boolean,
        "request_soquij": boolean,
        "request_instant_verify_employment": boolean,
        "request_instant_verify_education": boolean,
        "request_instant_verify_credential": boolean,
        "employer_references_min": int,
        "employer_references_max": int,
        "address_references_min": int,
        "address_references_max": int,
        "employment_verification_min": int,
        "employment_verification_max": int,
        "education_verification_min": int,
        "education_verification_max": int,
        "credential_verification_min": int,
        "credential_verification_max": int,
        "credential_verification_level": string,
        "education_verification_level": string,
        "employer_references_years": int,
        "address_references_years": int,
        "employment_verification_years": int,
        "employment_verification_years_or_individually": string,
        "address_references_years_or_individually": string,
        "employer_references_years_or_individually": string,
        "us_criminal_record_check_years": int,
        "applicant_login": boolean,
        "exclude_softcheck_possible_matches": boolean,
        "workable_fast_complete": boolean,
        "review_all_negative_mvr_results": boolean,
        "limit_education_verifications": boolean
      },
      "billing_plan": {
      },
      "google_analytics_key": string,
      "adwords_key": string,
      "adwords_conversion_key": string,
      "external_domain": string
    }
  },
  "listing_count": int,
  "full_address": string,
  "url_code": string
  },
  "applicant_count": int,
  "new_applicant_count": int,
  "is_psychometric_required": boolean,
  "notification_list": [
    {
      "id": string <uuid>,
      "email": string,
      "team": {
        "id": string <uuid>,
        "name": string,
        "country": string <ISO Country Code>,
        "industry": string,
        "team_type": string,
        "internal_name": string,
        "app_url": string,
        "compliance_region": {
          "id": string <uuid>,
          "name": string,
          "country": string <ISO Country Code>,
          "team_type": string,
          "sub_region": string,
          "default": boolean,
          "score_value_field": string,
          "score_label_field": string,
          "show_legal_us": boolean,
          "show_credit_report": boolean,
          "show_fcra": boolean,
          "require_address_history": boolean
        },
        "settings_config": {
        "get_org_name": string,
        "org_name": string,
        "org_logo_link": string,
        "org_primary_color": string,
        "whitelabel_report": boolean,
        "whitelabel_emails": boolean,
        "compact_pdf_report": boolean,
        "behavioural_test_req": boolean,
        "emergency_contact_req": boolean,
        "personal_ref_req": boolean,
        "education_req": boolean,
        "tenancy_years_amount_req": int,
        "tenancy_ref_amount_req": int,
        "tenancy_ref_email_req": boolean,
        "tenancy_ref_phone_req": boolean,
        "employer_years_amount_req": int,
        "employer_ref_req": boolean,
        "employer_ref_email_req": boolean,
        "employer_ref_phone_req": boolean,
        "document_required": boolean,
        "cover_letter_req": boolean,
        "government_id_req": boolean,
        "proof_of_income_req": boolean,
        "resume_req": boolean,
        "visa_req": boolean,
        "personal_ref_amount_req": int,
        "passport_req": boolean,
        "hide_detailed_financial": boolean,
        "hide_sin_ssn": boolean,
        "hide_date_of_birth": boolean,
        "enable_rcmp_reflow": boolean,
        "hide_id_verification_photos": boolean,
        "hide_current_address": boolean,
        "require_id_with_address": boolean,
        "hide_activity_log": boolean,
        "redirect_url": string,
        "custom_tracks": [],
        "my_crc_region": string,
        "hide_ssn_trace": boolean,
        "request_base": boolean,
        "request_behavioural": boolean,
        "request_softcheck": boolean,
        "request_equifax": boolean,
        "request_identity_verification": boolean,
        "request_enhanced_identity_verification": boolean,
        "request_criminal_record_check": boolean,
        "request_enhanced_criminal_record_check": boolean,
        "request_vulnerable_sector_criminal_record_check": boolean,
        "request_motor_vehicle_records": boolean,
        "request_education_verification": boolean,
        "request_employment_verification": boolean,
        "request_us_criminal_softcheck": boolean,
        "request_us_ssn_verification": boolean,
        "request_employer_references": boolean,
        "request_address_references": boolean,
        "request_employer_phone_references": boolean,
        "request_address_phone_references": boolean,
        "request_international_criminal_record_check": boolean,
        "request_soquij": boolean,
        "request_instant_verify_employment": boolean,
        "request_instant_verify_education": boolean,
        "request_instant_verify_credential": boolean,
        "employer_references_min": int,
        "employer_references_max": int,
        "address_references_min": int,
        "address_references_max": int,
        "employment_verification_min": int,
        "employment_verification_max": int,
        "education_verification_min": int,
        "education_verification_max": int,
        "credential_verification_min": int,
        "credential_verification_max": int,
        "credential_verification_level": string,
        "education_verification_level": string,
        "employer_references_years": int,
        "address_references_years": int,
        "employment_verification_years": int,
        "employment_verification_years_or_individually": string,
        "address_references_years_or_individually": string,
        "employer_references_years_or_individually": string,
        "us_criminal_record_check_years": int,
        "applicant_login": boolean,
        "exclude_softcheck_possible_matches": boolean,
        "workable_fast_complete": boolean,
        "review_all_negative_mvr_results": boolean,
        "limit_education_verifications": boolean
      },
      "billing_plan": {
      },
      "google_analytics_key": string,
      "adwords_key": string,
      "adwords_conversion_key": string,
      "external_domain": string
    }
      }
    }
  ],
  "selected_application": {
    "is_selected": boolean,
    "applicants": []
  },
  "use_team_link": boolean,
  "length_of_lease": string
}

Examples

Invite an applicant
{
    "request_softcheck": true,
    "email": "qa2+testpm@certn.co",
    "owner_id" : "bd78a737-16cf-496a-9c3a-7b9e5533cfce"
    
}
Screen an applicant instantly
{
    "request_softcheck": true,
    "email": "qa2+pmsoftcheckQS@certn.co",
    "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"
}

Last updated

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 support@certn.co. ©2023 Certn.