For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

Credit Check

Canadian Credit Report

This Equifax Credit Report includes information on an individual's credit activity and current credit situation. Reports may include tradelines, bankruptcies, public records, collection information, and a credit score. A credit report request for employment or tenancy purposes will appear as an inquiry on the individual’s credit file. Note that this type of inquiry will not impact the individual’s credit score.

US Equifax Report

A USA Credit Report includes information on an individual's credit activity and overall financial health. Reports may include tradelines, bankruptcies, public record and collection information, and a *credit score. A credit report request will appear as an inquiry on the individual’s credit file but will not impact the individual's credit score.

**Note: Credit scores do not appear on reports related to employment.*

Availability

This check is available in Canada :flag_ca: and the US :flag_us:

This check is available for a quickscreen :white_check_mark:

Canada

US

Parameters

Request flag

Include this flag in the body of your request:

request_equifax

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:

• information
  • first_name
  • last_name
  • date_of_birth
  • addresses (min 1 - Canada or US)
  • sin_ssn (see note)
• position_or_property_location

Example request

Canada

{
    "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",
                "postal_code": "V8V4F4",
                "current": true
            }
        ],
        "sin_ssn": "1234567890"
    },
    "position_or_property_location": {
        "address": "2680 Blanshard St Unit 3",
        "city": "Victoria",
        "province_state": "BC",
        "country": "CA",
        "postal_code": "V8T5E1",
        "location_type": "Position Location"
    }
}

US

{
    "request_equifax": true,
    "information": {
        "first_name": "Patricia",
        "last_name": "Eerat",
        "date_of_birth": "1970-06-28",
        "addresses": [{
                "address": "3601 West Belleview Avenue",
                "city": "Littleton",
                "county": "Arapahoe",
                "province_state": "CO",
                "country": "US",
                "postal_code": "80123",
                "current": true
            }
        ],
        "sin_ssn": "1234567890"
    },
    "position_or_property_location": {
        "address": "71 Post",
        "city": "Irvine",
        "county": "Orange",
        "province_state": "CA",
        "country": "US",
        "postal_code": "92618",
        "location_type": "Position Location"
    }
}

Report

Report field: equifax_result

Find errors in credit_file_metadatas, under equifax_result.

Test data

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

Review