Request data model

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

FieldTypeRequiredDescription
idstringNo (read-only)
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
package_idstringNo
parametersVerificationParameterInput[]No
parameters[].idstringNo
parameters[].namestringNoname of parameter
parameters[].inputsstring[]No
target_urlstringNo
candidate_idstringNopoints to ATS Candidate
profile_ip_addressstringNoXXX.XXX.XXX.XXX
profile_namestringNo
profile_date_of_birthstringNoYYYY-MM-DD
profile_addressesVerificationAddress[]No
profile_addresses[].address1stringNo
profile_addresses[].address2stringNo
profile_addresses[].citystringNo
profile_addresses[].regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
profile_addresses[].region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
profile_addresses[].postal_codestringNo
profile_addresses[].countrystringNo
profile_addresses[].country_codestringNoCountry code for the country, in ISO 3166 A-2 format
profile_genderenumNoValues: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY
profile_emailsstring[]No
profile_telephonesstring[]No
profile_national_identifierstringNo
response_completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atstring (date-time)Nodatetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_statusenumNoBackground checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO Values: COMPLETED, FAILED, PASSED, PENDING
response_scorenumberNoIdentity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)
response_redirect_urlstringNoMost modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools.
response_download_urlsstring[]Noreport download
response_detailsVerificationResponseDetail[]No
response_details[].titlestringNo
response_details[].textstringNo
response_details[].is_privatebooleanNo
response_details[].is_failed_reasonbooleanNo
response_details[].parameter_idstringNoin reference to the parameter input
response_details[].download_urlstringNo
response_sourcestringNo

TypeScript

TypeScript
export type VerificationRequest = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	package_id?: string;
	parameters?: [];
	target_url?: string;
	candidate_id?: string; // points to ATS Candidate
	profile_ip_address?: string; // XXX.XXX.XXX.XXX
	profile_name?: string;
	profile_date_of_birth?: string; // YYYY-MM-DD
	profile_addresses?: [];
	profile_gender?: 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY';
	profile_emails?: string[];
	profile_telephones?: string[];
	profile_national_identifier?: string;
	response_completed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_expires_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_issued_at?: string-time; // datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_status?: 'COMPLETED' | 'FAILED' | 'PASSED' | 'PENDING'; // Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO
	response_score?: number; // Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)
	response_redirect_url?: string; // Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools.
	response_download_urls?: string[]; // report download
	response_details?: [];
	response_source?: string;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodVerificationRequest = z.object({
	id: z.string().optional(),
	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)"),
	package_id: z.string().optional(),
	parameters: z.array().optional(),
	target_url: z.string().optional(),
	candidate_id: z.string().optional().describe("points to ATS Candidate"),
	profile_ip_address: z.string().optional().describe("XXX.XXX.XXX.XXX"),
	profile_name: z.string().optional(),
	profile_date_of_birth: z.string().optional().describe("YYYY-MM-DD"),
	profile_addresses: z.array().optional(),
	profile_gender: z.enum("MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY").optional(),
	profile_emails: z.array().optional(),
	profile_telephones: z.array().optional(),
	profile_national_identifier: z.string().optional(),
	response_completed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_expires_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_issued_at: z.string-time().optional().describe("datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_status: z.enum("COMPLETED", "FAILED", "PASSED", "PENDING").optional().describe("Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO"),
	response_score: z.number().optional().describe("Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)"),
	response_redirect_url: z.string().optional().describe("Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools."),
	response_download_urls: z.array().optional().describe("report download"),
	response_details: z.array().optional(),
	response_source: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class VerificationRequestProfile_gender(str, Enum):
	MALE = 'MALE'
	FEMALE = 'FEMALE'
	INTERSEX = 'INTERSEX'
	TRANS = 'TRANS'
	NON_BINARY = 'NON_BINARY'

@dataclasses.dataclass
class VerificationRequestResponse_status(str, Enum):
	COMPLETED = 'COMPLETED'
	FAILED = 'FAILED'
	PASSED = 'PASSED'
	PENDING = 'PENDING'

@dataclasses.dataclass
class VerificationRequest:
	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]
	package_id: Optional[str]
	parameters: Optional[PropertyVerificationRequestParameters]
	target_url: Optional[str]
	"""points to ATS Candidate"""
	candidate_id: Optional[str]
	"""XXX.XXX.XXX.XXX"""
	profile_ip_address: Optional[str]
	profile_name: Optional[str]
	"""YYYY-MM-DD"""
	profile_date_of_birth: Optional[str]
	profile_addresses: Optional[PropertyVerificationRequestProfile_addresses]
	profile_gender: Optional[VerificationRequestProfile_gender]
	profile_emails: Optional[List[List[str]]]
	profile_telephones: Optional[List[List[str]]]
	profile_national_identifier: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_completed_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_expires_at: Optional[str]
	"""datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_issued_at: Optional[str]
	"""Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO"""
	response_status: Optional[VerificationRequestResponse_status]
	"""Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)"""
	response_score: Optional[int]
	"""Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools."""
	response_redirect_url: Optional[str]
	"""report download"""
	response_download_urls: Optional[List[List[str]]]
	response_details: Optional[PropertyVerificationRequestResponse_details]
	response_source: Optional[str]
Are we missing anything? Let us know
Was this page helpful?