Package data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the verification type |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | Yes | Name of the verification type |
type | enum | Yes | Values: IDENTITY_VERIFICATION, SCREENING, BACKGROUND_CHECK, EMPLOYMENT_VERIFICATION, EDUCATION_VERIFICATION, CREDIT_CHECK, FRAUD_PREVENTION, OTHER |
aliases | string[] | No | |
tags | string[] | No | Category (Verification, Validation, Background Check) |
description | string | No | Detailed description |
parameters | VerificationParameter[] | No | Questions that need to be answered for this verification |
parameters[].id | string | No | |
parameters[].name | string | Yes | |
parameters[].public_question | string | No | question to ask the human |
parameters[].type | enum | No | Values: TEXT, NUMBER, MULTIPLE_CHOICE, MULTIPLE_SELECT, DATE, FILE |
parameters[].options | string[] | No | options for MULTIPLE_CHOICE and MULTIPLE_SELECT |
parameters[].file_types | string[] | No | valid file mime types |
parameters[].valid_regions | string[] | No | {country}-{stateprovince/territory} or just {country} 2-digit ISO codes |
parameters[].is_required | boolean | No | |
average_processing_times | VerificationTime[] | No | average processing time in minutes |
average_processing_times[].milliseconds | number | No | |
average_processing_times[].valid_regions | string[] | No | {country}-{stateprovince/territory} or just {country} 2-digit ISO codes |
has_redirect_url | boolean | No | |
has_target_url | boolean | No | where the provider will redirect the user to after the verification |
needs_ip_address | boolean | No | |
cost_amount | number | No | Cost-related information |
currency | string | No | |
max_score | number | No | if this verification returns a score, what is the maximum? |
info_url | string | No | where to find additional information |
valid_regions | string[] | No | {country}-{state/province/territory} or just {country} 2-digit ISO codes |
Are we missing anything? Let us know