/api/identity-service/v1/identities/{identityId}
Update an existing identity with new information. Requires User-Id header and user can only update identities they created. Only the fields provided in the request body will be updated.
identityId
stringRequiredfinalizeSubmission
boolean requestedProducts
array[object] name
string required bitgoOrg
string required country
subdivision
string >= 1 characters
<= 3 characters
individual
object nameFirst
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate
object phoneNumber
object occupation
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
countryOfCitizenship
countryOfResidence
govIdCountryOfIssuance
address
object identificationNumber
string politicallyExposedPerson
boolean business
object businessName
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
incorporationCountryCode
primaryOperationsCountryCode
einTinIdentificationNumber
string otherEntityId
string physicalBusinessAddress
object mailingAddress
object billingAddress
object legalEntityStructure
string llc
corporationCAndS
partnershipLimitedAndLLP
generalPartnership
trusts
privateInvestmentOrFoundation
unincorporatedBusiness
soleProprietorship
governmentOwned
publiclyTraded
supranationalBodies
specialPurposeVehicle
segregatedPortfolioCompany
formationDate
string dbaName
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
companyWebsiteAddress
string <uri>
primaryBusinessType
string Crypto Services (Exchange, ATM, Borrow/Lend)
Crypto Solutions (DAO, Staking, CaaS, hot wallet provider, miner/mining pool, coins/tokens (developer, issuer, foundation))
Custodian
Agriculture
Arts, Media, Entertainment
Asset Management (i.e. revocable/irrevocable trust, IRA, pension fund)
Bank
Broker/Dealer
Casinos and Gambling Establishments
Charity/NGO/Non-profit/Foundation/Endowment
Commodities/Futures Commission Merchant
Corporate Holding Company
Education
Energy companies
Family Office
Food, hospitality, and tourism
Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)
Import/Export Companies
Industrial (construction, manufacturing, textiles, chemicals, etc.)
Insurance Company
Law Enforcement / Military / Protective Services
Marijuana-related Business
Money Services Business (MSB)
Mutual Funds
NBFI (Venture Capital Fund, Hedge Fund, Private Equity Fund, Pooled Investment Fund, Index Fund, ETF Issuer, Registered Investment Advisor, Prime Brokerage)
OTC
Other
Payment Platforms
Personal Holding Company
Private Equity / Venture Capital
Private Investment Companies / International Business Corporations
Professional Service Providers (lawyers, accountants, etc.)
Real estate brokers, developers, and appraisers
Retail Lender
Software or Technology Company
Traders / Trading (High Frequency, Proprietary, Market Maker)
Transportation & Shipping
Weapons Dealers
primaryBusinessTypeInstitutional
boolean descriptionBusinessActivities
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
billingContact
object authorizedSigner
object tradeStrategy
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
activeCoinTokens
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
tradeVolumeUsd
string activeExchanges
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
diligenceRetailInstitutional
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
customerBaseLocations
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
sanctionAffiliates
boolean hasAuditor
boolean firmAuditor
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
hasLegalCounsel
boolean diligenceCounselName
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
walletAddress
string associatedPeople
array[object] role
string required beneficialOwner
controlPerson
platformAdmin
percentageOwnership
number >= 0
<= 100
identityId
string required documents
array[object] id
string required documentId
string required documentType
string required governmentId
commercialRegister
articlesOfAssociation
certificateOfIncorporation
certificateOfTrust
certificateOfIncumbency
certificateOfIncumbencyOrShareRegister
proofOfPrincipalPlaceOfBusiness
activeTradeLicense
resolutionToOpenBitgoUaeAccount
resolutionToOpenBitgoSingaporeAccount
proofOfAuthorizedSignatories
memorandumOfAssociation
memorandumAndArticlesOfAssociation
bylawsOrOperatingAgreement
operatingAgreement
w8
w9
evidenceOfLegalStatus
evidenceOfActiveStatus
proofOfJfsaLicense
proofOfGamingLicense
organizationDocument
partnershipAgreement
articlesOfOrganization
businessLicenseOrRegistration
evidenceOfGovernmentOrStateOwnership
secFilingsAsEvidenceOfPublicTradingStatus
foundingTreatyOrEquivalent
status
string required missing
countExceeded
submitted
inReview
verified
type
string required individual
userId
string required individual
object required nameFirst
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate
object phoneNumber
object occupation
string ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
countryOfCitizenship
countryOfResidence
govIdCountryOfIssuance
address
object identificationNumber
string politicallyExposedPerson
boolean id
string required ignoredFields
array[string] requestedProducts
array[object] required id
string required name
string required bitgoOrg
string required country
subdivision
string >= 1 characters
<= 3 characters
status
string required missingLocation
missingEntityStructure
missingRequirements
readyForSubmission
inReview
approved
rejected
requirements
array[object] required id
string required kind
string required businessInformation
data
document
associatedPerson
name
string required status
string required missing
countExceeded
submitted
inReview
verified
minRequired
number maxAllowed
number documents
array[object] id
string required documentId
string required documentType
string required governmentId
commercialRegister
articlesOfAssociation
certificateOfIncorporation
certificateOfTrust
certificateOfIncumbency
certificateOfIncumbencyOrShareRegister
proofOfPrincipalPlaceOfBusiness
activeTradeLicense
resolutionToOpenBitgoUaeAccount
resolutionToOpenBitgoSingaporeAccount
proofOfAuthorizedSignatories
memorandumOfAssociation
memorandumAndArticlesOfAssociation
bylawsOrOperatingAgreement
operatingAgreement
w8
w9
evidenceOfLegalStatus
evidenceOfActiveStatus
proofOfJfsaLicense
proofOfGamingLicense
organizationDocument
partnershipAgreement
articlesOfOrganization
businessLicenseOrRegistration
evidenceOfGovernmentOrStateOwnership
secFilingsAsEvidenceOfPublicTradingStatus
foundingTreatyOrEquivalent
status
string required missing
countExceeded
submitted
inReview
verified
finalizeSubmission
boolean required error
string required details
array[string] error
string required details
array[string]