Ctrl+K

Create KYC Identity V2

post/api/evs/v2/identity

Marks a user identity as scheduled to be created later by the identity creation worker.

Request Body

One of
addressCity string required
The city of residence
Min length: >= 1 characters
addressPostalCode string
The postal or ZIP code
Min length: >= 1 characters
addressStreet1 string required
The street address line 1
Min length: >= 1 characters
addressStreet2 string
The street address line 2
Min length: >= 1 characters
addressSubdivision string required
The state, province, or region of residence
Min length: >= 1 characters
Example: CA
birthdate string <date>required
The birthdate of the individual (YYYY-MM-DD)
Example: 2000-12-25T00:00:00.000Z
country string required
The country of the address (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
countryOfCitizenship string required
The country of citizenship (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
countryOfResidence string required
The country of residence (ISO Alpha-2 or Alpha-3 country code)
Min length: >= 1 characters
Example: US
debugFailureReason string
Debug failure reason to provide additional context when simulating verification failure in the test environment
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
digitalAssetWalletAddress string
A digital asset wallet address of the individual where funds will be deposited from
Min length: >= 1 characters
enterpriseId string required
The BitGo enterprise ID
Min length: >= 1 characters
govIdCountryOfIssuance string required
The country of issuance of the government ID (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
nameFirst string required
The first name (Latin letters, spaces, hyphens, apostrophes, and periods)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
nameLast string required
The last name (Latin letters, spaces, hyphens, apostrophes, and periods)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
nameMiddle string
The middle name (Latin letters, spaces, hyphens, apostrophes, and periods)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
notionalTradedEachMonth number
The estimated notional amount traded per month in USD
occupation string required
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
organizationId string required
The Bitgo organization ID
Min length: >= 1 characters
phoneNumber string required
The phone number of the individual
Min length: >= 1 characters
politicallyExposedPerson boolean required
Whether the individual is a Politically Exposed Person (PEP)
transactionType string required
The type of KYC identity being created
Allowed value: institutionalIndividual
userId string required
The BitGo user ID
Min length: >= 1 characters

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

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