request flags.md

For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

Request flags

Request flags

Flag Screen
request_base Informational Analysis (information_result)
request_softcheck /pages/-MbrlU9COwpTylPjhBNA (risk_result)
request_equifax /pages/-Mhu7i3qlJG7I92zFoQH (equifax_result)
request_enhanced_identity_verification /pages/-Mi88TmkehPnss5fTP3M (enhanced_identity_verification)
request_criminal_record_check
request_enhanced_criminal_record_check
/pages/-Mi8EDAjjmirZKJqut0r (rcmp_result)
request_soquij /pages/-MjAFvNYHpFNYS95fq8- (soquij_result)
request_social_media_check /pages/q2o9DidI5WrTaKYw7prM (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
/pages/-MiMb5j1QlkmkQIIomYJ (us_criminal_record_check_result)
request_right_to_work /pages/mG7q9lFzNqRGj7sycP2W (right_to_work_result)
request_uk_right_to_work /pages/TKfVNlP2XzXwMhjy2v5h (uk_right_to_work_check_result)
request_uk_basic_ds_check /pages/LULDjv0brH5O7p0w1glN (uk_basic_ds_check_result)
request_uk_basic_dbs_check /pages/CMXmGcSHvJMKFZXmR2yo (uk_basic_dbs_check_result)
request_international_criminal_record_check /pages/-MiMb6nZb56Vb2GWZNHg (international_criminal_record_check_result)
request_motor_vehicle_records /pages/-MiMtlGLdJoGEQw3DaYx (motor_vehicle_record_result)
request_employment_verification /pages/-MiMb8S9M3VgbvPqifPs (employment_verification)
request_education_verification /pages/-MiMb7jcob6QTeVLjboG (education_verification)
request_credential_verification /pages/tInoFFN7iXwDFTufuFo7 (credential_verification)
request_employer_references /pages/-MiMtmBEPdviGbOP_p5N (reference_result)
request_employer_phone_references /pages/-MiMtmBEPdviGbOP_p5N (reference_result)
request_address_references /pages/mjnNaJvE1mT8y8Ixj7vI (reference_result)
request_address_phone_references /pages/mjnNaJvE1mT8y8Ixj7vI (reference_result)

Credential Verification flags

Flag Type Note
credential_verification_level string 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 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 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