Ctrl+K

Update KYB Identity

patch/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.

Path Parameters

  • identityIdstringRequired
    The unique ID of the identity to update

Request Body

Body
finalizeSubmission boolean
Whether identity is ready for final submission and requirements validation
requestedProducts array[object]
List of products to update
name string required
bitgoOrg string required
country
Country (formatted as ISO 3166-1 alpha-3)
subdivision string
State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
Min length: >= 1 characters
Max length: <= 3 characters
individual object
nameFirst string
First name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast string
Last name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate object
Birthdate
phoneNumber object
occupation string
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) Weapons Dealers
countryOfCitizenship
Country of citizenship (ISO 3166-1 alpha-3)
countryOfResidence
Country of residence (ISO 3166-1 alpha-3)
govIdCountryOfIssuance
Country where government ID was issued (ISO 3166-1 alpha-3)
address object
identificationNumber string
National identification number (e.g., SSN, passport number)
politicallyExposedPerson boolean
Whether the individual is a politically exposed person
business object
businessName string
Legal name of the business
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
incorporationCountryCode
Country of incorporation (ISO 3166-1 alpha-3)
primaryOperationsCountryCode
Primary country of operations (ISO 3166-1 alpha-3)
einTinIdentificationNumber string
EIN/TIN of the business
otherEntityId string
Any additional entity identifier
physicalBusinessAddress object
mailingAddress object
billingAddress object
legalEntityStructure string
Business entity legal structure used to filter requirements (enum).
Allowed values: llc corporationCAndS partnershipLimitedAndLLP generalPartnership trusts privateInvestmentOrFoundation unincorporatedBusiness soleProprietorship governmentOwned publiclyTraded supranationalBodies specialPurposeVehicle segregatedPortfolioCompany
formationDate string
Business formation date (YYYY-MM-DD)
dbaName string
DBA (Doing Business As) name
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
companyWebsiteAddress string <uri>
Official company website
primaryBusinessType string
Primary type of business
Allowed values: 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
Whether the business is institutional
descriptionBusinessActivities string
Short description of the business
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
billingContact object
authorizedSigner object
tradeStrategy string
Trading strategy of the business
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
activeCoinTokens string
Active cryptocurrencies traded
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
tradeVolumeUsd string
Estimated trade volume in USD
activeExchanges string
List of active exchanges
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
diligenceRetailInstitutional string
Diligence level required (retail or institutional)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
customerBaseLocations string
Locations of customer base
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
sanctionAffiliates boolean
Whether the business has sanctioned affiliates
hasAuditor boolean
Whether the business has an auditor
firmAuditor string
Name of audit firm (if applicable)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
hasLegalCounsel boolean
Whether the business has legal counsel
diligenceCounselName string
Name of legal counsel (if applicable)
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,]+$
walletAddress string
Business wallet address
associatedPeople array[object]
List of associated people to update
role string required
Role of the associated person
Allowed values: beneficialOwner controlPerson platformAdmin
percentageOwnership number
Percentage of ownership (only for beneficialOwner)
Minimum: >= 0
Maximum: <= 100
identityId string required
Identity ID of the person
documents array[object]
List of documents to update
id string required
Internal ID for the document association
documentId string required
External document service ID
documentType string required
Type of document
Allowed values: 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
Verification status
Allowed values: missing countExceeded submitted inReview verified

200 Response

One of
type string required
Type of identity
Allowed value: individual
userId string required
The ID of the user
individual object required
nameFirst string
First name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast string
Last name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate object
Birthdate
phoneNumber object
occupation string
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) Weapons Dealers
countryOfCitizenship
Country of citizenship (ISO 3166-1 alpha-3)
countryOfResidence
Country of residence (ISO 3166-1 alpha-3)
govIdCountryOfIssuance
Country where government ID was issued (ISO 3166-1 alpha-3)
address object
identificationNumber string
National identification number (e.g., SSN, passport number)
politicallyExposedPerson boolean
Whether the individual is a politically exposed person
id string required
The unique ID of the created identity
ignoredFields array[string]
Ignored fields
requestedProducts array[object] required
List of products requested for this identity
id string required
Unique identifier for the requested permission
name string required
Name of the permission
bitgoOrg string required
The entity granting the permission
country
The country where the permission is being requested
subdivision string
The subdivision where the permission is being requested
Min length: >= 1 characters
Max length: <= 3 characters
status string required
Status of the requested permission
Allowed values: missingLocation missingEntityStructure missingRequirements readyForSubmission inReview approved rejected
requirements array[object] required
List of requirements related to the identity
id string required
Unique identifier for the requirement
kind string required
Type of requirement
Allowed values: businessInformation data document associatedPerson
name string required
Name of the requirement
status string required
Current status of the requirement
Allowed values: missing countExceeded submitted inReview verified
minRequired number
Minimum number required (for associated persons)
maxAllowed number
Maximum number allowed (for associated persons)
documents array[object]
List of documents associated with the identity
id string required
Internal ID for the document association
documentId string required
External document service ID
documentType string required
Type of document
Allowed values: 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
Verification status
Allowed values: missing countExceeded submitted inReview verified
finalizeSubmission boolean required
Whether identity is ready for final submission and requirements validation

400 Response

error string required
Description of the error
details array[string]
Detailed error messages

401 Response

error string required
Description of the error
details array[string]
Detailed error messages

404 Response

500 Response