Application parameters
Certn API parameters for how to request checks, collect information and generate reports.
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. All other parameters are optional.
Run a quick screen
Provide the required parameters for each of your checks, along with the appropriate Request flags. Find the required parameters for specific checks in their page under Run a check.
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 |
---|---|---|
| string | Group related applications by tag |
| string | |
| object | Include country code to invite the applicant via SMS (Example: 12507897897) |
| object (Information) |
Check-specific parameter | Type | Note |
---|---|---|
| object (Position or Property Location) | |
| string <enum> | |
| Array of strings | |
| object (Social Media Details) |
Parameter objects
Address
Parameter | Type | Note |
---|---|---|
| string | |
| string | |
| string | |
| string | Required for US addresses. Omit or provide "" for countries other than US. |
| string | |
| string | |
| string | |
| string <enum> |
Rent, Own, Staying with friends or family |
| number | Monthly payment (rent, mortgage, etc.) |
| string <date> | |
| string <date> | Provide if address is not current, i.e. |
| boolean | If this is the current address: Although not recommended, if a value for |
| string <enum> | |
| string | Notes supplementing the |
| object (Address Reference) |
Address Reference
Parameter | Type | Note |
---|---|---|
| object (Email) | |
| object (PhoneNumber) | |
| object (Name) |
Base Address
Parameter | Type | Note |
---|---|---|
| string | |
| string | |
| string | |
| string | Required for US addresses. Omit or provide "" for countries other than US. |
| string | |
| string | |
| string |
Conviction
Parameter | Type | Note |
---|---|---|
| string | |
| string <date> | Conviction date |
| string | Sentencing court as city, province, country |
| string | Description of the offense |
Credential
Parameter | Type | Note |
---|---|---|
| string <date> |
|
| string | Certification title |
| string | |
| string | Description of the certification |
| boolean | Currently (in the process of) obtaining it: Already obtained: |
| string | Determine the highest level for Certn to verify
Use with |
Degree
Parameter | Type | Note |
---|---|---|
| string <date> | |
| boolean <date> |
Education
Parameter | Type | Note |
---|---|---|
| string | |
| object (Degree) | |
| boolean | Currently (in the process of) obtaining it: |
| string <date> |
|
| string <date> |
|
| string | Determine the highest level for Certn to verify
Use with |
| object (Specialization) | |
| object (Base Address) | Address of the institution |
Education verification notes
Parameter | Type | Note |
---|---|---|
| string <enum> | |
| string | Notes supplementing the |
Employer
Parameter | Type | Note |
---|---|---|
| string | |
| string | |
| number | |
| string <enum> |
Default: |
| string <date> | |
| string <date> | |
| string | First name of the employer reference Used for reference checks |
| string | Last name of the employer reference Used for reference checks |
| string | Position of the employer reference Used for reference checks |
| string | Email for the employer reference Used for reference checks |
| string | Phone number for the employer reference Used for reference checks |
| boolean | Can Certn contact this reference? Used for reference checks |
Employer verification notes
Parameter | Type | Note |
---|---|---|
| string <enum> | |
| string | Notes supplementing the |
Employer References
Parameter | Type | Note |
---|---|---|
| string | Company of the employer reference |
| string | The position of the applicant when they worked for the company |
| string <date> |
|
| string <date> |
|
| string | Reference's first name |
| string | Reference's last name |
| string | The position held by the reference at the company |
| string | Relationship between the reference and the applicant. e.g. supervisor, manager, etc. |
| string | The reference's email address. Required for email references. |
| string | The reference's phone number. Required for phone references. |
Email
Parameter | Type | Note |
---|---|---|
| string | Required for email references |
Enhanced Identity Verification
Parameter | Type | Note |
---|---|---|
| string | |
| string <enum> |
|
| string | Base64 encoded selfie. Accepts Size: <10MB Sides: <8000 pixels per side longest >300 pixels |
| string | Base64 encoded image of the ID's front. Accepts Size: <10MB Sides: <8000 pixels per side, longest >300 pixels |
| string | Base64 encoded image of the ID's back. Accepts Size: <10MB Sides: <8000 pixels per side, longest >300 pixels |
| string | Valid URL. Optional when using the redirect URL. Size: <= 200 characters |
Information
Parameter | Type | Note |
---|---|---|
| string | |
| string | |
| string | |
| string | |
| string | |
| string | |
| string <date> |
|
| string | Non-numerical characters will be removed |
| string | Social Insurance Number / Social Security Number |
| string <enum> | Required when running a Canadian Criminal Record Check
Available values: |
| string | |
| string | |
| string | Province or state if outside Canada or US |
| string | |
| string | |
| boolean | |
| string | |
| boolean | Is the license from the same country as the applicant's residential country? |
| string <enum> |
|
| string | |
| Array of object (Address) | |
| Array of object (Employer) | |
| Array of object (Education) | |
| Array of object (Credential) | |
| Array of object (Conviction) |
Name
Parameter | Type | Note |
---|---|---|
| string | |
| string | |
| string |
Phone Number
Parameter | Type | Note |
---|---|---|
| string <enum> |
|
| string | |
| string |
Position or Property Location
The parameters to use for position_or_property_location
will depend on your location_type
.
If you're in the Gig economy and the position you're hiring for won't be tied to a single location, use this parameter:
Parameter | Type | Note |
---|---|---|
| string <enum> | HR: Not available to PM |
For any other industries, use these ones:
Parameter | Type | Note |
---|---|---|
| string <enum> | HR: PM: |
| string | |
| string | |
| string | |
| string | |
| string | US only |
Purpose of check (Basic Disclosure And Barring Service Check)
Parameter | Type | Note |
---|---|---|
| string <enum> | |
| string |
Social Media Details
Parameter | Type | Note |
---|---|---|
| string | Name of the high school |
| string | Name of the college |
| string | Twitter URL or handle |
| string | Facebook URL or handle |
| string | Instagram URL or handle |
| string | LinkedIn URL or handle |
| string | Tiktok URL or handle |
| string | Reddit URL or handle |
Specialization
Parameter | Type | Note |
---|---|---|
| string | Name of the specialization |
Last updated