Ctrl+K

Update KYC Identity

patch/api/evs/v1/identity/{id}

Update an existing KYC identity with new information.

Path Parameters

  • idstringRequired

Request Body

enterpriseId string
The BitGo enterprise ID
Min length: >= 1 characters
userId string
The BitGo user ID
Min length: >= 1 characters
organizationId string
The Bitgo organization ID
Min length: >= 1 characters
nameFirst string
The first name
Min length: >= 1 characters
nameLast string
The last name
Min length: >= 1 characters
nameMiddle string
The middle name
Min length: >= 1 characters
debugStatus string
Debug status for simulating verification failure or success in the test environment - passes by default
Allowed values: passed failed
debugFailureReason string
Debug failure reason to provide additional context when simulating verification failure in the test environment
Min length: >= 1 characters
contractSignerNameFull string
The full name of the individual signing the contract
Min length: >= 1 characters
contractSignedDate string <date>
The date the contract was signed (YYYY-MM-DD)
Example: 2024-12-20T00:00:00.000Z
contractSignedIPAddress string
The IP address from which the contract was signed
Min length: >= 1 characters
contractVersion string
The version of the contract being signed
Min length: >= 1 characters
userAgreesToTerms boolean
Whether the user agrees to the terms and conditions
occupation string
The occupation category of the individual
Allowed values: Agriculture Art Dealer / Auctioneer / Import / Export Company Financial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co) Casinos and Gambling Establishments Charity/NGO/Non-Profit/Foundation/Endowment Computer Programmer / Administrator / Software Engineer / IT or Software / Technology Company Crypto Services (ATM, Exchange, Lender, Coins/Token) Education / Teacher Extractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious Metals Family Office Film / TV / Entertainment (not adult) Government/State owned/Political Org. (i.e. Sovereign Wealth Fund) Healthcare Law Enforcement / Military / Protective Services Miner / Mining Pool Money Service Business Other Private Equity / Venture Capital Professional Service Providers (lawyers accountants etc.) Real estate brokers developers and appraisers Recreation / Hospitality Student / Unemployed / Retired Traders / Trading (High Frequency, Proprietary, Market Maker) Other - Default Weapons Dealers
annualIncome string
The annual income range of the individual
Allowed values: Under $50,000 $50,001 - $100,000 $100,001 - $300,000 $300,001 - $500,000 $500,001 and over
netWorth string
The net worth range of the individual
Allowed values: 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
The primary source of the individual's net worth
Allowed values: 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
The type of initial deposit being made
Allowed values: Fiat Currency Crypto / Digital Assets
expectedMonthlyDeposits string
The expected monthly deposit amount range
Allowed values: 0-10 Transactions 11-20 Transactions 21+ Transactions
expectedMonthlyWithdrawals string
The expected monthly withdrawal amount range
Allowed values: 0-10 Transactions 11-20 Transactions 21+ Transactions
phoneNumber string
The phone number of the individual
Min length: >= 1 characters
birthdate string <date>
The birthdate of the individual (YYYY-MM-DD)
Example: 2000-12-25T00:00:00.000Z
countryOfCitizenship string
The country of citizenship (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
countryOfResidence string
The country of residence (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
govIdCountryOfIssuance string
The country of issuance of the government ID (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
politicallyExposedPerson boolean
Whether the individual is a Politically Exposed Person (PEP)
addressStreet1 string
The street address line 1
Min length: >= 1 characters
addressCity string
The city of residence
Min length: >= 1 characters
addressSubdivision string
The state, province, or region of residence
Min length: >= 1 characters
Example: CA
country string
The country of the address (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
identificationNumber string
The Social Security Number (SSN) for US citizens Use this field only to submit the SSN for US citizens. For non-US citizens or for submitting other identification documents (e.g., passport, driver's license), use the [Submit KYC Documents](https://developers.bitgo.com/reference/entityvalidationidentitydocumentcreate) endpoint after creating the KYC identity
Min length: >= 1 characters
Example: 123-45-6789
addressStreet2 string
The street address line 2
Min length: >= 1 characters
addressPostalCode string
The postal or ZIP code
Min length: >= 1 characters
digitalAssetWalletAddress string
A digital asset wallet address of the individual where funds will be deposited from
Min length: >= 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
enterpriseName string
The legal name of the individual or entity
Min length: >= 1 characters
countryOfIncorporation string
The country of incorporation (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
dateOfIncorporation string <date>
The date of incorporation (YYYY-MM-DD)
Example: 2000-12-25T00:00:00.000Z

200 Response

id string required
status string required
The status of the KYC identity: `initiating`, `awaiting document upload`, `input error`, `ssn error`, `in review`, `incomplete verifications`, `awaiting signature`, `records uploaded`, `approved`, `declined`
Min length: >= 1 characters
organizationId string required
Min length: >= 1 characters
enterpriseId string
Min length: >= 1 characters
userId string
Min length: >= 1 characters
createdAt string <date-time>
updatedAt string <date-time>
errorDescription string
Min length: >= 1 characters
signaturesSubmitted array[string]
Allowed values: csa mpa mic wvr
signaturesRequired array[string]
Allowed values: csa mpa mic wvr

400 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

401 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

403 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

404 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required