DriveWealth Users API
The Users API from DriveWealth — 3 operation(s) for users.
The Users API from DriveWealth — 3 operation(s) for users.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/drivewealth-users-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: DriveWealth Accounts Users API
version: '1.0'
servers:
- url: https://bo-api.drivewealth.io/back-office
description: Sandbox server (Uses test data)
- url: https://bo-api.drivewealth.net/back-office
description: Production Server (Uses LIVE data)
tags:
- name: Users
x-displayName: Users
paths:
/users:
post:
tags:
- Users
summary: Create User
description: Creates a User.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersReq'
responses:
'200':
description: Creating a User was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
examples: {}
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/users/{userID}:
get:
tags:
- Users
summary: Retrieve User
description: Retrieves a User details by userID.
parameters:
- in: path
name: userID
schema:
type: string
required: true
example: cc07f91b-7ee1-4868-b8fc-823c70a1b932
description: Unique ID of the User to fetch.
responses:
'200':
description: Retrieving a User was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/FetchUserResponse'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
patch:
tags:
- Users
summary: Update User
description: Updates a User details by userID.
parameters:
- in: path
name: userID
schema:
type: string
required: true
example: cc07f91b-7ee1-4868-b8fc-823c70a1b932
description: Unique ID of the User to update.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Documents'
responses:
'200':
description: Fetching a User is Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/UserObject'
examples:
User Creation:
value:
id: cc07f91b-7ee1-4868-b8fc-823c70a1b932
ackSignedWhen: '2022-12-11T22:28:21.666Z'
addressLine1: 15 Exchange Place
addressLine2: Suite 1000
city: Jersey City
countryID: USA
displayName: JSmith
dob: 2000-12-3
email: jj@drivewealth.dev
firstName: Justin
gender:
name: MALE
languageID: en_US
lastname: Smith
parentIBID:
id: 80f9b672-120d-4b73-9cc9-42fb3262c4b9
name: Tendies Trading Company
phone: '18004612680'
referralCode: 71J000
stateProvince: NJ
wlpID: TTC
zipPostalCode: '94105'
idNo: '****-4444'
status:
name: PENDING
description: User is pending approval.
userType:
name: INDIVIDUAL_TRADER
description: Individual Trader
usCitizen: true
updatedWhen: '2022-12-11T22:28:21.810Z'
brandAmbassador: false
employerBusiness: FINANCE
employementStatus:
name: EMPLOYED
description: Employed
citizenship: US
createdWhen: '2022-12-11T22:28:21.810Z'
marginDefault: 0
maritalStatus:
name: SINGLE
description: Single
ackCustomerAgreement: true
ackFindersFee: false
ackFixedIncomeAgreement: true
ackForeignFindersFee: false
ackJointCustomerAgreement: true
ackJointFindersFee: false
ackJointForeignFindersFee: false
ackJointMarketData: false
ackMarketData: false
ackExtendedHoursAgreement: false
ackOptionsAgreement: true
dependents: 0
termsOfUse: true
director: false
employerCompany: DriveWealth LLC
employerCompanyID: cc07f91b-7ee1-4868-b8fc-823c70a1b932
employerCompanyStartDate: '2014-09-29'
employerCompanyEndDate: '2022-12-25'
employerIsBroker: true
employmentPosition: ENGINEER
employmentYears: 0
jointEmployerIsBroker: false
investmentObjectives:
name: FREQUENT
description: Frequent trader, depending on the market
investmentExperience:
name: YRS_10_
description: 10+ yrs
politicallyExposed: false
riskTolerance: HIGH
userNoteQty: 0
validTaxForm: false
taxTreatyWithUS: true
avatarURL: https://secure.gravatar.com/avatar/2076105f6efe7c11e285add95f514b9a.jpg
annualIncomeRange: $0 - $24,999
ackDisclosureRule14b: true
ackJointDisclosureRule14b: false
networthLiquidRange: $0 - $24,999
networthTotalRange: $0 - $24,999
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/users/{userID}/kyc-status:
get:
tags:
- Users
summary: Retrieve KYC
description: Retrives a User KYC by userID.
parameters:
- in: path
name: userID
schema:
type: string
required: true
example: cc07f91b-7ee1-4868-b8fc-823c70a1b932
description: Unique ID of the User to fetch their profile & kyc status.
responses:
'200':
description: Fetching User's Profile Details & KYC is Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/FetchUserKYCResponse'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
components:
schemas:
CustodianInfo:
type: object
properties:
type:
type: string
example: CUSTODIAN_INFO
data:
type: object
properties:
userID:
$ref: '#/components/schemas/userID'
Institutional_Info:
type: object
properties:
type:
type: string
example: INSTITUTIONAL_INFO
data:
type: object
properties:
physicalAddressLine1:
type: string
example: 15 Exchange Place
description: The physical street address where the institution is located.
physicalAddressLine2:
type: string
example: Unit 1100
physicalCity:
type: string
example: Jersey City
description: The institutuion physical city.
physicalStateProvince:
type: string
example: New Jersey
description: The institutuion physical state or province.
physicalZipPostalCode:
type: string
example: '07302'
description: The institutuion physical postal or zip code.
physicalCountryID:
type: string
example: USA
description: The institutuion physical country of origin.
companyOrganizedAs:
type: string
example: LLC
description: The institutuion orginizational structure.
enum:
- NON_CORP
- INC
- CLUB
- LLC
- LLLP
- LLP
- LP
- PARTNERSHIP
- SOLE_PROPRIETOR
usaBranch:
type: boolean
example: true
description: True, if the institutuion is registered in side of the United States.
foreignBank:
type: boolean
example: false
description: True, if the institution is a foreign bank.
foreignFinancialInstitution:
type: boolean
example: false
description: True, if the institution is maintained for a foreign finanical institution.
directorCount:
type: number
example: '15'
description: The number of directors to be added to institutional account.
Personal_Info:
type: object
required:
- type
- data
properties:
type:
type: string
description: The type of data object.
example: PERSONAL_INFO
enum:
- BASIC_INFO
- IDENTIFICATION_INFO
- TAX_INFO
- PERSONAL_INFO
- ADDRESS_INFO
- EMPLOYMENT_INFO
- INVESTOR_PROFILE_INFO
- DISCLOSURES
- MARGIN_DISCLOSURE
- CUSTODIAN_INFO
- DIRECTOR_INFO
- INSTITUTIONAL_INFO
- TRUST_INFO
data:
type: object
required:
- birthDay
- birthMonth
- birthYear
- politicallyExposedNames
properties:
birthDay:
type: number
example: 3
description: The User's born day.
birthMonth:
type: number
example: 12
description: The User's born month.
birthYear:
type: number
example: 2000
description: The User's born year.
politicallyExposedNames:
type: string
example: Nancy Pelosi
description: The names of the people whom are political exposes, separated by a comma.
irsBackupWithholdings:
type: boolean
example: false
description: True, if the type of account will be a retirement account.
gender:
type: string
example: Male
description: The gender of the User.
enum:
- Male
- Female
martial:
$ref: '#/components/schemas/userMartialStatus'
MarginDisclosure:
type: object
properties:
type:
type: string
example: MARGIN_DISCLOSURE
data:
type: object
properties:
marginAgreement:
type: boolean
example: true
description: A User's acceptance of DriveWealth's Margin Agreement.
Tax_Info_Optional:
type: object
required:
- type
- data
properties:
type:
type: string
example: TAX_INFO
data:
type: object
properties:
taxTreatyWithUS:
type: boolean
example: true
description: True, if the User's country has a tax treaty with the United States.
wlpID:
type: string
example: TTC
description: The wlpID is a deep backoffice ID that identifies each partner from each other.
language:
type: string
example: en_US
enum:
- en_US
- zh_CN
- es_ES
- pt_BR
description: The language the user read/speaks.
firmName:
type: string
example: Tendies Trading Company
description: The firm name.
userCountry:
type: string
example: USA
description: The user's country.
userStreet2:
type: string
example: Suite 1000
description: The user's additional details of an address i.e. an apartment number.
Documents:
type: object
properties:
documents:
type: array
description: The personal identifiable information & digital signatures that will be updated.
items:
oneOf:
- $ref: '#/components/schemas/Basic_Info_Optional'
- $ref: '#/components/schemas/Identification_Info_Optional'
- $ref: '#/components/schemas/Tax_Info_Optional'
- $ref: '#/components/schemas/Personal_Info_Optional'
- $ref: '#/components/schemas/Address_Info_Optional'
- $ref: '#/components/schemas/Employment_Info_Optional'
- $ref: '#/components/schemas/Investor_Profile_Info_Optional'
- $ref: '#/components/schemas/Disclosures_Optional'
Address_Info:
type: object
required:
- type
- data
properties:
type:
type: string
description: The type of data object.
example: ADDRESS_INFO
enum:
- BASIC_INFO
- IDENTIFICATION_INFO
- TAX_INFO
- PERSONAL_INFO
- ADDRESS_INFO
- EMPLOYMENT_INFO
- INVESTOR_PROFILE_INFO
- DISCLOSURES
- MARGIN_DISCLOSURE
- CUSTODIAN_INFO
- DIRECTOR_INFO
- INSTITUTIONAL_INFO
- TRUST_INFO
data:
type: object
required:
- street1
- city
- province
- postalCode
- country
properties:
street1:
$ref: '#/components/schemas/userStreet1'
street2:
$ref: '#/components/schemas/userStreet2'
city:
$ref: '#/components/schemas/userCity'
province:
$ref: '#/components/schemas/userProvince'
postalCode:
$ref: '#/components/schemas/userPostalCode'
country:
$ref: '#/components/schemas/userCountry'
Employment_Info:
type: object
required:
- type
- data
properties:
type:
type: string
example: EMPLOYMENT_INFO
data:
type: object
required:
- status
properties:
status:
type: string
example: EMPLOYED
description: The User current employment status.
enum:
- EMPLOYED
- RETIRED
- STUDENT
- UNEMPLOYED
- SELF_EMPLOYED
company:
type: string
example: DriveWealth LLC
description: "The User's current employer name. \n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED*"
companyID:
type: string
example: cc07f91b-7ee1-4868-b8fc-823c70a1b932
description: "A unique identifier created for each Institution or entity on DriveWealth's platform. \n\n *⚠️ Required when 'company' is not provided*"
from:
type: string
example: '2014-09-29'
description: The User's start date at the employment.
to:
type: string
example: '2022-12-25'
description: The User's end date at the employment.
type:
type: string
example: FINANCE
description: "The User's current employer type. \n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED*"
enum:
- AGRICULTURE
- MINING
- UTILITIES
- CONSTRUCTION
- MANUFACTURING
- WHOLESALE
- RETAIL
- TRANSPORT
- INFORMATION
- FINANCE
- REAL_ESTATE
- PROFESSIONAL
- MANAGEMENT
- EDUCATION
- HEALTH
- ART
- FOOD
- PUBLIC
- WASTE
position:
type: string
example: ENGINEER
description: " The User's current role at the employment. \n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED*"
enum:
- ACCOUNTANT
- ACTUARY
- ADJUSTER
- ADMINISTRATOR
- ADVERTISER
- AGENT
- ATC
- AMBASSADOR
- ANALYST
- APPRAISER
- ARCHITECT
- ARTIST
- ASSISTANT
- ATHLETE
- ATTENDANT
- ATTORNEY
- AUCTIONEER
- AUDITOR
- BARBER
- BROKER
- BUSINESS_EXEC
- BUSINESS_OWNER
- CAREGIVER
- CARPENTER
- CASHIER
- CHEF
- CHIROPRACTOR
- CIVIL
- CLERGY
- CLERK
- COMPLIANCE
- CONSULTANT
- CONTRACTOR
- COUNSELOR
- CUSTOMER_SERVICE
- DEALER
- DEVELOPER
- DISTRIBUTOR
- DOCTOR
- DRIVER
- ENGINEER
- EXAMINER
- EXTERMINATOR
- FACTORY
- FARMER
- FINANCIAL
- FISHERMAN
- FLIGHT
- HR
- IMPEX
- INSPECTOR
- INTERN
- INVESTMENT
- INVESTOR
- IT
- JANITOR
- JEWELER
- LABORER
- LANDSCAPER
- LENDING
- MANAGER
- MECHANIC
- MILITARY
- MORTICIAN
- NURSE
- NUTRITIONIST
- OFFICE
- PHARMACIST
- PHYSICAL
- PILOT
- POLICE
- POLITICIAN
- PM
- REP
- RESEARCHER
- SAILOR
- SALES
- SCIENTIST
- SEAMSTRESS
- SECURITY
- SOCIAL
- TEACHER
- TECHNICIAN
- TELLER
- TRADESPERSON
- TRAINER
- TRANSPORTER
- UNDERWRITER
- WRITER
broker:
type: boolean
example: true
description: "True, if the User's current employer is broker. \n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED*"
directorOf:
type: string
example: AAPL, SQ
description: The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company.
UserObject:
type: object
properties:
id:
$ref: '#/components/schemas/userID'
ackSignedWhen:
type: string
example: '2022-12-11T22:28:21.666Z'
description: The date and time the User signed the digital documents.
addressLine1:
$ref: '#/components/schemas/userStreet1'
addressLine2:
$ref: '#/components/schemas/userStreet2'
city:
$ref: '#/components/schemas/userCity'
countryID:
$ref: '#/components/schemas/userCountry'
displayName:
type: string
example: JSmith
description: The User's display name. *By default this is firstName inital followed by last name.*
dob:
type: string
example: 2000-12-3
description: The User's date of birth in this format YYYY-MM-DD
email:
$ref: '#/components/schemas/email'
firstName:
$ref: '#/components/schemas/firstName'
gender:
type: object
properties:
name:
type: string
example: MALE
enum:
- MALE
- FEMALE
description: The description of the User's gender.
languageID:
$ref: '#/components/schemas/language'
lastname:
$ref: '#/components/schemas/lastName'
parentIBID:
type: object
properties:
id:
$ref: '#/components/schemas/parentIBID'
name:
$ref: '#/components/schemas/firmName'
phone:
$ref: '#/components/schemas/phoneNumber'
referralCode:
type: string
example: 71J000
description: The assiocated referral program assiocated to the User.
stateProvince:
$ref: '#/components/schemas/userProvince'
wlpID:
$ref: '#/components/schemas/wlpID'
zipPostalCode:
type: string
example: 7302
description: The User's current postal code (zip code).
idNo:
$ref: '#/components/schemas/userTaxIDLastFour'
status:
type: object
properties:
name:
type: string
example: PENDING
description: The user's current know your User (KYC) status.
enum:
- PENDING
- APPROVED
description:
type: string
example: User is pending approval.
description: A custom description of the User's status.
userType:
type: object
properties:
name:
type: string
example: INDIVIDUAL_TRADER
description: The name that describes the type of User.
enum:
- INDIVIDUAL_TRADER
- CUSTODIAL
description:
type: string
example: Individual Trader
description: A custom description of the User type.
usCitizen:
type: boolean
example: true
description: True, if a the User is a United States Citizen
updatedWhen:
type: string
example: '2022-12-11T22:28:21.810Z'
description: The updatedWhen is the last date and time the User was updated.
brandAmbassador:
type: boolean
example: false
employerBusiness:
type: string
example: FINANCE
description: The User's current employer type.
employementStatus:
type: object
properties:
name:
type: string
example: EMPLOYED
description: The User's current employement status.
description:
type: string
example: Employed
description: A description of the employement status.
citizenship:
$ref: '#/components/schemas/userCountry'
createdWhen:
type: string
example: '2022-12-11T22:28:21.810Z'
description: The createdWhen is the date and time the User was created.
marginDefault:
type: number
example: 0
maritalStatus:
type: object
properties:
name:
$ref: '#/components/schemas/userMartialStatus'
description:
type: string
example: Single
description: A description of the martial status of the User.
ackCustomerAgreement:
type: boolean
example: true
description: True, if the User accepted DriveWealth's Customer Agreement.
ackFixedIncomeAgreement:
type: boolean
example: false
description: True, if the User accepted DriveWealth's Fixed Income Agreement.
ackFindersFee:
type: boolean
example: false
description: True, if the User accepted DriveWealth's Finders Fee Agreement.
ackForeignFindersFee:
type: boolean
example: false
description: True, if the User accepted DriveWealth's Foreign Finders Fee Agreement.
ackJointCustomerAgreement:
type: boolean
example: true
description: True, if the User accepted DriveWealth's Customer Agreement.
ackJointFindersFee:
type: boolean
example: false
description: True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner.
ackJointForeignFindersFee:
type: boolean
example: false
description: True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner.
ackJointMarketData:
type: boolean
example: false
description: True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner.
ackMarketData:
type: boolean
example: false
description: True, if the User has accepted DriveWealth's Market Data Agreement.
ackExtendedHoursAgreement:
type: boolean
example: false
description: True, if the User has accepted DriveWealth's Extended Hours Agreement.
ackOptionsAgreement:
type: boolean
example: true
description: True, if the User accepts DriveWealth's Options trading Agreement.
dependents:
type: number
example: 0
description: The amount of children or dependents assiocated with the User.
termsOfUse:
type: boolean
example: true
description: True, if the User has accepted DriveWealth's Terms of Use Agreement.
badPasswordCount:
type: boolean
example: 0
director:
type: boolean
example: false
description: True, if the User is a director at a public traded company or owns 10% or more of a public company.
employerCompany:
type: string
example: DriveWealth LLC
description: The name of the User's employer.
employerCompanyID:
type: string
example: cc07f91b-7ee1-4868-b8fc-823c70a1b932
description: "A unique identifier created for each Institution or entity on DriveWealth's platform. \n\n *⚠️ Required when 'company' is not provided*"
employerCompanyStartDate:
type: string
example: '2014-09-29'
description: The User's start date at the employment.
employerCompanyEndDate:
type: string
example: '2022-12-25'
description: The User's end date at the employment.
employerIsBroker:
type: boolean
example: true
description: True, if the User's employer is a brokerage firm.
employmentPosition:
type: string
example: ENGINEER
description: The User's current employment job type.
employmentYears:
type: number
example: 0
description: The amount of years the User has been employed with the employer.
jointEmployerIsBroker:
type: boolean
example: false
investmentObjectives:
type: object
properties:
name:
type: string
example: FREQUENT
description: The User's current investment objectives.
description:
type: string
example: Frequent trader, depending on the market
description: A custom description of the investment objective.
investmentExperience:
type: object
properties:
name:
type: string
example: YRS_10_
description: The User's current investment expertise.
description:
type: string
example: 10+ yrs
description: A custom description of investment expertise.
politicallyExposed:
type: boolean
example: false
description: True, if the User is politically exposed to another person.
riskTolerance:
type: string
example: HIGH
description: The User's risk ceiling.
enum:
- LOW
- MODERATE
- SPECULATION
- HIGH
userNoteQty:
type: number
example: 0
description: Total number of notes on the user.
validTaxForm:
type: boolean
example: true
description: True, if the user has verified/updated tax information.
taxTreatyWithUS:
type: boolean
example: true
description: True, if the User's country has a tax treaty with the United States.
avatarURL:
type: string
example: https://secure.gravatar.com/avatar/2076105f6efe7c11e285add95f514b9a.jpg
description: The User's avatar.
annualIncomeRange:
type: string
example: $0 - $24,999
description: The User's annual income range, in dollar form.
enum:
- Unknown
- $0 - $24,999
- $25,000 - $49,999
- $50,000 - $99,999
- $100,000 - $199,999
- $200,000 - $499,999
- $500,000 - $999,999
- $1,000,000 - $4,999,999
- $5,000,000 - $9,999,999
- $10,000,000+
ackDisclosureRule14b:
type: boolean
example: true
description: True, if the User has accepted DriveWealth's Rule 14b Agreement.
ackJointDisclosureRule14b:
type: boolean
example: false
description: True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter.
networthLiquidRange:
type: string
example: $0 - $24,999
description: 'The user''s liquid net worth range. The amount of cash or near cash equivalents of the User''s net worth. '
enum:
- Unknown
- $0 - $4,999
- $5,000 - $24,999
- $25,000 - $49,999
- $50,000 - $99,999
- $100,000 - $199,999
- $200,000 - $499,999
- $500,000 - $999,999
- $1,000,000 - $4,999,999
- $5,000,000 - $9,999,999
- $10,000,000+
networthTotalRange:
type: string
example: $0 - $24,999
description: The User's net total net worth range.
enum:
- Unknown
- $0 - $4,999
- $5,000 - $24,999
- $25,000 - $49,999
- $50,000 - $99,999
- $100,000 - $199,999
- $200,000 - $499,999
- $500,000 - $999,999
- $1,000,000 - $4,999,999
- $5,000,000 - $9,999,999
- $10,000,000+
investmentEquitiesExperience:
type: string
example: LIMITED
description: Trading experience level.
enum:
- LIMITED
- NONE
- GOOD
- EXCELLENT
investmentEquitiesYears:
type: string
example: YRS_10_PLUS
description: Number of years equity trading experience.
enum:
- YRS_1_2
- YRS_3_5
- YRS_6_9
- YRS_10_PLUS
investmentEquitiesTradesPerYear:
type: string
example: YRS_10_14
description: Total number of trades per year.
enum:
- YRS_0_9
- YRS_10_14
- YRS_15_24
- YRS_25_74
- YRS_75_PLUS
investmentEquitiesAverageTradeSize:
type: string
example: AVG_0_9999
description: 'Average per trade size '
enum:
- AVG_0_9999
- AVG_10000_24999
- AVG_5000_PLUS
investmentOptionsExperience:
type: string
example: LIMITED
description: Trading experience level.
enum:
- LIMITED
- NONE
-
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/drivewealth/refs/heads/main/openapi/drivewealth-users-api-openapi.yml