Get Applicant Info

Time	Status	User Agent
Retrieving recent requests…

A standard GET call that will retrieve all profile information for the specified applicant.

📘
Secure Fields
By default endpoint will not retrieve any sensitive data that is encrypted in our system, such as Personally Identifiable Information (PII). If you require access to additional, secured applicant data, please contact Fountain at [email protected] for help.
Examples of secured fields include:

gender

ethnicity

citizenship

can_work_in_us

religious_preference

income_salary

income_income_tax_dollar_amount

income_ss_tax

income_medicare_tax

income_taxpayer_identification_number

driver_license_number

driver_license_expiration_date

driver_license_state

ssn

national_identification_number

insurance_type

insurance_benefactor_first_name

insurance_benefactor_middle_name

insurance_benefactor_last_name

insurance_member_id

insurance_company_group_id

insurance_company_of_issue

insurance_country_of_issue

insurance_city_of_issue

insurance_issue_date

insurance_expiration_date

bank_name

bank_routing_number

bank_account_number

passport_number

passport_country_of_issue

passport_city_of_issue

passport_issue_date

passport_expiration_date

vehicle_make

vehicle_model

vehicle_year

vehicle_registration_plate_number

vehicle_vin_number

w4_federal_form

w4_state_form

Response Schema

additionalProperties: false
id
- Required: yes
- Type: string
- Example: "550e8400-e29b-41d4-a716-446655440000"
email
- Required: yes
- Type: string
- Example: "[email protected]"
name
- Required: yes
- Type: string
- Example: "Sammy Bailey"
first_name
- Required: yes
- Type: string
- Example: "Sammy"
last_name
- Required: yes
- Type: string
- Example: "Bailey"
phone_number
- Required: yes
- Type: string
- Example: "7816895444"
normalized_phone_number
- Required: yes
- Type: string
- Example: "+17816895444"
receive_automated_emails
- Required: yes
- Type: boolean
- Example: true
is_duplicate
- Required: no
- Type: boolean
- Example: true

data

Required: yes

Example:

{
  "city": "Berkeley",
  "ssn": "00-22-4566",
  "which_bart_stations_are_close_to_you": [
    "North Berkeley",
    "Downtown Berkeley"
  ],
  "which_shifts_are_you_available_to_work": [
    {
      "Monday": "Both"
    },
    {
      "Tuesday": "Both"
    },
    {
      "Wednesday": "Both"
    },
    {
      "Thursday": "Both"
    },
    {
      "Friday": "Both"
    },
    {
      "Saturday": "First"
    },
    {
      "Sunday": "None"
    }
  ]
}

additionalProperties: false

secure_data
- Required: no
- additionalProperties: true
created_at
- Required: yes
- Type: string
- Format: date-time
- Example: "2015-06-05T05:53:33.708-07:00"
updated_at
- Required: yes
- Type: string
- Format: date-time
- Example: "2015-06-05T05:54:33.708-07:00"
last_transitioned_at
- Required: yes
- Type: string
- Format: date-time
- Example: "2015-06-05T05:53:42.752-07:00"
funnel
- Required: yes
- additionalProperties: false
- id
  - Required: yes
  - Type: string
  - Example: "2a89059c-8a8f-4434-810a-fd76f7170f8e"
- title
  - Required: yes
  - Type: string
  - Example: "Human Usability Facilitator"
- custom_id
  - Required: yes
  - Type: string
  - Example: "3d67750a-dcf4-4ada-a3e4-ee44661949fc"
- location
  - Required: no
  - additionalProperties: false
  - id
    Required: yes
    Type: string
    Example: "7f88228c-cba9-4827-b71d-e81244c05d37"
  - name
    Required: yes
    Type: string
    Example: "San Francisco"
  - latitude
    Required: no
    Type: number
    Example: 37.7886528
  - longitude
    Required: no
    Type: number
    Example: -122.4016796
  - location_group
    Required: no
    additionalProperties: false
    id
    Required: yes
    Type: string
    Example: "7f88228c-cba9-4827-b71d-e81244c05d37"
    name
    Required: yes
    Type: string
    Example: "San Francisco"
