Package settings

Package settings are optional settings which relate to types of checks. These can be defined when running a check or when setting up a package of checks to run later.

Package settings

settings field		Relevant Check	Notes
requested_countries	list [string]	International Criminal Record Check	optional, default superteam country. Accepts ISO country code format.
us_criminal_record_check_years	int	US Criminal Record Check	optional, default team setting
employer_questionaire_id	string <uuid>	Employment Reference Check	optional
employer_references_min	int	Employment Reference Check	optional, default 1
employer_references_max	int	Employment Reference Check	optional, default 1
employer_references_years	int	Employment Reference Check	optional, default 3
employer_references_years_or_individually	string <Enum>	Employment Reference Check	optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"
address_questionaire_id	string <uuid>	Address Reference Check	optional
address_references_min	int	Address Reference Check	optional, default 1
address_references_max	int	Address Reference Check	optional, default 1
address_references_years	int	Address Reference Check	optional, default 3
address_references_years_or_individually	string <Enum>	Address Reference Check	optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"
employment_verification_min	int	Employment Verification	optional, default 1
employment_verification_max	int	Employment Verification	optional, default 1
employment_verification_years	int	Employment Verification	optional, default 3
employment_verification_years_or_individually	string <Enum>	Employment Verification	optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"
education_verification_min	int	Education Verification	optional, default 1
education_verification_max	int	Education Verification	optional, default 1
education_verification_level	string <Enum>	Education Verification	optional, default "ALL". One of: "ALL", or "HIGHEST".
credential_verification_min	int	Credential Verification	optional, default 1
credential_verification_max	int	Credential Verification	optional, default 1
credential_verification_level	string <Enum>	Credential Verification	optional, default "ALL". One of: "ALL", or "HIGHEST".
volunteer_role			optional, default ""
volunteer_organization			optional, default ""
role_or_position_title	string	Basic Disclosure And Barring Service Check	optional, default ""
employment_sector	string <Enum>	Basic Disclosure And Barring Service Check	optional, one of #employment_sector-values