Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Applicants
exposeAsMcpTool

Update Applicant Info

Update an applicant's information

put/v2/applicants/{id}

Path parameters

idstring required

Request body

namestring
emailstring
phone_numberstring
dataobject
secure_dataobject
rejection_reasonstring
consent_sms_transactionalboolean

Applicant has consented to transactional SMS.

consent_sms_marketingboolean

Applicant has consented to marketing SMS.

consent_calls_transactionalboolean

Applicant has consented to transactional voice calls.

consent_calls_marketingboolean

Applicant has consented to marketing voice calls.

Response

OK

emailstring required

Applicants Email Address

namestring required

Applicants Full Name

keystring

Unique key used to identify an Applicant

first_namestring required

Applicants First Name

last_namestring required

Applicants Last Name

phone_numberstring required

Applicants Phone Number

normalized_phone_numberstring required

Applicants Phone Number

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

Referral ID

wx_external_idstring nullable

WX Worker ID

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.

duplicate_idstring nullable

UUID that links duplicate applicants

portal_urlstring uri
video_urlsstring[]
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

AXHE-3408: Applicant has opted in to transactional SMS about their current application.

consent_sms_marketingboolean

AXHE-3408: Applicant has opted in to marketing SMS about future opportunities.

consent_calls_transactionalboolean

AXHE-3408: Applicant has opted in to calls about their current application.

consent_calls_marketingboolean

AXHE-3408: 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'
date_of_birthstring date
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

Example response

{
  "email": "example@applicant.com",
  "name": "Michael Jordan",
  "key": "341347c8230aaa9c",
  "first_name": "Michael",
  "last_name": "Jordan",
  "phone_number": "214-609-0494",
  "normalized_phone_number": "+12146090494",
  "phone_number_country_code": "+1",
  "created_at": "2024-01-10T05:19:37.788-08:00",
  "updated_at": "2024-01-10T05:19:37.293-08:00",
  "receive_automated_emails": true,
  "referral_id": "1234",
  "wx_external_id": "7763842e-a7e1-41c5-9f04-0f8d17de3810",
  "labels": [
    {
      "title": "Completed Survey",
      "completed": true,
      "completed_at": "2023-09-21T17:00:00.000-07:00"
    }
  ],
  "duplicate_id": "da7a7590-e643-013d-667b-72996a94b79d",
  "file_upload_requests": [
    {
      "id": 1,
      "created_at": "2024-01-10T05:19:37.788-08:00",
      "document_name": "Drivers License."
    }
  ],
  "i9_status": {
    "last_form_update": "2024-01-10T05:19:37.788-08:00",
    "landed_at": "2024-01-10T05:19:37.788-08:00"
  },
  "id": "5c0f5463-0103-46ce-abd3-749f5551d00e",
  "last_transitioned_at": "2024-01-10T05:19:37.788-08:00",
  "timezone": "America/Chicago",
  "document_signatures": [
    {
      "signature_id": "91990715d51488bdd1e184b83828db8a"
    }
  ],
  "document_uploads": [
    {
      "filename": "selfie.jpg",
      "data_key": "selfie_pic"
    }
  ],
  "funnel": {
    "location": {
      "address": "123 William St, New York, NY 10038, USA",
      "address_detail": {
        "city": "New York",
        "state_code": "NY",
        "postal_code": "10038",
        "street_address": "123 William St"
      }
    },
    "opening_pay_rate": {
      "compensation": "20.0"
    }
  },
  "assessments": [
    {
      "completed_at": "2024-09-17T07:08:18.996-07:00",
      "id": "ad1465d6-35b1-4e86-934e-a31af0d14020",
      "score": 2,
      "status": "complete",
      "system_type": "boolean",
      "title": "An assessment"
    }
  ]
}