can_receive_sms
- Required: yes
- Type: boolean
- Example: false
phone_platform
- Required: yes
- Type: string
- Example: "sms"
partner_data
- Required: yes
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - description
    Required: no
    Type: string
    Example: ""
  - type
    Required: no
    Type: string
    Example: "object"
  - example
    Required: no
    Type: array
stage
- Required: yes
- additionalProperties: false
- id
  - Required: yes
  - Type: string
  - Example: "b3788ad7-13ac-4e69-b904-b594f4f018ce"
- title
  - Required: yes
  - Type: string
  - Example: "Approved"
- parent_id
  - Required: no
  - Type: null
  - Example: "b3788ad7-13ac-4e69-b904-b594f4f018ce"
background_checks
- Required: yes
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - title
    Required: yes
    Type: string
    Example: "Driver license check"
  - status
    Required: yes
    Type: string
    Example: "pending"
  - vendor
    Required: yes
    Type: string
    Example: "checkr"
  - candidate_id
    Required: no
    Type: string
    Example: "e44aa283528e6fde7d542194"
  - report_id
    Required: no
    Type: string
    Example: "4722c07dd9a10c3985ae432a"
  - applicant_id
    Required: no
    Type: string
    Example: "989fd339-ce2c-4a38-a86e-ab513239c809"
  - check_id
    Required: no
    Type: string
    Example: "e9837e56-e03f-47e1-9975-149729f0ac1e"
  - updated_at
    Required: yes
    Type: string
    Format: date-time
    Example: "2015-06-05T05:53:38.974-07:00"
document_signatures
- Required: yes
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - vendor
    Signature service vendor (hellosign or docusign)
    Required: yes
    Type: string
    Example: "hellosign"
  - signature_id
    Vendor-specific signature ID
    Required: yes
    Type: string
    Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967"
  - status
    Status of this request (opened, signed or admin_reviewed)
    Required: yes
    Type: string
    Example: "signed"
lessonly
- Required: yes
- additionalProperties: false
- lesson_results
  - Required: no
  - Type: array
  - Items
    Required: no
    additionalProperties: false
    lesson_url
    Required: no
    Type: string
    Example: "https://hedgehogs.lessonly.com/lessons/123/users/1"
    score_percent
    Required: no
    Type: integer
    Example: 90
    report_card_url
    Required: no
    Type: string
    Format: uri
    Example: "http://hedgehogs.lessonly.com/lesson/123-how-to-be-a-hedgehog"
    completed_at
    Required: no
    Type: string
    Format: date-time
    Example: "2016-08-10T10:20:40.091+10:00"
    lesson_name
    Required: no
    Type: string
    Example: "How to be a hedgehog"
- path_results
  - Required: no
  - Type: array
  - Items
    Required: no
    additionalProperties: false
    path_url
    Required: no
    Type: string
    Example: "https://hedgehogs.lessonly.com/paths/4560/users/1"
    goal
    Required: no
    Type: integer
    Example: 2
    progress
    Required: no
    Type: integer
    Example: 1
    path_name
    Required: no
    Type: string
    Example: "Hedgehogging Path"
- course_results
  - Required: no
  - Type: array
  - Items
    Required: no
    additionalProperties: false
    course_url
    Required: no
    Type: string
    Example: "https://hedgehogs.lessonly.com/courses/1230/users/1"
    goal
    Required: no
    Type: integer
    Example: 2
    progress
    Required: no
    Type: integer
    Example: 1
    course_name
    Required: no
    Type: string
    Example: "Hedgehogging Full Course"
addresses
- Required: yes
- Type: array
- Items
  Applicant Addresses
  - Required: no
  - additionalProperties: false
  - street_name
    Required: no
    Type: string
    Example: "11718 Selkirk Drive"
  - address_2
    Required: no
    Type: string
    Example: "Apartment 101"
  - city
    Required: no
    Type: string
    Example: "Austin"
  - state
    Required: no
    Type: string
    Example: "Texas"
  - zipcode
    Required: no
    Type: string
    Example: 78756
  - country
    Required: no
    Type: string
    Example: "US"
  - latitude
    Required: no
    Type: number
    Example: 60
  - longitude
    Required: no
    Type: number
    Example: 128
labels
- Required: yes
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - title
    Required: yes
    Type: string
    Example: "Label-1"
  - completed
    Required: yes
    Type: boolean
    Example: false
  - completed_at
    Required: no
    Type: string
    Example: "2017-01-01T14:40:30.873-08:00"
