Application parameters

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.
Main parameters
Parameter
Type
Note
tag
string
Group related applications by tag
email
string
​
phone_number
object (PhoneNumber)
​
information
object (Information)
​
Parameter objects
Address
Parameter
Type
Note
address
string
​
unit
string
​
city *
string
​
province_state *
string
​
country * 
string
​
postal_code *
string
​
rent_or_own
string <enum>
R, O, S 
​
Rent, Own, Staying with friends or family
cost
number
Monthly payment (rent, mortgage, etc.)
start_date
string <date>
​
end_date
string <date> nullable
​
certn_verification
string <enum>
​Enums (Verification)
verification_notes
string
Notes supplementing the certn_verification field results
address_reference
object (Reference)
​
BaseAddress
Parameter
Type
Note
address
string
​
unit
string
​
city *
string
​
province_state *
string
​
country *
string
​
postal_code
string
​
Contact
Parameter
Type
Note
can_contact
boolean
Can the person be contacted?
can_contact_after_date
string <date>
​
Conviction
Parameter
Type
Note
offence *
string
Conviction code in the Criminal Code of Canada​
​
date_of_sentence *
string <date>
Conviction date YYYY-MM-DD
court_location *
string
Sentencing court as city, province, country
description *
string
Description of the offense
Credential
Parameter
Type
Note
date_of_certification *
string <date>
YYYY-MM-DD
certification *
string
Certification title
institution *
string
​
description *
string
Description of the certification
current *
boolean
Currently (in the process of) obtaining it: TRUE
Already obtained: FALSE
highest_level
string
Determine the highest level for Certn to verify

Use with credential_verification_level: HIGHEST
Degree
Parameter
Type
Note
degree
string <date>
​
verified
boolean <date> nullable
​
Education
Parameter
Type
Note
institution *
string
​
degree *
object (Degree)
​
current *
boolean
Currently (in the process of) obtaining it: TRUE
Already obtained: FALSE
start_date *
string <date>
YYYY-MM-DD
end_date *
string <date> nullable
YYYY-MM-DD

Not required if current = TRUE
specializations *
object (Specialization)
​
address
object (BaseAddress)
​
highest_level
string
Determine the highest level for Certn to verify

Use with education_verification_level: HIGHEST
Education Verification Notes
Parameter
Type
Note
certn_verification
string <enum>
​Enums (Verification)
verification_notes
string
Notes supplementing the certn_verification field results
Employer
Parameter
Type
Note
company_name *
string
​
position *
string
​
income 
number
​
pay_period 
string <enum>
PER_HOUR, PER_MONTH, PER_YEAR, BIWEEKLY, BIMONTHLY
​
Default: PER_YEAR
start_date
string <date>
​
end_date
string <date> nullable
​
certn_verification
string <enum>
​Enums(Verification)
verification_notes
string
Notes supplementing the certn_verification field results
employer_reference
object (Reference)
​
Email
Parameter
Type
Note
address
string
Required for email references
EnhancedIdentityVerification
Parameter
Type
Note
id_country *
string
​ISO country code​
id_type *
string <enum>
PASSPORT, DRIVING_LICENSE, ID_CARD, VISA
face_image *
string
Base64 encoded selfie. Accepts JPEG or PNG. 
​
Size: <10MB
Sides: <8000 pixels per side longest >300 pixels
id_frontside_image *
string
Base64 encoded image of the ID's front.
Accepts JPEG or PNG.
​
Size: <10MB
Sides: <8000 pixels per side, longest >300 pixels
id_backside_image
string
Base64 encoded image of the ID's back.
Accepts JPEG or PNG.
​
Size: <10MB
Sides: <8000 pixels per side, longest >300 pixels
Information
Parameter
Type
Note
first_name *
string
​
middle_name
string
​
last_name *
string
​
last_name_at_birth
string
​
former_names
string
​
alias
string
​
date_of_birth *
string <date>
YYYY-MM-DD
phone_number
string	
Non-numerical characters will be removed
sin_ssn
string
Social Insurance Number / Social Security Number
gender
string <enum>
M, F
Required for Canadian Criminal Record Checks​
birth_city
string
​
birth_province_state
string
​ISO province or state code​
birth_other_province_state
string
Province or state if outside Canada or US
birth_country
string
​ISO country code​
license_number
string
​
license_valid
boolean
​
license_province_state
string
​ISO province or state code 
license_other_country
boolean nullable
Is the license from the same country as the applicant's residential country?
license_type
string <enum>
CA, US, INTERNATIONAL, NONE
cover_letter
string
​
Name
Parameter
Type
Note
first_name *
string
​
middle_name
string
​
last_name *
string
​
PhoneNumber
Parameter
Type
Note
phone_type
string <enum>
NONE, WORK, HOME, CELL, OTHER
number
string
​
country
string
​ISO country code​
Reference
Parameter
Type
Note
email
object (Email)
​
phone_number
object (PhoneNumber)
​
name
object (Name)
​
contact
object (Contact)
​
Specialization
Parameter
Type
Note
specialization
string
Name of the specialization
Enums
Verification
VERIFIED
SYSTEM 
UNABLE TO VERIFY
VERIFICATION PENDING
UPGRADE TO VERIFY
PARTIALLY VERIFIED
UNVERIFIED
NONE