For the complete documentation index, see [llms.txt](https://docs.certn.co/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.certn.co/api/guides/checks/credit-check.md).

# 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**](/api/faq.md#what-is-a-quickscreen-and-how-do-i-use-it) :white_check_mark:

### Canada

| Industry            | Availability        | Endpoints                                                                                                                                                                                                                                                                                                                           |
| ------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Human Resources     | Available on demand | <ul><li><a href="/pages/-MbrCkyOdi6Adm9PH1HY#screen-an-applicant-instantly">Quickscreen</a> <span data-gb-custom-inline data-tag="emoji" data-code="2705">✅</span></li><li><a href="/pages/-MbrCkyOdi6Adm9PH1HY#invite-an-applicant">Invite</a> <span data-gb-custom-inline data-tag="emoji" data-code="1f4e9">📩</span></li></ul>  |
| Property Management | Available on demand | <ul><li><a href="/pages/-Mb83vFKzR1AeH-VfJKp#screen-an-applicant-instantly">Quickscreen</a> <span data-gb-custom-inline data-tag="emoji" data-code="2705">✅</span> </li><li><a href="/pages/-Mb83vFKzR1AeH-VfJKp#invite-an-applicant">Invite</a> <span data-gb-custom-inline data-tag="emoji" data-code="1f4e9">📩</span></li></ul> |

### US

| Industry            | Availability        | Endpoints                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Human Resources     | Available on demand | <ul><li><a href="/pages/-MbrCkyOdi6Adm9PH1HY#screen-an-applicant-instantly">Quickscreen</a> <span data-gb-custom-inline data-tag="emoji" data-code="2705">✅</span></li><li><a href="/pages/-MbrCkyOdi6Adm9PH1HY#invite-an-applicant">Invite</a> <span data-gb-custom-inline data-tag="emoji" data-code="1f4e9">📩</span></li></ul> |
| Property Management | Available on demand | <ul><li><a href="/pages/-Mb83vFKzR1AeH-VfJKp#screen-an-applicant-instantly">Quickscreen</a> <span data-gb-custom-inline data-tag="emoji" data-code="2705">✅</span></li><li><a href="/pages/-Mb83vFKzR1AeH-VfJKp#invite-an-applicant">Invite</a> <span data-gb-custom-inline data-tag="emoji" data-code="1f4e9">📩</span></li></ul> |

### Parameters

#### Request flag

Include this flag in the body of your request:

[`request_equifax`](/api/api-reference/resources/application-parameters/request-flags.md)

#### 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](/api/api-reference/resources/application-parameters.md)

#### Quickscreen parameters

To complete a quickscreen, include these parameters in the body of your request:

* [`information`](/api/api-reference/resources/application-parameters.md#information)
  * `first_name`
  * `last_name`
  * `date_of_birth`
  * [`addresses`](/api/api-reference/resources/application-parameters.md#address)  (min 1 - **Canada** or **US**)
  * `sin_ssn` (see note)
* [`position_or_property_location`](/api/api-reference/resources/application-parameters.md#specialization)

#### Example request

### Canada

```json
{
    "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

```json
{
    "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`](/api/api-reference/resources/report-field-mappings.md#credit-check)

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](/api/start/demo-account.md) to retrieve our pre-filled reports. You can add a placeholder SIN/SSN and DOB.

**Clear**

| First name | Last name | Personal information | Address                                                                        | Country |
| ---------- | --------- | ------------------- | ------------------------------------------------------------------------------ | ------- |
| Andrew     | McLeod    | DOB: 1984-03-04<br>SIN: 321321321  | 1006 Fort Street Victoria BC CA V8V4F4                                         | Canada  |
| Patricia   | Eerat     | DOB: 1984-03-04<br>SIN: 321321321  | 3601 West Belleview Avenue Littleton Arapahoe CO US 80123                    | US      |

**Review**

| First name | Last name | Personal information                     | Address                                                                        | Country |
| ---------- | --------- | ---------------------------------------- | ------------------------------------------------------------------------------ | ------- |
| Will       | Nettke    | DOB: 2000-01-01<br>SIN: 123123123      | 1006 Fort Street Victoria BC CA V8V4F4                                         | Canada  |
| Will       | Nettke    | DOB: 2000-01-01<br>SIN: 123123123      | 3601 West Belleview Avenue Littleton Arapahoe CO US 80123                    | US      |