file_upload_requests
- Required: yes
- Type: array
- Items
  Recollection Requests
  - Required: no
  - additionalProperties: false
  - id
    Required: no
    Type: string
    Example: 55
  - created_at
    Required: no
    Type: string
    Example: "2017-01-01T14:40:30.873-08:00"
  - recollection_reason
    Required: no
    Type: string
    Example: "blurry"
  - document_name
    Required: no
    Type: string
    Example: "driver_license"
rejection_reason
- Required: yes
- Type: string
- Example: "not qualified enough"
on_hold_reason
- Required: no
- Type: string
- Example: "not a good fit"
score_cards_results
- Required: no
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - score
    Required: yes
    Type: string
    Example: ""
  - created_at
    Required: yes
    Type: string
    Example: ""
  - user
    Required: yes
    additionalProperties: false
    id
    Required: yes
    Type: string
    Example: ""
    name
    Required: yes
    Type: string
    Example: ""
    email
    Required: yes
    Type: string
    Example: ""
  - template
    Required: yes
    additionalProperties: false
    name
    Required: yes
    Type: string
    Example: ""
    weighted
    Required: yes
    Type: boolean
    Example: false
    template_type
    Required: yes
    Type: string
    Example: "weighted"
  - answers
    Required: yes
    Type: array
    Items
    Required: no
    additionalProperties: false
    score
    Required: yes
    Type: integer
    Example: ""
    note
    Required: no
    Type: string
    Example: ""
    question
    Required: yes
    additionalProperties: false
    text
    Required: yes
    Type: string
    Example: ""
    weight
    Required: yes
    Type: integer
    Example: ""
date_of_birth
- Required: no
- Type: string
- Format: date
- Example:
w4_federal_form
- Required: no
- additionalProperties: true
- form_url
  - Required: no
  - Type: string
  - Example: "http://files.fountain.com/w4_federal_form.pdf"
- status
  - Required: no
  - Type: string
  - Example: "awaiting_employee"
- contents
  - Required: no
  - additionalProperties: true
  - description
    Required: no
    Type: string
    Example: ""
  - type
    Required: no
    Type: string
    Example: "object"
  - additionalProperties
    Required: no
    Type: boolean
    Example: true
  - required
    Required: no
    Type: array
w4_state_form
- Required: no
- additionalProperties: true
- form_url
  - Required: no
  - Type: string
  - Example: "http://files.fountain.com/w4_state_form.pdf"
- status
  - Required: no
  - Type: string
  - Example: "awaiting_employee"
- data
  - Required: no
  - additionalProperties: false
  - description
    Required: no
    Type: string
    Example: ""
  - type
    Required: no
    Type: string
    Example: "object"
  - additionalProperties
    Required: no
    Type: boolean
    Example: true
  - required
    Required: no
    Type: array
