Update KYC Identity

Path Params

• id string required

Body Params

object

• enterpriseId string
  The BitGo enterprise ID

  at least 1 characters
• userId string
  The BitGo user ID

  at least 1 characters
• organizationId string
  The Bitgo organization ID

  at least 1 characters
• nameFirst string
  The first name

  at least 1 characters
• nameLast string
  The last name

  at least 1 characters
• nameMiddle string
  The middle name

  at least 1 characters
• debugStatus string enum
  Debug status for simulating verification failure or success in the test environment - passes by default
  passedfailed
  passedfailed
• debugFailureReason string
  Debug failure reason to provide additional context when simulating verification failure in the test environment

  at least 1 characters
• contractSignerNameFull string
  The full name of the individual signing the contract

  at least 1 characters
• contractSignedDate string date
  The date the contract was signed (YYYY-MM-DD)
• contractSignedIPAddress string
  The IP address from which the contract was signed

  at least 1 characters
• contractVersion string
  The version of the contract being signed

  at least 1 characters
• userAgreesToTerms boolean
  Whether the user agrees to the terms and conditions
  False True
• occupation string enum
  The occupation category of the individual
  AgricultureArt Dealer / Auctioneer / Import / Export CompanyFinancial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co)Casinos and Gambling EstablishmentsCharity/NGO/Non-Profit/Foundation/EndowmentComputer Programmer / Administrator / Software Engineer / IT or Software / Technology CompanyCrypto Services (ATM, Exchange, Lender, Coins/Token)Education / TeacherExtractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious MetalsFamily OfficeFilm / TV / Entertainment (not adult)Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)HealthcareLaw Enforcement / Military / Protective ServicesMiner / Mining PoolMoney Service BusinessOtherPrivate Equity / Venture CapitalProfessional Service Providers (lawyers accountants etc.)Real estate brokers developers and appraisersRecreation / HospitalityStudent / Unemployed / RetiredTraders / Trading (High Frequency, Proprietary, Market Maker)Other - DefaultWeapons Dealers
  AgricultureArt Dealer / Auctioneer / Import / Export CompanyFinancial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co)Casinos and Gambling EstablishmentsCharity/NGO/Non-Profit/Foundation/EndowmentComputer Programmer / Administrator / Software Engineer / IT or Software / Technology CompanyCrypto Services (ATM, Exchange, Lender, Coins/Token)Education / TeacherExtractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious MetalsFamily OfficeFilm / TV / Entertainment (not adult)Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)HealthcareLaw Enforcement / Military / Protective ServicesMiner / Mining PoolMoney Service BusinessOtherPrivate Equity / Venture CapitalProfessional Service Providers (lawyers accountants etc.)Real estate brokers developers and appraisersRecreation / HospitalityStudent / Unemployed / RetiredTraders / Trading (High Frequency, Proprietary, Market Maker)Other - DefaultWeapons Dealers
• annualIncome string enum
  The annual income range of the individual
  Under $50,000$50,001 - $100,000$100,001 - $300,000$300,001 - $500,000$500,001 and over
  Under $50,000$50,001 - $100,000$100,001 - $300,000$300,001 - $500,000$500,001 and over
• netWorth string enum
  The net worth range of the individual
  Under $100,000$100,001 - $500,000$500,001 - $1,000,000$1,000,001 - $5,000,000$5,000,001 and over
  Under $100,000$100,001 - $500,000$500,001 - $1,000,000$1,000,001 - $5,000,000$5,000,001 and over
• sourceOfNetWorth string enum
  The primary source of the individual's net worth
  Employment Income: Includes salaries, wages, and bonuses.Business Income: Revenue from self-owned businesses or proceeds from the sale of a business.Legal and Compensation Payments: Funds received from legal settlements, including insurance claims, divorce settlements, accident compensations, etc.Inheritances and Gifts: Money or assets received as an inheritance, gift, or through trust distributions.Investment Earnings: Profits derived from investments such as cryptocurrencies, stocks, bonds, private equity, or venture capital.
  Employment Income: Includes salaries, wages, and bonuses.Business Income: Revenue from self-owned businesses or proceeds from the sale of a business.Legal and Compensation Payments: Funds received from legal settlements, including insurance claims, divorce settlements, accident compensations, etc.Inheritances and Gifts: Money or assets received as an inheritance, gift, or through trust distributions.Investment Earnings: Profits derived from investments such as cryptocurrencies, stocks, bonds, private equity, or venture capital.
• initialDepositType string enum
  The type of initial deposit being made
  Fiat CurrencyCrypto / Digital Assets
  Fiat CurrencyCrypto / Digital Assets
• expectedMonthlyDeposits string enum
  The expected monthly deposit amount range
  0-10 Transactions11-20 Transactions21+ Transactions
  0-10 Transactions11-20 Transactions21+ Transactions
• expectedMonthlyWithdrawals string enum
  The expected monthly withdrawal amount range
  0-10 Transactions11-20 Transactions21+ Transactions
  0-10 Transactions11-20 Transactions21+ Transactions
• phoneNumber string
  The phone number of the individual. Required for EU unregulated clients.

  at least 1 characters
• birthdate string date
  The birthdate of the individual (YYYY-MM-DD)
• countryOfCitizenship string
  The country of citizenship (ISO Alpha-2 or Alpha-3 country code)

  at least 1 characters
• countryOfResidence string
  The country of residence (ISO Alpha-2 or Alpha-3 country code)

  at least 1 characters
• govIdCountryOfIssuance string
  The country of issuance of the government ID (ISO Alpha-2 or Alpha-3 country code)

  at least 1 characters
• politicallyExposedPerson boolean
  Whether the individual is a Politically Exposed Person (PEP)
  False True
• addressStreet1 string
  The street address line 1

  at least 1 characters
• addressCity string
  The city of residence

  at least 1 characters
• addressSubdivision string
  The state, province, or region of residence

  at least 1 characters
• country string
  The country of the address (ISO Alpha-2 or Alpha-3 country code)

  at least 1 characters
• identificationNumber object

  Tax identification number for US individuals (SSN or ITIN).

  Required for US citizens (SSN) and US residents (SSN or ITIN). Non-US individuals may optionally submit SSN or ITIN if held (e.g. dual nationals, former US residents). For other identification documents (e.g., passport, driver's license), use the Submit KYC Documents endpoint after creating the KYC identity

  matches ^(\d{3}-\d{2}-\d{4}|\d{9})$
• addressStreet2 string
  The street address line 2

  at least 1 characters
• addressPostalCode string
  The postal or ZIP code

  at least 1 characters
• digitalAssetWalletAddress string
  A digital asset wallet address of the individual where funds will be deposited from

  at least 1 characters
• notionalTradedEachMonth number
  The estimated notional amount traded per month in USD
• isEntity boolean
  True, if the account represents a business entity. False, if the account represents an individual
  False True
• enterpriseName string
  The legal name of the individual or entity

  at least 1 characters
• countryOfIncorporation string
  The country of incorporation (ISO Alpha-2 or Alpha-3 country code)

  at least 1 characters
• dateOfIncorporation string date
  The date of incorporation (YYYY-MM-DD)
• dateOfBirth object
  The date of birth of the individual
  dateOfBirth object

  • day string DD required
  • month string MM required
  • year string YYYY required
• taxId string
  The tax identification number

  at least 1 characters
• idvPerformed boolean
  Whether identity verification has been performed by the EU CaaS client
  False True

Responses