Links

Credit Check

Canadian Credit Report
A Canadian Credit Report is an inquiry of an applicant's credit file. Reports include tradelines, bankruptcies, public record and collection information, and a credit score.
US Equifax Report
A US Equifax Report is a soft inquiry of an applicant's credit file. Reports include tradelines, bankruptcies, public record and collection information, and a credit score*.
*Credit scores do not appear on reports related to employment for US Equifax Reports.

Availability

This check is available in Canada
🇨🇦
and the US
🇺🇸
This check is available for a quickscreen
Canada
US
Industry
Availability
Endpoints
Human Resources
Available on demand
Property Management
Available on demand
Industry
Availability
Endpoints
Human Resources
Available on demand
Property Management
Available on demand
This check isn't available by default. Contact our support team to enable it on your account.

Parameters

Request flag

Include this flag in the body of your request:

Invite parameters

To invite an applicant to complete a screen, include this parameter in the body of your request:
  • email
See all available Application parameters

Quickscreen parameters

To complete a quickscreen, include these parameters in the body of your request:
    • first_name
    • last_name
    • date_of_birth
    • addresses (min 1 - Canada or US)
    • sin_ssn (see note)
Make sure to obtain the proof of consent from your applicant before running the quickscreen.
When running a quickscreen, we strongly recommend you include your applicant's Social Insurance Number or Social Security Number (sin_ssn). This will help ensure that your request is completed without delays.

Example request

{
"request_equifax": true,
"information": {
"first_name": "Andrew",
"last_name": "McLeod",
"date_of_birth": "1970-06-28",
"addresses": [{
"address": "1006 Fort Street",
"city": "Victoria",
"province_state": "BC",
"country": "CA"
}
],
"sin_ssn": "1234567890"
}
}

Report

Report field: equifax_result
Find errors in credit_file_metadatas, under equifax_result.

Test data

Before running your first check, contact our support team to have us setup your demo account.
Send Credit Check requests with the following sets of data on our demo environment to retrieve our pre-filled reports. You can add a placeholder SIN/SSN and DOB.
Clear
First name
Last name
Address
Country
Andrew
McLeod
1006 Fort Street Victoria BC CA V8V4F4
CAN
Patricia
Eerat
3601 West Belleview Avenue Littleton CO US 80123
USA
Review
First name
Last name
Address
Country
Will
Nettke
3601 West Belleview Avenue Littleton CO US 80123
USA