Package data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the verification type
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringYesName of the verification type
typeenumYesValues: IDENTITY_VERIFICATION, SCREENING, BACKGROUND_CHECK, EMPLOYMENT_VERIFICATION, EDUCATION_VERIFICATION, CREDIT_CHECK, FRAUD_PREVENTION, OTHER
aliasesstring[]No
tagsstring[]NoCategory (Verification, Validation, Background Check)
descriptionstringNoDetailed description
parametersVerificationParameter[]NoQuestions that need to be answered for this verification
parameters[].idstringNo
parameters[].namestringYes
parameters[].public_questionstringNoquestion to ask the human
parameters[].typeenumNoValues: TEXT, NUMBER, MULTIPLE_CHOICE, MULTIPLE_SELECT, DATE, FILE
parameters[].optionsstring[]Nooptions for MULTIPLE_CHOICE and MULTIPLE_SELECT
parameters[].file_typesstring[]Novalid file mime types
parameters[].valid_regionsstring[]No{country}-{stateprovince/territory} or just {country} 2-digit ISO codes
parameters[].is_requiredbooleanNo
average_processing_timesVerificationTime[]Noaverage processing time in minutes
average_processing_times[].millisecondsnumberNo
average_processing_times[].valid_regionsstring[]No{country}-{stateprovince/territory} or just {country} 2-digit ISO codes
has_redirect_urlbooleanNo
has_target_urlbooleanNowhere the provider will redirect the user to after the verification
needs_ip_addressbooleanNo
cost_amountnumberNoCost-related information
currencystringNo
max_scorenumberNoif this verification returns a score, what is the maximum?
info_urlstringNowhere to find additional information
valid_regionsstring[]No{country}-{state/province/territory} or just {country} 2-digit ISO codes

TypeScript

TypeScript
export type VerificationPackage = {
	id?: string; // Unique identifier for the verification type
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name: string; // Name of the verification type
	type: 'IDENTITY_VERIFICATION' | 'SCREENING' | 'BACKGROUND_CHECK' | 'EMPLOYMENT_VERIFICATION' | 'EDUCATION_VERIFICATION' | 'CREDIT_CHECK' | 'FRAUD_PREVENTION' | 'OTHER';
	aliases?: string[];
	tags?: string[]; // Category (Verification, Validation, Background Check)
	description?: string; // Detailed description
	parameters?: []; // Questions that need to be answered for this verification
	average_processing_times?: []; // average processing time in minutes
	has_redirect_url?: boolean;
	has_target_url?: boolean; // where the provider will redirect the user to after the verification
	needs_ip_address?: boolean;
	cost_amount?: number; // Cost-related information
	currency?: string;
	max_score?: number; // if this verification returns a score, what is the maximum?
	info_url?: string; // where to find additional information
	valid_regions?: string[]; // {country}-{state/province/territory} or just {country} 2-digit ISO codes
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodVerificationPackage = z.object({
	id: z.string().optional().describe("Unique identifier for the verification type"),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().describe("Name of the verification type"),
	type: z.enum("IDENTITY_VERIFICATION", "SCREENING", "BACKGROUND_CHECK", "EMPLOYMENT_VERIFICATION", "EDUCATION_VERIFICATION", "CREDIT_CHECK", "FRAUD_PREVENTION", "OTHER"),
	aliases: z.array().optional(),
	tags: z.array().optional().describe("Category (Verification, Validation, Background Check)"),
	description: z.string().optional().describe("Detailed description"),
	parameters: z.array().optional().describe("Questions that need to be answered for this verification"),
	average_processing_times: z.array().optional().describe("average processing time in minutes"),
	has_redirect_url: z.boolean().optional(),
	has_target_url: z.boolean().optional().describe("where the provider will redirect the user to after the verification"),
	needs_ip_address: z.boolean().optional(),
	cost_amount: z.number().optional().describe("Cost-related information"),
	currency: z.string().optional(),
	max_score: z.number().optional().describe("if this verification returns a score, what is the maximum?"),
	info_url: z.string().optional().describe("where to find additional information"),
	valid_regions: z.array().optional().describe("{country}-{state/province/territory} or just {country} 2-digit ISO codes"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class VerificationPackageType(str, Enum):
	IDENTITY_VERIFICATION = 'IDENTITY_VERIFICATION'
	SCREENING = 'SCREENING'
	BACKGROUND_CHECK = 'BACKGROUND_CHECK'
	EMPLOYMENT_VERIFICATION = 'EMPLOYMENT_VERIFICATION'
	EDUCATION_VERIFICATION = 'EDUCATION_VERIFICATION'
	CREDIT_CHECK = 'CREDIT_CHECK'
	FRAUD_PREVENTION = 'FRAUD_PREVENTION'
	OTHER = 'OTHER'

@dataclasses.dataclass
class VerificationPackage:
	"""Unique identifier for the verification type"""
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Name of the verification type"""
	name: str
	type: VerificationPackageType
	aliases: Optional[List[List[str]]]
	"""Category (Verification, Validation, Background Check)"""
	tags: Optional[List[List[str]]]
	"""Detailed description"""
	description: Optional[str]
	"""Questions that need to be answered for this verification"""
	parameters: Optional[PropertyVerificationPackageParameters]
	"""average processing time in minutes"""
	average_processing_times: Optional[PropertyVerificationPackageAverage_processing_times]
	has_redirect_url: Optional[bool]
	"""where the provider will redirect the user to after the verification"""
	has_target_url: Optional[bool]
	needs_ip_address: Optional[bool]
	"""Cost-related information"""
	cost_amount: Optional[int]
	currency: Optional[str]
	"""if this verification returns a score, what is the maximum?"""
	max_score: Optional[int]
	"""where to find additional information"""
	info_url: Optional[str]
	"""{country}-{state/province/territory} or just {country} 2-digit ISO codes"""
	valid_regions: Optional[List[List[str]]]
Are we missing anything? Let us know
Was this page helpful?