work_availability
- Required: no
- Type: string
- Example: "monday_morning"
- Enum: 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
country
See Alpha-2 codes: https://en.wikipedia.org/wiki/ISO_3166-1
- Required: no
- Type: string
- Example: "US"
city
- Required: no
- Type: string
- Example: "New York"
street
- Required: no
- Type: string
- Example: "Main street"
state
See USPS codes: https://en.wikipedia.org/wiki/List_of_U.S._state_abbreviations
- Required: no
- Type: string
- Example: "CA"
zipcode
- Required: no
- Type: string
- Example: 77777
gender
- Required: no
- Type: string
- Example: "Male"
ethnicity
- Required: no
- Type: string
- Example: "Native american"
citizenship
See Alpha-2 codes: https://en.wikipedia.org/wiki/ISO_3166-1
- Required: no
- Type: string
- Example: "US"
can_work_in_us
- Required: no
- Type: boolean
- Example: true
desired_hours_per_week
- Required: no
- Type: integer
- Example: 40
desired_employment_duration
- Required: no
- Type: string
- Example: "6-12 months"
education
- Required: no
- Type: string
- Example: "High school diploma"
ssn
- Required: no
- Type: string
- Example: "333-22-4444"
national_identification_number
- Required: no
- Type: string
- Example: "AA11111111"
previous_work
- Required: no
- Type: string
- Example: "Previous work text"
have_prior_experience
- Required: no
- Type: boolean
- Example: false
referral_source
- Required: no
- Type: string
- Example: "Google"
have_transportation
- Required: no
- Type: boolean
- Example: false
income_salary
- Required: no
- Type: number
- Example: 10000
income_income_tax_dollar_amount
- Required: no
- Type: number
- Example: 10000
income_ss_tax
- Required: no
- Type: number
- Example: 10
income_medicare_tax
- Required: no
- Type: number
- Example: 10
income_taxpayer_identification_number
- Required: no
- Type: string
- Example: "AA11111111"
bank_name
- Required: no
- Type: string
- Example: "Bank name"
bank_routing_number
- Required: no
- Type: string
- Example: "123456789"
bank_account_number
- Required: no
- Type: string
- Example: "123456789"
vehicle_make
- Required: no
- Type: string
- Example: "Honda"
vehicle_model
- Required: no
- Type: string
- Example: "Civic"
vehicle_year
- Required: no
- Type: integer
- Example: 1985
vehicle_registration_plate_number
- Required: no
- Type: string
- Example: "AA00AAA"
vehicle_vin_number
- Required: no
- Type: string
- Example: "AA1AA123A1A123456"
driver_license_number
- Required: no
- Type: string
- Example: "A000-1234-5678-90"
driver_license_expiration_date
- Required: no
- Type: string
- Format: date
- Example:
driver_license_state
- Required: no
- Type: string
- Example: "CA"
linkedin
- Required: no
- Type: string
- Example: "https://linkedin.com/applicant.nickname"
facebook
- Required: no
- Type: string
- Example: "https://www.facebook.com/applicant.nickname"
twitter
- Required: no
- Type: string
- Example: "https://www.twitter.com/applicant.nickname"
did_apply_multiple_times
- Required: no
- Type: boolean
- Example: false
why_should_we_hire_you
- Required: no
- Type: string
- Example: "You should hire me because.."
success_in_job
- Required: no
- Type: string
- Example: "My success in job.."
earnings_expectations
- Required: no
- Type: number
- Example: 3000
team_or_solo
- Required: no
- Type: string
- Example: "On my own"
emergency_contact_name
- Required: no
- Type: string
- Example: "John Smith"
emergency_contact_phone
- Required: no
- Type: string
- Example: "+11111111111"
emergency_contact_relationship
- Required: no
- Type: string
- Example: "other"
certifications_licenses
- Required: no
- Type: string
- Example: "Aircraft certification"
first_language
- Required: no
- Type: string
- Example: "Spanish"
other_languages
- Required: no
- Type: string
- Example:
```
[
  "Spanish",
  "Chinese"
]
```
insurance_type
- Required: no
- Type: string
- Example: "Medical"
insurance_benefactor_first_name
- Required: no
- Type: string
- Example: "John"
insurance_benefactor_middle_name
- Required: no
- Type: string
- Example: "Michael"
insurance_benefactor_last_name
- Required: no
- Type: string
- Example: "Smith"
insurance_member_id
- Required: no
- Type: string
- Example: 111111111
insurance_company_group_id
- Required: no
- Type: string
- Example: 111111111
insurance_company_of_issue
- Required: no
- Type: string
- Example: "Some Company"
insurance_country_of_issue
See Alpha-2 codes: https://en.wikipedia.org/wiki/ISO_3166-1
- Required: no
- Type: string
- Example: "US"
insurance_city_of_issue
- Required: no
- Type: string
- Example: "New York"
insurance_issue_date
- Required: no
- Type: string
- Format: date
- Example:
insurance_expiration_date
- Required: no
- Type: string
- Format: date
- Example:
passport_number
- Required: no
- Type: string
- Example: "12345678"
passport_country_of_issue
See Alpha-2 codes: https://en.wikipedia.org/wiki/ISO_3166-1
- Required: no
- Type: string
- Example: "US"
passport_city_of_issue
- Required: no
- Type: string
- Example: "New York"
passport_issue_date
- Required: no
- Type: string
- Format: date
- Example:
passport_expiration_date
- Required: no
- Type: string
- Format: date
- Example:

Secure Fields

Response Schema

200200

401401