API Reference

Create User - Fields Type and Options

AttributeTypeDescription
employmentStatusStringEmployment status. Options:
"EMPLOYED" – Employed
"RETIRED" – Retired
"STUDENT" – Student
"UNEMPLOYED" – Not Employed
"SELF_EMPLOYED" – Self Employed / Business Owner
employmentPositionStringPosition 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
employmentTypeStringType 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
investmentObjectivesStringInvestment objectives. Options:
"LONG_TERM" – Long–term buy & hold investing
"INFREQUENT" – Trading infrequently when I see an opportunity
"FREQUENT" – Frequent trader, depending on the market
"ACTIVE_DAILY" – Active trader, daily trader
"NEW" – New to investing
riskToleranceStringRisk tolerance. Options:
"LOW" – Low Risk
"MODERATE" – Moderate Risk
"SPECULATION" – Speculative Risk
"HIGH" – High Risk
investmentExperienceStringInvestment experience. Options:
"NONE" – None
"YRS1_2" – 1–2 years
"YRS_3_5" – 3–5 years
"YRS_5_10" – 5–10 years
"YRS_10" – 10+ years
politicallyExposedNamesStringPolitically exposed person or public official?

Official Question:

> “Is the account maintained for a current or former Politically Exposed Person or Public Official (includes U.S. and Foreign)? A politically exposed person is someone who has been entrusted with a prominent public function, or who is closely related to such a person.”

If "Yes", display the following text input prompt and send the response:

> "Please provide the names of that official and official's immediate family members (including former spouses)."

If "No", send null
documentsArrayAccepted Values for Document Array:

proofType: ADDRESS || ID
docSide: FRONT || BACK
docType: NATIONAL_ID_CARD || PASSPORT || VOTER_ID || RESIDENCE_PERMIT || DRIVER_LICENSE || OTHER

Accepted Documents for KYC verification:

For Indian Residents:

ID proof - Pan (NATIONAL_ID_CARD) or Aadhaar (NATIONAL_ID_CARD)

For Non-Indian Residents:

ID proof - National ID (NATIONAL_ID_CARD) or Residence Permit (RESIDENCE_PERMIT) or Driver's
License (DRIVER_LICENSE) or Passport (PASSPORT)

Address proof - Utility Bill (OTHER) or Bank / Society Statement (OTHER)

Example documents : 

[
  {
    "docId": "1ffd185f-cf4f-433d-ab5d-45d381a1f940",
    "proofType": "ADDRESS",
    "docSide": "FRONT",
    "docType": "NATIONAL_ID_CARD"
	}, {
    "docId": "1ffd185f-cf4f-433d-ab5d-45d381a1f940",
    "proofType": "ADDRESS",
    "docSide": "FRONT",
    "docType": "NATIONAL_ID_CARD"
  },
  ......
  ......
  ......
]

Updated over 3 years ago

Updated over 3 years ago