Update KYC Identity

patch

https://app.bitgo-test.com/api/evs/v1/identity/{id}

Update an existing KYC identity with new information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

enterpriseId

string

length ≥ 1

The BitGo enterprise ID

userId

string

length ≥ 1

The BitGo user ID

organizationId

string

length ≥ 1

The Bitgo organization ID

nameFirst

string

length ≥ 1

The first name

nameLast

string

length ≥ 1

The last name

nameMiddle

string

length ≥ 1

The middle name

debugStatus

string

enum

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

Allowed:

debugFailureReason

string

length ≥ 1

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

contractSignerNameFull

string

length ≥ 1

The full name of the individual signing the contract

contractSignedDate

date

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

contractSignedIPAddress

string

length ≥ 1

The IP address from which the contract was signed

contractVersion

string

length ≥ 1

The version of the contract being signed

userAgreesToTerms

boolean

Whether the user agrees to the terms and conditions

occupation

string

enum

The occupation category of the individual

annualIncome

string

enum

The annual income range of the individual

Allowed:

netWorth

string

enum

The net worth range of the individual

Allowed:

sourceOfNetWorth

string

enum

The primary source of the individual's net worth

Allowed:

initialDepositType

string

enum

The type of initial deposit being made

Allowed:

expectedMonthlyDeposits

string

enum

The expected monthly deposit amount range

Allowed:

expectedMonthlyWithdrawals

string

enum

The expected monthly withdrawal amount range

Allowed:

phoneNumber

string

length ≥ 1

The phone number of the individual

birthdate

date

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

countryOfCitizenship

string

length ≥ 1

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

countryOfResidence

string

length ≥ 1

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

govIdCountryOfIssuance

string

length ≥ 1

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

politicallyExposedPerson

boolean

Whether the individual is a Politically Exposed Person (PEP)

addressStreet1

string

length ≥ 1

The street address line 1

addressCity

string

length ≥ 1

The city of residence

addressSubdivision

string

length ≥ 1

The state, province, or region of residence

country

string

length ≥ 1

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

identificationNumber

string

length ≥ 1

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 endpoint after creating the KYC identity

addressStreet2

string

length ≥ 1

The street address line 2

addressPostalCode

string

length ≥ 1

The postal or ZIP code

digitalAssetWalletAddress

string

length ≥ 1

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

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

length ≥ 1

The legal name of the individual or entity

countryOfIncorporation

string

length ≥ 1

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

dateOfIncorporation

date

The date of incorporation (YYYY-MM-DD)

dateOfBirth

object

The date of birth of the individual

taxId

string

length ≥ 1

The tax identification number

idvPerformed

boolean

Whether identity verification has been performed by the EU CaaS client

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found