Request data model

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

Data Model

idstring read-only
created_atdate read-only
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate read-only
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
package_idstring
parameters array
target_urlstring
candidate_idstring
points to ATS Candidate
profile_ip_addressstring
XXX.XXX.XXX.XXX
profile_namestring
profile_date_of_birthstring
YYYY-MM-DD
profile_addresses array
profile_gender enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
profile_emailsstring array
profile_telephonesstring array
profile_national_identifierstring
response_completed_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atdate
datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_status enum
Valid values:
"COMPLETED"
"FAILED"
"PASSED"
"PENDING"
Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO
response_scorenumber
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_urlstring
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_urlsstring array
report download
response_details array
response_sourcestring
Are we missing anything? Let us know
Was this page helpful?