Package data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
Unique identifier for the verification type
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring required
Name of the verification type
type enum required
Valid values:
"IDENTITY_VERIFICATION"
"SCREENING"
"BACKGROUND_CHECK"
"EMPLOYMENT_VERIFICATION"
"EDUCATION_VERIFICATION"
aliasesstring array
tagsstring array
Category (Verification, Validation, Background Check)
descriptionstring
Detailed description
parameters array
Questions that need to be answered for this verification
average_processing_times array
average processing time in minutes
has_redirect_urlboolean
has_target_urlboolean
where the provider will redirect the user to after the verification
needs_ip_addressboolean
cost_amountnumber
Cost-related information
currencystring
max_scorenumber
if this verification returns a score, what is the maximum?
info_urlstring
where to find additional information
valid_regionsstring array
{country}-{state/province/territory} or just {country} 2-digit ISO codes
Are we missing anything? Let us know
Was this page helpful?