> 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/certn-api-v-1.0/guides/checks/credential-verification.md).

# Credential Verification

A credential verification validates a candidate's professional credential/license as entered by the candidate.

Certn makes 3-5 sufficient attempts to obtain source data for verification and reports back accordingly. A sufficient attempt can be defined as an attempt which could reasonably lead to a result.

### Availability

This check is available in **Canada** :flag\_ca: and the **US** :flag\_us:

This check is available for a [**quickscreen**](/api/certn-api-v-1.0/faq.md#what-is-a-quickscreen-and-how-do-i-use-it) :white\_check\_mark:

{% tabs %}
{% tab title="Canada" %}

| Industry            | Availability | Endpoints                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Human Resources     | Yes          | <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 | No           | <ul><li>Quickscreen <span data-gb-custom-inline data-tag="emoji" data-code="274c">❌</span></li><li>Invite <span data-gb-custom-inline data-tag="emoji" data-code="274c">❌</span></li></ul>                                                                                                                                         |
| {% endtab %}        |              |                                                                                                                                                                                                                                                                                                                                    |

{% tab title="US" %}

| Industry            | Availability | Endpoints                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Human Resources     | Yes          | <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 | No           | <ul><li>Quickscreen <span data-gb-custom-inline data-tag="emoji" data-code="274c">❌</span></li><li>Invite <span data-gb-custom-inline data-tag="emoji" data-code="274c">❌</span></li></ul>                                                                                                                                         |
| {% endtab %}        |              |                                                                                                                                                                                                                                                                                                                                    |
| {% endtabs %}       |              |                                                                                                                                                                                                                                                                                                                                    |

### Parameters

#### Request flag

Include this flag in the body of your request:

[`request_credential_verification`](/api/certn-api-v-1.0/api-reference/resources/application-parameters/request-flags.md)&#x20;

#### Optional flags

Set these flags explicitly, or leave them out to use your team's default settings:

`credential_verification_level`

`credential_verification_min`

`credential_verification_max`

See all [Request flags](/api/certn-api-v-1.0/api-reference/resources/application-parameters/request-flags.md#credential-verification-flags).

#### 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/certn-api-v-1.0/api-reference/resources/application-parameters.md)

#### Quickscreen parameters

To complete a quickscreen, include these parameters in the body of your request:&#x20;

* [`information`](/api/certn-api-v-1.0/api-reference/resources/application-parameters.md#information)&#x20;
  * `first_name`
  * `last_name`
  * `date_of_birth`
  * [`addresses`](/api/certn-api-v-1.0/api-reference/resources/application-parameters.md#address) (min 1)
  * [`credentials`](/api/certn-api-v-1.0/api-reference/resources/application-parameters.md#credential) (min 1)
* [`position_or_property_location`](/api/certn-api-v-1.0/api-reference/resources/application-parameters.md#specialization)&#x20;

{% hint style="warning" %}
Make sure to obtain the [proof of consent](/api/certn-api-v-1.0/guides/use-the-api/consent.md) from your applicant **before** running the quickscreen.
{% endhint %}

**Example request**

```json
    {
    "request_credential_verification": true,
    "email": "example@certn.co",
    "information": {
        "first_name": "Sebastien",
        "last_name": "Normandin",
        "date_of_birth": "1970-06-28",
        "addresses": [{
                "address": "4412 King Alfred Court",
                "city": "Victoria",
                "province_state": "BC",
                "country": "CA",
                "current": true
            }
        ],
        "credentials": [{
                "date_of_certification": "2020-08-21",
                "description": "PMP proves project leadership experience and expertise.",
                "certification": "Project Management Professional (PMP)",
                "institution": "Project Management Institute",
                "current": false
            }
        ]
    },
    "position_or_property_location": {
        "address": "Tiffany & Co., 97 Greene St",
        "city": "New York City",
        "county": "New York",
        "province_state": "NY",
        "country": "US",
        "postal_code": "10012",
        "location_type": "Position Location"
    }
}
```

### Report <a href="#static-sandbox-server-responses" id="static-sandbox-server-responses"></a>

Report field: `information.credentials`

Each credential verification object can be found under `information.credentials[index]`. See [Report field mappings](/api/certn-api-v-1.0/api-reference/resources/report-field-mappings.md#certn-verifications) for more.