keystring
Unique key used to identify an Applicant
first_namestring required
phone_numberstring required
normalized_phone_numberstring required
phone_number_country_codestring required
Applicants Phone Number country code
dataobject required
Applicant extra information
created_atstring date-time required
Date when the Applicant was created
updated_atstring date-time nullable required
Date when the Applicant was last updated
receive_automated_emailsboolean required
Whether the Applicant receives automated emails or not.
number_opted_outboolean
Deprecated. Whether the Applicant has opted out of sms or not. Use the granular consent_sms_transactional / consent_sms_marketing / consent_calls_transactional / consent_calls_marketing fields instead.
referral_idstring nullable
wx_external_idstring nullable
kombo_applicant_idstring nullable
Kombo ATS application id captured by the inbound connector import. Absent when the applicant did not come through an ATS.
kombo_candidate_idstring nullable
Kombo ATS candidate id captured by the inbound connector import. One candidate can hold several applications.
created_from_ipstring nullable
IP Address collected when application form was submitted. IPv4 or IPv6 format
application_localestring nullable
Locale the applicant used when submitting the application.
is_duplicateboolean required
Applicants has been marked as a duplicate.
gdpr_anonymizedboolean
Whether a GDPR anonymize endpoint has run on the Applicant. Its name, contact details and messages are anonymized. Data keys the call kept, whether left out of data_denylist or named in data_whitelist, still hold their values. Once true, every anonymize endpoint is a no-op.
gdpr_anonymized_atstring date-time nullable
When the Applicant was GDPR-anonymized. Present on the single-applicant read only; null when it has not been anonymized.
duplicate_idstring nullable
UUID that links duplicate applicants
i9_pdfstring nullable
The URL to visit i9 PDF Form.
idstring required
ID of the applicant used when making calls on behalf of the applicant.
last_transitioned_atstring date-time nullable required
DateTime the applicant was last transitioned from one stage to another.
timezonestring nullable
Timezone of the applicant
partner_dataobject[] required
Partner-specific data. Each element is an object with a single key (the partner name, e.g.
"AI Interview") whose value is an array. For each completed package, the array will have one element.
The completed package object will only have keys "statuses" and "details".
The array will always end with one applicant-level entry with keys "statuses", "details", "labels", and "metadata".
partner_option_dataobject[] required
can_receive_smsboolean required
consent_sms_transactionalboolean
Applicant has opted in to transactional SMS about their current application.
consent_sms_marketingboolean
Applicant has opted in to marketing SMS about future opportunities.
consent_calls_transactionalboolean
Applicant has opted in to calls about their current application.
consent_calls_marketingboolean
Applicant has opted in to calls about future opportunities or retention programs.
consent_sms_transactional_atstring date-time nullable
Timestamp of the most recent change to consent_sms_transactional.
consent_sms_marketing_atstring date-time nullable
Timestamp of the most recent change to consent_sms_marketing.
consent_calls_transactional_atstring date-time nullable
Timestamp of the most recent change to consent_calls_transactional.
consent_calls_marketing_atstring date-time nullable
Timestamp of the most recent change to consent_calls_marketing.
phone_platform'sms' | 'whats_app' required
work_availability'sunday_morning' | 'sunday_afternoon' | 'sunday_evening' | 'monday_morning' | 'monday_afternoon' | 'monday_evening' | 'tuesday_morning' | 'tuesday_afternoon' | 'tuesday_evening' | 'wednesday_morning' | 'wednesday_afternoon' | 'wednesday_evening' | 'thursday_morning' | 'thursday_afternoon' | 'thursday_evening' | 'friday_morning' | 'friday_afternoon' | 'friday_evening' | 'saturday_morning' | 'saturday_afternoon' | 'saturday_evening'
team_or_solo'team' | 'solo'
ssnstring nullable
Predefined secure key at the root
score_cards_resultsobject[]
rejection_reasonstring
Manually set reason for rejection.
disabilitystring nullable
Predefined secure key at the root
ethnicitystring nullable
Predefined secure key at the root
genderstring nullable
Predefined secure key at the root
sexual_orientationstring nullable
Predefined secure key at the root
transgender_identitystring nullable
Predefined secure key at the root
veteran_usstring nullable
Predefined secure key at the root
citizenshipstring nullable
Predefined secure key at the root
can_work_in_usboolean nullable
Predefined secure key at the root
national_identification_numberstring nullable
Predefined secure key at the root
tax_idstring nullable
Predefined secure key at the root
income_salarystring nullable
Predefined secure key at the root
income_income_tax_dollar_amountstring nullable
Predefined secure key at the root
income_ss_taxstring nullable
Predefined secure key at the root
income_medicare_taxstring nullable
Predefined secure key at the root
income_taxpayer_identification_numberstring nullable
Predefined secure key at the root
bank_namestring nullable
Predefined secure key at the root
bank_routing_numberstring nullable
Predefined secure key at the root
bank_account_numberstring nullable
Predefined secure key at the root
ibanstring nullable
Predefined secure key at the root
bicstring nullable
Predefined secure key at the root
vehicle_makestring nullable
Predefined secure key at the root
vehicle_modelstring nullable
Predefined secure key at the root
vehicle_yearnumber nullable
Predefined secure key at the root
vehicle_registration_plate_numberstring nullable
Predefined secure key at the root
vehicle_vin_numberstring nullable
Predefined secure key at the root
driver_license_numberstring nullable
Predefined secure key at the root
driver_license_expiration_datestring nullable
Predefined secure key at the root
driver_license_statestring nullable
Predefined secure key at the root
insurance_typestring nullable
Predefined secure key at the root
insurance_benefactor_first_namestring nullable
Predefined secure key at the root
insurance_benefactor_middle_namestring nullable
Predefined secure key at the root
insurance_benefactor_last_namestring nullable
Predefined secure key at the root
insurance_member_idstring nullable
Predefined secure key at the root
insurance_company_group_idstring nullable
Predefined secure key at the root
insurance_company_of_issuestring nullable
Predefined secure key at the root
insurance_country_of_issuestring nullable
Predefined secure key at the root
insurance_city_of_issuestring nullable
Predefined secure key at the root
insurance_issue_datestring nullable
Predefined secure key at the root
insurance_expiration_datestring nullable
Predefined secure key at the root
passport_numberstring nullable
Predefined secure key at the root
passport_country_of_issuestring nullable
Predefined secure key at the root
passport_city_of_issuestring nullable
Predefined secure key at the root
passport_issue_datestring nullable
Predefined secure key at the root
passport_expiration_datestring nullable
Predefined secure key at the root