--- title: "Update User" method: PATCH path: "/users/{userID}" tags: ["Users"] --- # Update User `PATCH /users/{userID}` Updates a User details by userID. ## Path parameters - `userID` string, required ## Request body - object - `documents` union[] — The personal identifiable information & digital signatures that will be updated. - union - BasicInfoOptional - `type` string, required - `data` object, required - `firstName` string — The first name of the User. - `lastName` string — The last (family) name of the User. - `country` string — The country where the User is residing. - `phone` string — The phone number of the User. - `emailAddress` string — The email address of the User. - IdentificationInfoOptional - `type` string, required - `data` object, required - `value` string — The User's national identification number or tax identification number. - `type` 'SSN' | 'EIN' | 'FTIN' | 'PASSPORT' | 'ALIEN_ID' | 'OTHER' — The type of national identification number. **Note:** `FTNLO` is deprecated and should not be used for new integrations. - `citizenship` string — The country where the User has citizenship. - `issuingCountry` string — The user's country. - `issuingProvince` string — The user's current state/province/territory, where they live. - `issueDate` string - `expiryDate` string - `description` string — Additional information about the identification type provided. - TaxInfoPatch - `type` string, required - `data` object, required - `taxTreatyWithUS` boolean — True, if the User's country has a tax treaty with the United States. - `attestation` object - `signedBy` string — The user ID of the person who signed the attestation. - `usTaxpayer` boolean — True if the party is a US Tax payer - PersonalInfoOptional - `type` string, required - `data` object, required - `birthDay` number — The User's born day. - `birthMonth` number — The User's born month. - `birthYear` number — The User's born year. - `dateOfDeath` string — The User's date of death in YYYY-MM-DD format. - `politicallyExposedNames` string — The names of the people whom are politicaly exposes, separated by a comma. *⚠️ Can be set to 'NULL' if not politically exposed* - `marital` 'SINGLE' | 'DIVORCED' | 'MARRIED' | 'WIDOWED' | 'PARTNER' — The marital status of the User. - AddressInfoOptional - `type` string, required - `data` object, required - `street1` string — The User's current street address, where they live. - `street2` string — The User's additional details of an address i.e. an apartment number. - `city` string — The User's current city, where they live. - `province` string — The User's current state/province/territory, where they live. - `postalCode` string — The User's current postal code (zip code). - `country` string — The User's current country, where they live. - EmploymentInfoOptional - `type` string, required - `data` object, required - `status` 'EMPLOYED' | 'RETIRED' | 'STUDENT' | 'UNEMPLOYED' | 'SELF_EMPLOYED' — The User's current employment status. - `company` string — The User's current employer name. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & type is not being provided* - `companyID` string — A unique identifier created for each Institution or entity on DriveWealth's platform.* - `from` string — The User's start date at the employment. - `to` string — The User's end date at the employment. - `type` 'AGRICULTURE' | 'MINING' | 'UTILITIES' | 'CONSTRUCTION' | 'MANUFACTURING' | 'WHOLESALE' | 'RETAIL' | 'TRANSPORT' | 'INFORMATION' | 'FINANCE' | 'REAL_ESTATE' | 'PROFESSIONAL' | 'MANAGEMENT' | 'EDUCATION' | 'HEALTH' | 'ART' | 'FOOD' | 'PUBLIC' | 'WASTE' — The User's current employer type. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & company is not being provided* - `position` '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' — The User's current role at the employment. *⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED & using Drivewealth's Market Data Offering* - `broker` boolean — True, if the User's current employer is broker.*⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED* - `directorOf` string — The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company. *⚠️ Can be set to 'NULL' if not applicable* - DirectorInfoOptional - `type` string, required - `data` object, required - `directorList` Directors[] - `title` string — The title of the director. - `controlContact` boolean — True, if the director has control over the account. - `institutionalID` string — The unique identifier of the institution director should assioacted with.. - `roles` string[] - `percentage` number — The percentage of ownership the director has in the institution. Value must be greater than 0 and up to 1 (representing 0-100%), with a maximum of 2 decimal places. - InvestorProfileInfoOptional - `type` string, required - `data` object, required - `investmentExperience` 'NONE' | 'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The User's current investment expertise. *⚠️ Can be defaulted to 'YRS_1_2' for all asset classes, except Options.* - `annualIncome` number — The User's current annalized income over one year. - `networthTotal` number — The user's current networth. This calculation is the User's assets - liabilities. - `riskTolerance` 'LOW' | 'MODERATE' | 'HIGH' | 'SPECULATION' — The User's risk ceiling. *⚠️ Can be defaulted to 'LOW' for all asset classes, except Options.* - `investmentObjectives` 'LONG_TERM' | 'INFREQUENT' | 'FREQUENT' | 'ACTIVE_DAILY' | 'NEW' | 'CAPITAL_PRESERVATION' | 'GROWTH' | 'INCOME' | 'SPECULATION' — The User's current investment objectives. *⚠️ Can be defaulted to 'CAPITAL_PRESERVATION' for all asset classes, except Options.* - `secondaryInvestmentObjectives` string[] — The User's secondary investment objectives. - `networthLiquid` number — The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth. *⚠️ Can be defaulted to '-1' for all asset classes, except Options.* - `dependents` number — Total number of dependents the account holder has. *⚠️ Required for Options Onboarding.* - `suitabilityEquities` InvestmentSuitability - `experience` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `years` 'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS' — Number of years equity trading experience. - `tradesPerYear` 'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS' — Total number of trades per year. - `averageTradeSize` 'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS' — Average per trade size. - `suitabilityOptions` InvestmentSuitability - `experience` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `years` 'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS' — Number of years equity trading experience. - `tradesPerYear` 'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS' — Total number of trades per year. - `averageTradeSize` 'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS' — Average per trade size. - `equitiesExperience` InvestmentSuitabilityEquities - `knowledge` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `yearsOfExperience` number — Number of years of trading experience. - `tradesPerYear` number — Total number of trades per year. - `averageTradeValue` number — Average USD value per trade. - `transactionTypes` string[] — The types of transactions the user has experience with. - `optionsExperience` InvestmentSuitabilityOptions - `knowledge` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `yearsOfExperience` number — Number of years of trading experience. - `tradesPerYear` number — Total number of trades per year. - `averageTradeValue` number — Average USD value per trade. - `transactionTypes` string[] — The types of transactions the user has experience with. - `fixedIncomeExperience` union - object - … - object - … - `commodityExperience` union - object - … - object - … - `otherFinancialExperience` union - object - … - object - … - DisclosuresOptional - `type` string, required - `data` object, required - `extendedHoursAgreement` boolean — The User accepts DriveWealth's Extended Hours Agreement. - `termsOfUse` boolean — The User accepts DriveWealth's Terms of Use. - `customerAgreement` boolean — The User accepts DriveWealth's Customer Agreement. *⚠ Only for opening regular brokerage accounts.* - `iraAgreement` boolean — The User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.* - `marginAgreement` boolean — The User accepts DriveWealth's Margin Agreement. *⚠ Only for opening Margin (leveraged) accounts.* - `cryptoAgreements` boolean — The User accepts DriveWealth's Digital Assets Agreement. *⚠ Only for opening Digital Assets accounts.* - `marketDataAgreement` boolean — The User accepts DriveWealth's Market Data Agreement. - `optionsAgreement` boolean — True, if the User accepts DriveWealth's Options trading Agreement. - `oddLinkAgreement` boolean — True, if the User accepts DriveWealth's ODD Link Agreement. - `rule14b` boolean — The User accepts DriveWealth's Rule 14b1(c). - `privacyPolicy` boolean — The User accepts DriveWealth's Privacy Policy. - `dataSharing` boolean — The User accepts DriveWealth's Data Sharing Policy. - `signedBy` string — The User's digital signature (full name). - KYCVerificationInfoOptional - `type` string - `data` object - `verification` 'APPROVED' | 'FAILED' - `verificationIDType` 'DRIVER_LICENSE' | 'NATIONAL_ID' | 'RESIDENCE_PERMIT' | 'PASSPORT' | 'VISA' | 'TAX_ID' | 'VOTER_ID' | 'WORK_PERMIT' | 'TRUST' | 'TRUST_CORP' | 'CORPORATE' - `verificationFullName` string — The name of the customer that was passed during the KYC verification. - `verificationTimestamp` string — The ISO 8601 timestamp of when the KYC verification was completed by the partner. - `verificationTransactionID` string — A unique identifier passed to reference the KYC verification was completed by the partner. - `customField1` string - `customField2` string - `customField3` string - `customField4` string - `customField5` string - MarginDisclosureOptional - `type` string - `data` object - `marginAgreement` boolean — A User's acceptance of DriveWealth's Margin Agreement. - FPSLDisclosure - `type` string - `data` object - `fpslAgreement` boolean, required — A User's acceptance of DriveWealth's Fully Paid Securities Lending (FPSL) Agreement. - CustodianInfoOptional - `type` string - `data` object - `userID` string — A unique identifier created for each User on DriveWealth's platform. - InstitutionalInfoOptional - `type` string - `data` object - `physicalAddressLine1` string — The physical street address where the institution is located. - `physicalAddressLine2` string - `physicalCity` string — The institutuion physical city. - `physicalStateProvince` string — The institutuion physical state or province. - `physicalZipPostalCode` string — The institutuion physical postal or zip code. - `physicalCountryID` string — The institutuion physical country of origin. - `companyOrganizedAs` 'NON_CORP' | 'INC' | 'CLUB' | 'LLC' | 'LLLP' | 'LLP' | 'LP' | 'PARTNERSHIP' | 'SOLE_PROPRIETOR' — The institutuion orginizational structure. - `usaBranch` boolean — True, if the institutuion is registered in side of the United States. - `foreignBank` boolean — True, if the institution is a foreign bank. - `foreignFinancialInstitution` boolean — True, if the institution is maintained for a foreign finanical institution. - `directorCount` number — The number of directors to be added to institutional account. - TrustInfoOptional - `type` string - `data` object - `name` string — The name of the trust. - `dateEstablished` string — The inception date of the trust. - `stateEstablished` string — The state or province where the trust was established. - `street1` string — The physical street address where the institution is located. - `street2` string - `city` string — The institutuion physical city. - `province` string — The institutuion physical state or province. - `postalCode` string — The institutuion physical postal or zip code. - `primaryTrusteeAuthority` 'TRUSTEE_ONLY' | 'TRUSTEE_AND_GRANTOR' | 'MODIFY_TRUSTEES' | 'MODIFY_TRUST' — The permissions the primary trustee has over the trust. - `tin` string — The tax identification number of the trust. - `walletSettlementProfileID` string — The ID of the wallet settlement profile ## Response `200` Fetching a User is Successful. - UserObject - `id` string — A unique identifier created for each User on DriveWealth's platform. - `ackSignedWhen` string — The date and time the User signed the digital documents. - `addressLine1` string — The user's current street address, where they live. - `addressLine2` string — The user's additional details of an address i.e. an apartment number. - `city` string — The user's current city, where they live. - `countryID` string — The user's country. - `displayName` string — The User's display name. *By default this is firstName inital followed by last name.* - `dob` string — The User's date of birth in this format YYYY-MM-DD - `dateOfDeath` string — The User's date of death in YYYY-MM-DD format. - `email` string — The user's email address. - `firstName` string — The first name of the user. - `lastName` string — The last (family) name of the user. - `parentIB` object - `id` string — The unique identifier of the firm. - `name` string — The firm name. - `phone` string — The phone number of the user. - `referralCode` string — The assiocated referral program assiocated to the User. - `stateProvince` string — The user's current state/province/territory, where they live. - `wlpID` string — The wlpID is a deep backoffice ID that identifies each partner from each other. - `walletSettlementProfileID` string — The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners. - `zipPostalCode` string — The User's current postal code (zip code). - `idNo` string — The user's last 4 digits of their national identification number or tax identification number. - `idIssuingCountry` string — The user's country. - `idIssuingProvince` string — The user's current state/province/territory, where they live. - `idIssueDate` string - `idExpiryDate` string - `institutionalDirectorInfo` object — A map of institutional director information, where keys are director IDs (strings) and values are director details. - `status` object - `name` 'PENDING' | 'APPROVED' — The user's current know your User (KYC) status. - `description` string — A custom description of the User's status. - `userType` object - `name` 'INDIVIDUAL_TRADER' | 'CUSTODIAL' — The name that describes the type of User. - `description` string — A custom description of the User type. - `usCitizen` boolean — True, if a the User is a United States Citizen - `updatedWhen` string — The updatedWhen is the last date and time the User was updated. - `brandAmbassador` boolean - `employerBusiness` string — The User's current employer type. - `employmentStatus` object - `name` string — The User's current employment status. - `description` string — A description of the employment status. - `citizenship` string — The user's country. - `createdWhen` string — The createdWhen is the date and time the User was created. - `marginDefault` number - `maritalStatus` object - `name` 'SINGLE' | 'DIVORCED' | 'MARRIED' | 'WIDOWED' | 'PARTNER' — The marital status of the user. - `description` string — A description of the marital status of the User. - `ackCustomerAgreement` boolean — True, if the User accepted DriveWealth's Customer Agreement. - `ackFindersFee` boolean — True, if the User accepted DriveWealth's Finders Fee Agreement. - `ackForeignFindersFee` boolean — True, if the User accepted DriveWealth's Foreign Finders Fee Agreement. - `ackJointCustomerAgreement` boolean — True, if the User accepted DriveWealth's Customer Agreement. - `ackJointFindersFee` boolean — True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner. - `ackJointForeignFindersFee` boolean — True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner. - `ackJointMarketData` boolean — True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner. - `ackMarketData` boolean — True, if the User has accepted DriveWealth's Market Data Agreement. - `ackExtendedHoursAgreement` boolean — True, if the User has accepted DriveWealth's Extended Hours Agreement. - `ackOptionsAgreement` boolean — True, if the User accepts DriveWealth's Options trading Agreement. - `dependents` number — The amount of children or dependents assiocated with the User. - `termsOfUse` boolean — True, if the User has accepted DriveWealth's Terms of Use Agreement. - `badPasswordCount` boolean - `director` boolean — True, if the User is a director at a public traded company or owns 10% or more of a public company. - `employerCompany` string — The name of the User's employer. - `employerCompanyID` string — A unique identifier created for each Institution or entity on DriveWealth's platform.* - `employerCompanyStartDate` string — The User's start date at the employment. - `employerCompanyEndDate` string — The User's end date at the employment. - `employerIsBroker` boolean — True, if the User's employer is a brokerage firm. - `employmentPosition` string — The User's current employment job type. - `employmentYears` number — The amount of years the User has been employed with the employer. - `jointEmployerIsBroker` boolean - `investmentObjectives` object - `name` string — The User's current investment objectives. - `description` string — A custom description of the investment objective. - `investmentExperience` object - `name` string — The User's current investment expertise. - `description` string — A custom description of investment expertise. - `politicallyExposed` boolean — True, if the User is politically exposed to another person. *⚠️ Can be set to 'NULL' if not politically exposed - `riskTolerance` 'LOW' | 'MODERATE' | 'SPECULATION' | 'HIGH' — The User's risk ceiling. - `userNoteQty` number — Total number of notes on the user. - `validTaxForm` boolean — True, if the user has verified/updated tax information. - `w8received` string — The date W8 is received - `w8expires` string — The date W8 expires - `validTaxFormWhen` string — The validTaxForm is the date and time the validTaxForm was changed. - `taxTreatyWithUS` boolean — True, if the user lives in a treaty country and is claiming tax treaty with the United States. - `taxCountry` string — Tax residence country code (ISO 3166-1 alpha-3) on Tax Treaty Benefits with the United States. - `taxAttestation` object - `signedBy` string — The user ID of the person who signed the attestation. - `signedWhen` string — The timestamp when attestation was signed. - `avatarURL` string — The User's avatar. - `annualIncomeRange` '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+' — The User's annual income range, in dollar form. - `ackDisclosureRule14b` boolean — True, if the User has accepted DriveWealth's Rule 14b Agreement. - `ackJointDisclosureRule14b` boolean — True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter. - `networthLiquidRange` '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+' — The user's liquid net worth range. The amount of cash or near cash equivalents of the User's net worth. - `networthTotalRange` '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+' — The User's net total net worth range. - `investmentEquitiesExperience` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `investmentEquitiesYears` 'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS' — Number of years equity trading experience. - `investmentEquitiesTradesPerYear` 'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS' — Total number of trades per year. - `investmentEquitiesAverageTradeSize` 'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS' — Average per trade size - `investmentOptionsExperience` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Trading experience level. - `investmentOptionsYears` 'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS' — Number of years equity trading experience. - `investmentOptionsTradesPerYear` 'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS' — Total number of trades per year. - `investmentOptionsAverageTradeSize` 'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS' — A unique identifier for the Deposit. - `investmentEquitiesKnowledge` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Self assessed knowledge level of equity trading. - `investmentOptionsKnowledge` 'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT' — Self assessed knowledge level of options trading. - `investmentEquitiesYearsOfExperience` number — Number of years of experience trading equities. - `investmentEquitiesTradesPerYearV2` number — Number of equity trades per year. - `investmentEquitiesAverageTransactionAmount` number — Average transaction amount of equity trades. - `investmentEquitiesTransactionTypes` string[] — Types of equity transactions the user has experience with. - `investmentOptionsYearsOfExperience` number — Number of years of experience trading options. - `investmentOptionsTradesPerYearV2` number — Number of options trades per year. - `investmentOptionsAverageTransactionAmount` number — Average transaction amount of options trades. - `investmentOptionsTransactionTypes` string[] — Types of options transactions the user has experience with. - `investmentFixedIncomeDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding fixed income trading. - `investmentCommodityDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding commodity trading. - `investmentOtherFinancialDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding other financial trading. - `secondaryInvestmentObjectives` string[] — The User's secondary investment objectives. --- [API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/versions/9fced6d0ac41/schema)