Request flags

Request flags

Flag	Screen
request_base	Informational Analysis (information_result)
request_softcheck	Softcheck (risk_result)
request_equifax	Credit Check(equifax_result)
request_enhanced_identity_verification	Enhanced Identity Verification (enhanced_identity_verification)
request_criminal_record_check request_enhanced_criminal_record_check	Canadian Criminal Record Check (rcmp_result)
request_soquij	SOQUIJ (soquij_result)
request_social_media_check	Social Media Check (social_media_check_result)
request_us_criminal_record_check_tier_1 request_us_criminal_record_check_tier_2 request_us_criminal_record_check_tier_3	US Criminal Record Check (us_criminal_record_check_result)
request_right_to_work	Australia Right To Work Check (right_to_work_result)
request_uk_right_to_work	UK Right To Work Check(uk_right_to_work_check_result)
request_uk_basic_ds_check	Basic Disclosure Scotland Check(uk_basic_ds_check_result)
request_uk_basic_dbs_check	Basic Disclosure And Barring Service Check(uk_basic_dbs_check_result)
request_international_criminal_record_check	International Criminal Record Check (international_criminal_record_check_result)
request_motor_vehicle_records	Motor Vehicle Record Check / Driver's Abstract (motor_vehicle_record_result)
request_employment_verification	Employment Verification (employment_verification)
request_education_verification	Education Verification (education_verification)
request_credential_verification	Credential Verification (credential_verification)
request_employer_references	Employment Reference Check (reference_result) Mutually exclusive with request_employer_phone_references. *Requires employer_questionaire_id.
request_employer_phone_references	Employment Reference Check (reference_result) Mutually exclusive with request_employer_phone_references. *Requires employer_questionaire_id.
request_address_references	Address Reference Check (reference_result) Mutually exclusive with request_employer_references. *Requires employer_questionaire_id.
request_address_phone_references	Address Reference Check (reference_result) Mutually exclusive with request_address_references. *Requires address_questionaire_id.

Credential Verification flags

Flag	Type	Note
credential_verification_level	string <enum>	One of: ALL, HIGHEST All credentials listed / Highest level credential listed Use with highest_level
credential_verification_min	int	Minimum number of credentials to verify number < credential_verification_max
credential_verification_max	int	Maximum number of credentials to verify number > credential_verification_min

Education Verification flags

Flag	Type	Note
education_verification_level	string <enum>	ALL, HIGHEST All credentials listed / Highest level credential listed Use with highest_level
education_verification_min	int	Minimum number of educations to verify number < education_verification_max
education_verification_max	int	Maximum number of educations to verify number > education_verification_min

Employment Reference flags

Flag	Type	Note
employer_reference_years_or_individually	string <enum>	YEARS, INDIVIDUALLY All employers for the past x years / Specific number of employers (>= min, <= max)
employer_references_years	int	3, 5 or 7 Use when years_or_individually = YEARS
employer_references_min	int	Minimum number of employer references to contact number <= employer_references_max Use when employer_reference_years_or_individually = INDIVIDUALLY
employer_references_max	int	Maximum number of employer references to contact number >= employer_references_min Use when employer_reference_years_or_individually = INDIVIDUALLY