Create KYC Identity

addressCity

string

required

length ≥ 1

The city of residence

addressPostalCode

string

length ≥ 1

The postal or ZIP code

addressStreet1

string

required

length ≥ 1

The street address line 1

addressStreet2

string

length ≥ 1

The street address line 2

addressSubdivision

string

required

length ≥ 1

The state, province, or region of residence

birthdate

date

required

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

country

string

required

length ≥ 1

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

countryOfCitizenship

string

required

length ≥ 1

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

countryOfResidence

string

required

length ≥ 1

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

debugFailureReason

string

length ≥ 1

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

debugStatus

string

enum

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

Allowed:

digitalAssetWalletAddress

string

length ≥ 1

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

enterpriseId

string

required

length ≥ 1

The BitGo enterprise ID

govIdCountryOfIssuance

string

required

length ≥ 1

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

identificationNumber

string

length ≥ 1

Tax identification number for US individuals. Required for US citizens and US residents:

US citizens: Submit SSN (Social Security Number)
US residents (non-citizens): Submit SSN or ITIN (Individual Taxpayer Identification Number)
Non-US individuals: Do not use this field. Instead, use the Submit KYC Documents endpoint to upload government-issued identification documents after creating the KYC identity

nameFirst

string

required

The first name (Latin letters, spaces, hyphens, apostrophes, and periods)

nameLast

string

required

The last name (Latin letters, spaces, hyphens, apostrophes, and periods)

nameMiddle

string

The middle name (Latin letters, spaces, hyphens, apostrophes, and periods)

notionalTradedEachMonth

number

The estimated notional amount traded per month in USD

occupation

string

enum

required

The occupation category of the individual

organizationId

string

required

length ≥ 1

The Bitgo organization ID

phoneNumber

string

required

length ≥ 1

The phone number of the individual

politicallyExposedPerson

boolean

required

Whether the individual is a Politically Exposed Person (PEP)

transactionType

string

enum

required

The type of KYC identity being created

Allowed:

userId

string

required

length ≥ 1

The BitGo user ID

200OK

400Bad Request

401Unauthorized

403Forbidden