Home🔒 DocumentationAPI Reference🔒 Changelog
FIX APIAPI Status

Employment

This document has two types:

  1. EMPLOYMENT_INFO: Details corresponding to the User
  2. JOINT_EMPLOYMENT_INFO: Details corresponding to the Joint account holder linked to this User

When creating Joint accounts on the platform, both of these documents should be provided on the User object.

🚧

Where options of predefined arguments are presented below (see: type) free form strings are prohibited.

Attribute

Type

Description

Required

type

string

Type of user document. Default to "EMPLOYMENT_INFO"

✅

data

object

Document object that contains all data for the "EMPLOYMENT_INFO" user document

✅

data.status

string

Employment status. Options:

  • "EMPLOYED" – Employed
  • "RETIRED" – Retired
  • "STUDENT" – Student
  • "UNEMPLOYED" – Not Employed
  • "SELF_EMPLOYED" – Self Employed / Business Owner

✅

data.company

string

Employer company name

⚠️
Only required when data.status is "EMPLOYED" or "SELF_EMPLOYED"

data.type

string

Type of employment. Options:

  • "AGRICULTURE" – Agriculture, Forestry, Fishing and Hunting
  • "MINING" – Mining, Quarrying, and Oil and Gas Extraction
  • "UTILITIES" – Utilities
  • "CONSTRUCTION" – Construction
  • "MANUFACTURING" – Manufacturing
  • "WHOLESALE" – Wholesale Trade
  • "RETAIL" – Retail Trade
  • "TRANSPORT" – Transportation and Warehousing
  • "INFORMATION" – Information
  • "FINANCE" – Finance and Insurance
  • "REAL_ESTATE" – Real Estate and Rental and Leasing
  • "PROFESSIONAL" – Professional, Scientific, and Technical Services
  • "MANAGEMENT" – Management of Companies and Enterprises
  • "EDUCATION" – Educational Services
  • "HEALTH" – Health Care and Social Assistance
  • "ART" – Arts, Entertainment, and Recreation
  • "FOOD" – Accommodation and Food Services
  • "PUBLIC" – Public Administration
  • "WASTE" – Administrative and Support and Waste Management and Remediation Services

⚠️
Only required when data.status is "EMPLOYED" or "SELF_EMPLOYED"

data.position

string

Position at employment company. Options:

  • "ACCOUNTANT" – Accountant/CPA/Bookkeeper/Controller
  • "ACTUARY" – Actuary
  • "ADJUSTER" – Adjuster
  • "ADMINISTRATOR" – Administrator
  • "ADVERTISER" – Advertiser/Marketer/PR Professional
  • "AGENT" – Agent
  • "ATC" – Air Traffic Controller
  • "AMBASSADOR" – Ambassador/Consulate Professional
  • "ANALYST" – Analyst
  • "APPRAISER" – Appraiser
  • "ARCHITECT" – Architect/Designer
  • "ARTIST" – Artist/Performer/Actor/Dancer
  • "ASSISTANT" – Assistant
  • "ATHLETE" – Athlete
  • "ATTENDANT" – Attendant
  • "ATTORNEY" – Attorney/Judge/Legal Professional
  • "AUCTIONEER" – Auctioneer
  • "AUDITOR" – Auditor
  • "BARBER" – Barber/Beautician/Hairstylist
  • "BROKER" – Broker
  • "BUSINESS_EXEC" – Business Executive (VP, Director, etc.)
  • "BUSINESS_OWNER" – Business Owner
  • "CAREGIVER" – Caregiver
  • "CARPENTER" – Carpenter/Construction Worker
  • "CASHIER" – Cashier
  • "CHEF" – Chef/Cook
  • "CHIROPRACTOR" – Chiropractor
  • "CIVIL" – Civil Servant
  • "CLERGY" – Clergy
  • "CLERK" – Clerk
  • "COMPLIANCE" – Compliance/Regulatory Professional
  • "CONSULTANT" – Consultant
  • "CONTRACTOR" – Contractor
  • "COUNSELOR" – Counselor/Therapist
  • "CUSTOMER_SERVICE" – Customer Service Representative
  • "DEALER" – Dealer
  • "DEVELOPER" – Developer
  • "DISTRIBUTOR" – Distributor
  • "DOCTOR" – Doctor/Dentist/Veterinarian/Surgeon
  • "DRIVER" – Driver
  • "ENGINEER" – Engineer
  • "EXAMINER" – Examiner
  • "EXTERMINATOR" – Exterminator
  • "FACTORY" – Factory/Warehouse Worker
  • "FARMER" – Farmer/Rancher
  • "FINANCIAL" – Financial Planner
  • "FISHERMAN" – Fisherman
  • "FLIGHT" – Flight Attendant
  • "HR" – Human Resources Professional
  • "IMPEX" – Importer/Exporter
  • "INSPECTOR" – Inspector/Investigator
  • "INTERN" – Intern
  • "INVESTMENT" – Investment Advisor/Investment Manager
  • "INVESTOR" – Investor
  • "IT" – IT Professional/IT Associate
  • "JANITOR" – Janitor
  • "JEWELER" – Jeweler
  • "LABORER" – Laborer
  • "LANDSCAPER" – Landscaper
  • "LENDING" – Lending Professional
  • "MANAGER" – Manager
  • "MECHANIC" – Mechanic
  • "MILITARY" – Military, Officer or Associated
  • "MORTICIAN" – Mortician/Funeral Director
  • "NURSE" – Nurse
  • "NUTRITIONIST" – Nutritionist
  • "OFFICE" – Office Associate
  • "PHARMACIST" – Pharmacist
  • "PHYSICAL" – Physical Therapist
  • "PILOT" – Pilot
  • "POLICE" – Police Officer/Firefighter/Law Enforcement Professional
  • "POLITICIAN" – Politician
  • "PM" – Project Manager
  • "REP" – Registered Rep
  • "RESEARCHER" – Researcher
  • "SAILOR" – Sailor/Seaman
  • "SALES" – Salesperson
  • "SCIENTIST" – Scientist
  • "SEAMSTRESS" – Seamstress/Tailor
  • "SECURITY" – Security Guard
  • "SOCIAL" – Social Worker
  • "TEACHER" – Teacher/Professor
  • "TECHNICIAN" – Technician
  • "TELLER" – Teller
  • "TRADESPERSON" – Tradesperson/Craftsperson
  • "TRAINER" – Trainer/Instructor
  • "TRANSPORTER" – Transporter
  • "UNDERWRITER" – Underwriter
  • "WRITER" – Writer/Journalist/Editor

⚠️
Only required when data.status is "EMPLOYED" or "SELF_EMPLOYED"

data.broker

boolean

Affiliated with a broker dealer (et al)?

Official question:

“Are they affiliated with or employed by a stock exchange, member firm of an exchange or FINRA, or a municipal securities broker-dealer?”

If true, display:

“If answered Yes, you are obligated to notify your employer in writing of your intention to open an account.”

✅ (must be asked, but can be false)

data.directorOf

string

Director/officer of public company?

Official question:

"Is the account holder(s) a control person of a publicly traded company? A Director, Officer or 10% stock owner?

if "Yes", send string and display:

"If yes, please list the company name and its ticker symbol."

If "No", send null

✅ (must be asked, but can be false)

{
  "type": "EMPLOYMENT_INFO",
  "data": {
    "status": "EMPLOYED",
    "company": "Company, LLC",
    "position": "DOCTOR",
    "type": "PROFESSIONAL",
    "broker": false,
    "directorOf": null
  }
}