For the complete documentation index, see [llms.txt](https://docs.certn.co/api/llms.txt). This page is also available as [Markdown](https://docs.certn.co/api/api-reference/resources/application-parameters.md).

This article lists all the parameters available when making `PUT` or `POST` calls to the `/applicants` endpoints.

## **Invite an applicant**  
Provide the applicant's email address, along with the appropriate [Request flags](https://docs.certn.co/api/api-reference/resources/application-parameters/request-flags). All other parameters are optional.

## **Run a quick screen**  
Provide the required parameters for each of your checks, along with the appropriate [Request flags](https://docs.certn.co/api/api-reference/resources/application-parameters/request-flags). Find the required parameters for specific checks in their page under [Run a check](https://docs.certn.co/api/guides/checks).

An asterisk (*) next to a parameter name indicates that it's a required parameter within that object. The API will throw an error if the object is present but the parameter is missing.

## Main parameters
| Parameter                 | Type   | Note                                                                                      |
|---------------------------|--------|-------------------------------------------------------------------------------------------|
| `tag`                     | string | Group related applications by tag                                                        |
| `email`                   | string |                                                                                           |
| `phone_number`           | object | Include country code to invite the applicant via SMS _(Example: 12507897897)_            |
| `information`             | object | Check-specific parameter                                                                   |

## Parameter objects
### Address
| Parameter                     | Type   | Note                                                                                      |
|-------------------------------|--------|-------------------------------------------------------------------------------------------|
| `address`                     | string |                                                                                           |
| `unit`                        | string |                                                                                           |
| `city` *                     | string |                                                                                           |
| `county` *                   | string | Required for US addresses. Omit or provide "" for countries other than US.
| `province_state` *           | string |                                                                                           |
| `country` *                  | string |                                                                                           |
| `postal_code` *              | string |                                                                                           |
| `rent_or_own`                | string | `R`, `O`, `S` Rent, Own, Staying with friends or family                                    |
| `cost`                       | number | Monthly payment (rent, mortgage, etc.)                                                   |
| `start_date`                 | string | `YYYY-MM-DD`                                                                               |
| `end_date`                   | string | `YYYY-MM-DD` `nullable` Provide if address is not current, i.e. `current` is `false`.    |
| `current` *                  | boolean| If this is the current address: `true`. Although not recommended, if a value for `current` is **not** specified, `end_date` will be used to determine if the address is current.
| `certn_verification`         | string | [Application parameters](https://docs.certn.co/api/api-reference/resources/application-parameters#enums) ( [Application parameters](https://docs.certn.co/api/api-reference/resources/application-parameters#verification)) |
| `verification_notes`         | string | Notes supplementing the `certn_verification` field results                                |

### Enhanced Identity Verification
| Parameter                     | Type   | Note                                                                                      |
|-------------------------------|--------|-------------------------------------------------------------------------------------------|
| `id_country` *               | string | [ISO country code](https://docs.certn.co/api/api-reference/resources/region-codes)       |
| `id_type` *                  | string | `PASSPORT`, `DRIVING_LICENSE`, `ID_CARD`, `VISA`                                        |
| `face_image` *               | string | Base64 encoded selfie. Accepts `JPEG` or `PNG`. Size: <10MB                               |
| `id_frontside_image` *       | string | Base64 encoded image of the ID's front. Accepts `JPEG` or `PNG`. Size: <10MB             |
| `id_backside_image`          | string | Base64 encoded image of the ID's back. Accepts `JPEG` or `PNG`. Size: <10MB              |
| `on_success_url`             | string | Valid URL. Optional when using the redirect URL. Size: <= 200 characters                  |

### Employer
| Parameter                     | Type   | Note                                                                                      |
|-------------------------------|--------|-------------------------------------------------------------------------------------------|
| `company_name` *             | string |                                                                                           |
| `position` *                 | string |                                                                                           |
| `income`                     | number |                                                                                           |
| `pay_period`                 | string | `PER_HOUR`, `PER_MONTH`, `PER_YEAR`, `BIWEEKLY`, `BIMONTHLY` Default: `PER_YEAR`       |
| `start_date`                 | string | `YYYY-MM-DD`                                                                               |
| `end_date`                   | string | `YYYY-MM-DD` `nullable`                                                                    |
| `contact_first_name`         | string | First name of the employer reference used for reference checks                             |
| `contact_last_name`          | string | Last name of the employer reference used for reference checks                              |
| `contact_position`            | string | Position of the employer reference used for reference checks                               |
| `contact_email`               | string | Email for the employer reference used for reference checks                                 |
| `contact_phone`              | string | Phone number for the employer reference used for reference checks                         |
| `can_contact`                | boolean| Can Certn contact this reference used for reference checks?                               |

### Social Media Details
| Parameter                     | Type   | Note                                                                                      |
|-------------------------------|--------|-------------------------------------------------------------------------------------------|
| `high_school_name`           | string | Name of the high school                                                                   |
| `college_name`               | string | Name of the college                                                                       |
| `twitter_url`                | string | Twitter URL or handle                                                                     |
| `facebook_url`               | string | Facebook URL or handle                                                                    |
| `instagram_url`              | string | Instagram URL or handle                                                                   |
| `linkedin_url`               | string | LinkedIn URL or handle                                                                    |
| `tiktok_url`                 | string | Tiktok URL or handle                                                                      |
| `reddit_url`                 | string | Reddit URL or handle                                                                      |