Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Know Your Customer (KYC)

Update KYC Identity

Update an existing KYC identity with new information.

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

Path parameters

idstring required

Request body

enterpriseIdstring

The BitGo enterprise ID

userIdstring

The BitGo user ID

organizationIdstring

The Bitgo organization ID

nameFirststring

The first name

nameLaststring

The last name

nameMiddlestring

The middle name

debugStatus'passed' | 'failed'

Debug status for simulating verification failure or success in the test environment - passes by default

debugFailureReasonstring

Debug failure reason to provide additional context when simulating verification failure in the test environment

contractSignerNameFullstring

The full name of the individual signing the contract

contractSignedDatestring date

The date the contract was signed (YYYY-MM-DD)

contractSignedIPAddressstring

The IP address from which the contract was signed

contractVersionstring

The version of the contract being signed

userAgreesToTermsboolean

Whether the user agrees to the terms and conditions

occupation'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'

The occupation category of the individual

annualIncome'Under $50,000' | '$50,001 - $100,000' | '$100,001 - $300,000' | '$300,001 - $500,000' | '$500,001 and over'

The annual income range of the individual

netWorth'Under $100,000' | '$100,001 - $500,000' | '$500,001 - $1,000,000' | '$1,000,001 - $5,000,000' | '$5,000,001 and over'

The net worth range of the individual

sourceOfNetWorth'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.'

The primary source of the individual's net worth

initialDepositType'Fiat Currency' | 'Crypto / Digital Assets'

The type of initial deposit being made

expectedMonthlyDeposits'0-10 Transactions' | '11-20 Transactions' | '21+ Transactions'

The expected monthly deposit amount range

expectedMonthlyWithdrawals'0-10 Transactions' | '11-20 Transactions' | '21+ Transactions'

The expected monthly withdrawal amount range

phoneNumberstring

The phone number of the individual. Required for EU unregulated clients.

birthdatestring date

The birthdate of the individual (YYYY-MM-DD)

countryOfCitizenshipstring

The country of citizenship (ISO Alpha-2 or Alpha-3 country code)

countryOfResidencestring

The country of residence (ISO Alpha-2 or Alpha-3 country code)

govIdCountryOfIssuancestring

The country of issuance of the government ID (ISO Alpha-2 or Alpha-3 country code)

politicallyExposedPersonboolean

Whether the individual is a Politically Exposed Person (PEP)

addressStreet1string

The street address line 1

addressCitystring

The city of residence

addressSubdivisionstring

The state, province, or region of residence

countrystring

The country of the address (ISO Alpha-2 or Alpha-3 country code)

identificationNumberstring

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

addressStreet2string

The street address line 2

addressPostalCodestring

The postal or ZIP code

digitalAssetWalletAddressstring

A digital asset wallet address of the individual where funds will be deposited from

notionalTradedEachMonthnumber

The estimated notional amount traded per month in USD

isEntityboolean

True, if the account represents a business entity. False, if the account represents an individual

enterpriseNamestring

The legal name of the individual or entity

countryOfIncorporationstring

The country of incorporation (ISO Alpha-2 or Alpha-3 country code)

dateOfIncorporationstring date

The date of incorporation (YYYY-MM-DD)

taxIdstring

The tax identification number

idvPerformedboolean

Whether identity verification has been performed by the EU CaaS client

Example request

{
  "contractSignedDate": "2024-12-20T00:00:00.000Z",
  "birthdate": "2000-12-25T00:00:00.000Z",
  "countryOfCitizenship": "US",
  "countryOfResidence": "US",
  "govIdCountryOfIssuance": "US",
  "addressSubdivision": "CA",
  "country": "US",
  "identificationNumber": "123-45-6789",
  "countryOfIncorporation": "US",
  "dateOfIncorporation": "2000-12-25T00:00:00.000Z",
  "dateOfBirth": {
    "day": "25",
    "month": "12",
    "year": "2024"
  }
}

Response

OK

idstring required
statusstring required

The status of the KYC identity: initiating, awaiting document upload, input error, ssn error, taxid error, in review, incomplete verifications, awaiting signature, records uploaded, approved, declined

organizationIdstring required
enterpriseIdstring
userIdstring
createdAtstring date-time
updatedAtstring date-time
errorDescriptionstring
signaturesSubmittedstring[]
signaturesRequiredstring[]