### Availability

This check is available in **Canada** 🇨🇦and the **US** 🇺🇸

This check is available for a [**quickscreen**](https://docs.certn.co/api/faq#what-is-a-quickscreen-and-how-do-i-use-it)✅

| Industry          | Availability | Endpoints                                                                                               |
|-------------------|--------------|---------------------------------------------------------------------------------------------------------|
| Human Resources    | Yes          | - [Quickscreen](https://docs.certn.co/api/api-reference/hr#screen-an-applicant-instantly)✅<br>- [Invite](https://docs.certn.co/api/api-reference/hr#invite-an-applicant)📩 |
| Property Management | Yes          | - [Quickscreen](https://docs.certn.co/api/api-reference/pm#screen-an-applicant-instantly)✅<br>- [Invite](https://docs.certn.co/api/api-reference/pm#invite-an-applicant)📩 |

### **Parameters**

#### Request flag

Include this flag in the body of your request:

[`request_enhanced_identity_verification`](https://docs.certn.co/api/api-reference/resources/application-parameters/request-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](https://docs.certn.co/api/api-reference/resources/application-parameters)

#### Quickscreen parameters

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

- [`information`](https://docs.certn.co/api/api-reference/resources/application-parameters#information)
  - `first_name`
  - `last_name`
  - `date_of_birth`
  - [`addresses`](https://docs.certn.co/api/api-reference/resources/application-parameters#address) (min 1)
- [`position_or_property_location`](https://docs.certn.co/api/api-reference/resources/application-parameters#position-or-property-location)

Provide these additional documents as proof of identity:

- A recent unaltered selfie
- The front and back of a government-issued ID

Each picture must follow these rules:

- Picture size is < 10MB
- Longest side is > 300 pixels
- Each side is < 8000 pixels

Make sure to obtain the [proof of consent](https://docs.certn.co/api/guides/use-the-api/consent) from your applicant **before** running the quickscreen.

Add the documents in your original request.

Ask your applicant to upload the documents via redirect URL.

Submit the required documents via these fields:

- [`enhanced_identity_verification`](https://docs.certn.co/api/api-reference/resources/application-parameters#enhancedidentityverificationdirectupload)
  - `id_country`
  - `id_type`
  - `id_frontside_image`
  - `id_backside_image` (not required for PASSPORT type)
  - `face_image`

Send your images as [base64](https://en.wikipedia.org/wiki/Base64) encoded objects.

#### Example request with required documents

```
{
    "request_enhanced_identity_verification": true,
    "information": {
        "first_name": "Andrew",
        "last_name": "McLeod",
        "addresses": [{
                "address": "4412 King Alfred Court",
                "city": "Victoria",
                "province_state": "BC",
                "country": "CA",
                "current": true
            },
        ],
    },
    "enhanced_identity_verification": {
        "id_country": "CA",
        "id_type": "DRIVING_LICENSE",
        "id_frontside_image": "<base64 encoded image>",
        "id_backside_image": "<base64 encoded image>",
        "face_image": "<base64 encoded image>"
    },
    "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"
    }
}
```

The following configuration will be in effect starting March 1, 2023:

1. Send your request with the main quickscreen parameters
   - You have the option to include the `on_success_url` parameter in your request to redirect your applicant to your preferred URL when they complete their verification flow.
     - [`enhanced_identity_verification`](https://docs.certn.co/api/api-reference/resources/application-parameters#enhancedidentityverificationdirectupload)
       - `on_success_url`
   - If you don't provide the `on_success_url` parameter in your request, your applicant will be directed to a default [thank you page](https://app.certn.co/thank-you) when they complete their verification flow.

2. In the response, find `enhanced_identity_verification`.
3. Copy the value of `redirect_url`.
4. Share the redirect URL with your applicant.
5. Ask your applicant to complete the verification flow via the provided URL.

Certn will proceed with the identity verification once your applicant has successfully uploaded their documents.

If you're embedding this in an iframe, [contact our support team](https://docs.certn.co/api/contact#api) to provide the domain in which it will be embedded.