PATCH

Update KYB Identity

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 Params

identityId string required

The unique ID of the identity to update

Body Params

object

finalizeSubmission boolean

Whether identity is ready for final submission and requirements validation
requestedProducts array of objects

List of products to update
requestedProducts object
- name string enum required
  
  BitGo products available via KYB API
  
  TradeInstant Fee WalletsHot Self-CustodyCold Self-CustodyCustodyDeFiStakingGo AccountACH DebitsDistributed Custody
- bitgoOrg string enum required
  
  BitGo organization types
  
  BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Mena FzeBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
- country object
  
  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)
  
  1 to 3 characters
individual object
individual object
- nameFirst string
  
  First name of the individual
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
- nameLast string
  
  Last name of the individual
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
- birthdate object
  
  Birthdate
  birthdate object
  - month string required
    
    birthdate month (MM, e.g. "06")
    
    matches ^\d{2}$
  - day string required
    
    birthdate day (DD, e.g. "15")
    
    matches ^\d{2}$
  - year string required
    
    birthdate year (YYYY, e.g. "1990")
    
    matches ^\d{4}$
- phoneNumber object
  phoneNumber object
  - countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
  - phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- email string email
  
  Email address of the individual
- occupation string enum
  
  Occupation category of the individual
  
  AgricultureArt Dealer / Auctioneer / Import / Export CompanyFinancial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co)Casinos and Gambling EstablishmentsCharity/NGO/Non-Profit/Foundation/EndowmentComputer Programmer / Administrator / Software Engineer / IT or Software / Technology CompanyCrypto Services (ATM, Exchange, Lender, Coins/Token)Education / TeacherExtractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious MetalsFamily OfficeFilm / TV / Entertainment (not adult)Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)HealthcareLaw Enforcement / Military / Protective ServicesMiner / Mining PoolMoney Service BusinessOtherPrivate Equity / Venture CapitalProfessional Service Providers (lawyers accountants etc.)Real estate brokers developers and appraisersRecreation / HospitalityStudent / Unemployed / RetiredTraders / Trading (High Frequency, Proprietary, Market Maker)Weapons Dealers
- countryOfCitizenship object
  
  Country of citizenship (ISO 3166-1 alpha-3)
- countryOfResidence object
  
  Country of residence (ISO 3166-1 alpha-3)
- govIdCountryOfIssuance object
  
  Country where government ID was issued (ISO 3166-1 alpha-3)
- govIdClass string enum
  
  Class of government ID. Valid values: cct - Citizenship Certificate, cid - Consular ID, dl - Driver's License, foid - CO Foreigner ID, hic - Health Insurance Card, id - Identification Card, ipp - Internal Passport, keyp - AU Keypass ID, ltpass - Long Term Pass, munid - US Municipal ID (e.g. NYC ID), myn - JP My Number Card (SSN), nbi - PH National Bureau of Investigation Certificate, nric - SG National Residency ID, ofw - PH Overseas Foreign Worker Card, rp - Residence Permit, pan - IN Permanent Account Number card (SSN), pid - PH Postal Identity Card, pp - Passport, ppc - Passport Card, pr - Permanent Residence Card, sss - PH Social Security System Card (SSN), td - US Travel Document, tribalid - US/CA Tribal ID, umid - PH Unified Multi Purpose ID, vid - Voter ID, visa - Visa, wp - Work Permit
  
  cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp
- address object
  address object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- identificationNumber string
  
  National identification number (e.g., SSN, passport number)
- politicallyExposedPerson boolean
  
  Whether the individual is a politically exposed person
business object
business object
- businessName string
  
  Legal name of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
- incorporationCountryCode object
  
  Country of incorporation (ISO 3166-1 alpha-3)
- primaryOperationsCountryCode object
  
  Primary country of operations (ISO 3166-1 alpha-3)
- einTinIdentificationNumber string
  
  EIN/TIN of the business
- otherEntityId string
  
  Any additional entity identifier (e.g. company registration name or official registry ID)
- physicalBusinessAddress object
  physicalBusinessAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- mailingAddress object
  mailingAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- billingAddress object
  billingAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- legalEntityStructure string enum
  
  Business entity legal structure used to filter requirements (enum).
  
  llccorporationCAndSpartnershipLimitedAndLLPgeneralPartnershiptrustsprivateInvestmentOrFoundationunincorporatedBusinesssoleProprietorshipgovernmentOwnedpubliclyTradedsupranationalBodiesspecialPurposeVehiclesegregatedPortfolioCompany
- formationDate string
  
  Business formation date (YYYY-MM-DD)
- dbaName string
  
  DBA (Doing Business As) name
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
- companyWebsiteAddress string uri
  
  Official company website
- primaryBusinessType string enum
  
  Primary type of business
  
  Crypto Services (Exchange, ATM, Borrow/Lend)Crypto Solutions (DAO, Staking, CaaS, hot wallet provider, miner/mining pool, coins/tokens (developer, issuer, foundation))CustodianAgricultureArts, Media, EntertainmentAsset Management (i.e. revocable/irrevocable trust, IRA, pension fund)BankBroker/DealerCasinos and Gambling EstablishmentsCharity/NGO/Non-profit/Foundation/EndowmentCommodities/Futures Commission MerchantCorporate Holding CompanyEducationEnergy companiesFamily OfficeFood, hospitality, and tourismGovernment/State owned/Political Org. (i.e. Sovereign Wealth Fund)Import/Export CompaniesIndustrial (construction, manufacturing, textiles, chemicals, etc.)Insurance CompanyLaw Enforcement / Military / Protective ServicesMarijuana-related BusinessMoney Services Business (MSB)Mutual FundsNBFI (Venture Capital Fund, Hedge Fund, Private Equity Fund, Pooled Investment Fund, Index Fund, ETF Issuer, Registered Investment Advisor, Prime Brokerage)OTCOtherPayment PlatformsPersonal Holding CompanyPrivate Equity / Venture CapitalPrivate Investment Companies / International Business CorporationsProfessional Service Providers (lawyers, accountants, etc.)Real estate brokers, developers, and appraisersRetail LenderSoftware or Technology CompanyTraders / Trading (High Frequency, Proprietary, Market Maker)Transportation & ShippingWeapons Dealers
- descriptionBusinessActivities string
  
  Short description of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- billingContact object
  billingContact object
  - nameFirst string required
    
    First name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - nameLast string required
    
    Last name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - emailAddress string email required
    
    Email address
  - phoneNumber object required
    
    phoneNumber object
    
    countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
    
    phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- authorizedSigner object
  authorizedSigner object
  - nameFirst string required
    
    First name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - nameLast string required
    
    Last name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - emailAddress string email required
    
    Email address
  - phoneNumber object required
    
    phoneNumber object
    
    countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
    
    phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- tradeStrategy string
  
  Trading strategy of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- activeCoinTokens string
  
  Active cryptocurrencies traded
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- tradeVolumeUsd string
  
  Estimated trade volume in USD
- activeExchanges string
  
  List of active exchanges
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- diligenceRetailInstitutional string enum
  
  Percentage breakdown of retail vs institutional customer base
  
  retail0To25retail25To50retail50To75retail75To100
- customerBaseLocations string
  
  Locations of customer base
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- sanctionAffiliates boolean
  
  Whether the business has sanctioned affiliates
- hasAuditor boolean
  
  Whether the business has an auditor
- firmAuditor string nullable
  
  Name of audit firm (if applicable)
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- hasLegalCounsel boolean
  
  Whether the business has legal counsel
- diligenceCounselName string nullable
  
  Name of legal counsel (if applicable)
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- walletAddress string
  
  Business wallet address
- isRegulated boolean
  
  Whether the business is regulated
- regulatorCountryCode object nullable
  
  Country of regulator (ISO 3166-1 alpha-3)
- regulatorName string nullable
  
  Name of the regulator
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- regulatoryRegistrationNumber string nullable
  
  Regulatory registration number
- amlAttestation object
  
  AML attestation data (who attested, when, and the yes/no answer)
  amlAttestation object
  - userId string required
    
    BitGo user ID of the person performing the attestation
    
    32 to 32 characters
  - attestationDate string date-time required
    
    ISO 8601 date of the attestation
  - attested boolean required
    
    Whether the AML attestation was affirmed
- fundsSource string enum
  
  Whether funds deposited are proprietary or customer funds
  
  proprietarycustomer
- diligenceMaterialFindings boolean
  
  Has there been any recent Financial Crime related civil or criminal proceedings, regulatory actions, or findings against the company in the past year?
- diligenceMaterialFindingsDescription string nullable
  
  Description of material findings (required if diligenceMaterialFindings is true)
- prescreenWalletAddressAtm boolean
  
  Does the business pre-screen wallet addresses at ATMs?
- outsourcedFunctions boolean
  
  Does the business outsource any AML/compliance functions?
- outsourcedVendors string nullable
  
  Names of vendors providing outsourced functions (required if outsourcedFunctions is true)
- diligenceFinancialInstitutionsUsed string
  
  Financial institutions used by the business
- diligenceCanReceiveThirdPartyPayments boolean
  
  Can the business receive payments from third parties?
- diligenceCanSendRemittances string enum
  
  Can the business send remittances?
  
  yesBothFiatAndCryptoyesFiatyesCryptonoother
- diligenceRemittancesOther string nullable
  
  Description of remittance type (required if diligenceCanSendRemittances is "other")
- diligenceAllowWhitelist boolean
  
  Does the business allow wallet address whitelisting?
associatedPeople array of objects

List of associated people to update
associatedPeople object
- role string enum required
  
  Role of the associated person
  
  beneficialOwnercontrolPersonplatformAdmin
- percentageOwnership number
  
  Percentage of ownership (only for beneficialOwner, minimum 10%)
  
  >= 10 · <= 100
- identityId string required
  
  Identity ID of the person
documents array of objects

List of documents to update
documents object
- id string required
  
  Internal ID for the document association
- documentId string required
  
  External document service ID
- documentType string enum required
  
  Type of document being uploaded
  
  governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalent
- status string enum required
  
  Verification status
  
  missingcountExceededsubmittedinReviewverified

Responses

200

Response Body

ONE OF

type string enum required

Type of identity

individual
userId string required

The ID of the user
individual object required
individual object
- nameFirst string
  
  First name of the individual
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
- nameLast string
  
  Last name of the individual
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
- birthdate object
  
  Birthdate
  birthdate object
  - month string required
    
    birthdate month (MM, e.g. "06")
    
    matches ^\d{2}$
  - day string required
    
    birthdate day (DD, e.g. "15")
    
    matches ^\d{2}$
  - year string required
    
    birthdate year (YYYY, e.g. "1990")
    
    matches ^\d{4}$
- phoneNumber object
  phoneNumber object
  - countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
  - phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- email string email
  
  Email address of the individual
- occupation string enum
  
  Occupation category of the individual
  
  AgricultureArt Dealer / Auctioneer / Import / Export CompanyFinancial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co)Casinos and Gambling EstablishmentsCharity/NGO/Non-Profit/Foundation/EndowmentComputer Programmer / Administrator / Software Engineer / IT or Software / Technology CompanyCrypto Services (ATM, Exchange, Lender, Coins/Token)Education / TeacherExtractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious MetalsFamily OfficeFilm / TV / Entertainment (not adult)Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)HealthcareLaw Enforcement / Military / Protective ServicesMiner / Mining PoolMoney Service BusinessOtherPrivate Equity / Venture CapitalProfessional Service Providers (lawyers accountants etc.)Real estate brokers developers and appraisersRecreation / HospitalityStudent / Unemployed / RetiredTraders / Trading (High Frequency, Proprietary, Market Maker)Weapons Dealers
- countryOfCitizenship object
  
  Country of citizenship (ISO 3166-1 alpha-3)
- countryOfResidence object
  
  Country of residence (ISO 3166-1 alpha-3)
- govIdCountryOfIssuance object
  
  Country where government ID was issued (ISO 3166-1 alpha-3)
- govIdClass string enum
  
  Class of government ID. Valid values: cct - Citizenship Certificate, cid - Consular ID, dl - Driver's License, foid - CO Foreigner ID, hic - Health Insurance Card, id - Identification Card, ipp - Internal Passport, keyp - AU Keypass ID, ltpass - Long Term Pass, munid - US Municipal ID (e.g. NYC ID), myn - JP My Number Card (SSN), nbi - PH National Bureau of Investigation Certificate, nric - SG National Residency ID, ofw - PH Overseas Foreign Worker Card, rp - Residence Permit, pan - IN Permanent Account Number card (SSN), pid - PH Postal Identity Card, pp - Passport, ppc - Passport Card, pr - Permanent Residence Card, sss - PH Social Security System Card (SSN), td - US Travel Document, tribalid - US/CA Tribal ID, umid - PH Unified Multi Purpose ID, vid - Voter ID, visa - Visa, wp - Work Permit
  
  cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp
- address object
  address object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- 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 of strings

Ignored fields
requestedProducts array of objects required

List of products requested for this identity
requestedProducts object
- id string required
  
  Unique identifier for the requested permission
- name string enum required
  
  Name of the BitGo product
  
  Instant Fee WalletsGo AccountACH DebitsSettlementTaxTrade APIMargin TradingEllipticCryptoCompareMetaMaskCustodyBorrowingLendingDeFiCold Self-CustodyGo NetworkStakingTradeHot Self-CustodyEscrowEscrow - TripartyDistributed Custody
- bitgoOrg string enum required
  
  The BitGo entity identifier
  
  BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Mena FzeBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
- country object
  
  The country where the permission is being requested
- subdivision string
  
  The subdivision where the permission is being requested
  
  1 to 3 characters
- status string enum required
  
  Status of the requested permission
  
  missingLocationmissingEntityStructuremissingRequirementsreadyForSubmissioninReviewapprovedrejected
requirements array of objects required

List of requirements related to the identity
requirements object
- id string required
  
  Unique identifier for the requirement
- kind string enum required
  
  Type of requirement
  
  businessInformationdatadocumentassociatedPerson
- name string required
  
  Name of the requirement
- status string enum required
  
  Current status of the requirement
  
  missingcountExceededsubmittedinReviewverified
- minRequired number
  
  Minimum number required (for associated persons)
- maxAllowed number
  
  Maximum number allowed (for associated persons)
documents array of objects

List of documents associated with the identity
documents object
- id string required
  
  Internal ID for the document association
- documentId string required
  
  External document service ID
- documentType string enum required
  
  Type of document being uploaded
  
  governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalent
- status string enum required
  
  Verification status
  
  missingcountExceededsubmittedinReviewverified
finalizeSubmission boolean required

Whether identity is ready for final submission and requirements validation

type string enum required

Type of identity

business
organizationId string required

The ID of the organization
enterpriseId string required

The ID of the enterprise
business object required
business object
- businessName string
  
  Legal name of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
- incorporationCountryCode object
  
  Country of incorporation (ISO 3166-1 alpha-3)
- primaryOperationsCountryCode object
  
  Primary country of operations (ISO 3166-1 alpha-3)
- einTinIdentificationNumber string
  
  EIN/TIN of the business
- otherEntityId string
  
  Any additional entity identifier (e.g. company registration name or official registry ID)
- physicalBusinessAddress object
  physicalBusinessAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- mailingAddress object
  mailingAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- billingAddress object
  billingAddress object
  - street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
  - subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
  - zip string required
    
    ZIP or postal code
  - country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
- legalEntityStructure string enum
  
  Business entity legal structure used to filter requirements (enum).
  
  llccorporationCAndSpartnershipLimitedAndLLPgeneralPartnershiptrustsprivateInvestmentOrFoundationunincorporatedBusinesssoleProprietorshipgovernmentOwnedpubliclyTradedsupranationalBodiesspecialPurposeVehiclesegregatedPortfolioCompany
- formationDate string
  
  Business formation date (YYYY-MM-DD)
- dbaName string
  
  DBA (Doing Business As) name
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
- companyWebsiteAddress string uri
  
  Official company website
- primaryBusinessType string enum
  
  Primary type of business
  
  Crypto Services (Exchange, ATM, Borrow/Lend)Crypto Solutions (DAO, Staking, CaaS, hot wallet provider, miner/mining pool, coins/tokens (developer, issuer, foundation))CustodianAgricultureArts, Media, EntertainmentAsset Management (i.e. revocable/irrevocable trust, IRA, pension fund)BankBroker/DealerCasinos and Gambling EstablishmentsCharity/NGO/Non-profit/Foundation/EndowmentCommodities/Futures Commission MerchantCorporate Holding CompanyEducationEnergy companiesFamily OfficeFood, hospitality, and tourismGovernment/State owned/Political Org. (i.e. Sovereign Wealth Fund)Import/Export CompaniesIndustrial (construction, manufacturing, textiles, chemicals, etc.)Insurance CompanyLaw Enforcement / Military / Protective ServicesMarijuana-related BusinessMoney Services Business (MSB)Mutual FundsNBFI (Venture Capital Fund, Hedge Fund, Private Equity Fund, Pooled Investment Fund, Index Fund, ETF Issuer, Registered Investment Advisor, Prime Brokerage)OTCOtherPayment PlatformsPersonal Holding CompanyPrivate Equity / Venture CapitalPrivate Investment Companies / International Business CorporationsProfessional Service Providers (lawyers, accountants, etc.)Real estate brokers, developers, and appraisersRetail LenderSoftware or Technology CompanyTraders / Trading (High Frequency, Proprietary, Market Maker)Transportation & ShippingWeapons Dealers
- descriptionBusinessActivities string
  
  Short description of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- billingContact object
  billingContact object
  - nameFirst string required
    
    First name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - nameLast string required
    
    Last name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - emailAddress string email required
    
    Email address
  - phoneNumber object required
    
    phoneNumber object
    
    countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
    
    phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- authorizedSigner object
  authorizedSigner object
  - nameFirst string required
    
    First name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - nameLast string required
    
    Last name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - emailAddress string email required
    
    Email address
  - phoneNumber object required
    
    phoneNumber object
    
    countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
    
    phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
- tradeStrategy string
  
  Trading strategy of the business
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- activeCoinTokens string
  
  Active cryptocurrencies traded
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- tradeVolumeUsd string
  
  Estimated trade volume in USD
- activeExchanges string
  
  List of active exchanges
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- diligenceRetailInstitutional string enum
  
  Percentage breakdown of retail vs institutional customer base
  
  retail0To25retail25To50retail50To75retail75To100
- customerBaseLocations string
  
  Locations of customer base
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- sanctionAffiliates boolean
  
  Whether the business has sanctioned affiliates
- hasAuditor boolean
  
  Whether the business has an auditor
- firmAuditor string nullable
  
  Name of audit firm (if applicable)
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- hasLegalCounsel boolean
  
  Whether the business has legal counsel
- diligenceCounselName string nullable
  
  Name of legal counsel (if applicable)
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- walletAddress string
  
  Business wallet address
- isRegulated boolean
  
  Whether the business is regulated
- regulatorCountryCode object nullable
  
  Country of regulator (ISO 3166-1 alpha-3)
- regulatorName string nullable
  
  Name of the regulator
  
  matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$
- regulatoryRegistrationNumber string nullable
  
  Regulatory registration number
- amlAttestation object
  
  AML attestation data (who attested, when, and the yes/no answer)
  amlAttestation object
  - userId string required
    
    BitGo user ID of the person performing the attestation
    
    32 to 32 characters
  - attestationDate string date-time required
    
    ISO 8601 date of the attestation
  - attested boolean required
    
    Whether the AML attestation was affirmed
- fundsSource string enum
  
  Whether funds deposited are proprietary or customer funds
  
  proprietarycustomer
- diligenceMaterialFindings boolean
  
  Has there been any recent Financial Crime related civil or criminal proceedings, regulatory actions, or findings against the company in the past year?
- diligenceMaterialFindingsDescription string nullable
  
  Description of material findings (required if diligenceMaterialFindings is true)
- prescreenWalletAddressAtm boolean
  
  Does the business pre-screen wallet addresses at ATMs?
- outsourcedFunctions boolean
  
  Does the business outsource any AML/compliance functions?
- outsourcedVendors string nullable
  
  Names of vendors providing outsourced functions (required if outsourcedFunctions is true)
- diligenceFinancialInstitutionsUsed string
  
  Financial institutions used by the business
- diligenceCanReceiveThirdPartyPayments boolean
  
  Can the business receive payments from third parties?
- diligenceCanSendRemittances string enum
  
  Can the business send remittances?
  
  yesBothFiatAndCryptoyesFiatyesCryptonoother
- diligenceRemittancesOther string nullable
  
  Description of remittance type (required if diligenceCanSendRemittances is "other")
- diligenceAllowWhitelist boolean
  
  Does the business allow wallet address whitelisting?
associatedPeople array of objects required

List of associated people linked to this identity
associatedPeople object
- identityId string required
  
  The individual identity ID of the associated person
- role string enum required
  
  Role of the associated person
  
  beneficialOwnercontrolPersonplatformAdmin
- percentageOwnership number nullable required
  
  Percentage of ownership (only applicable to beneficial owners)
  
  >= 0 · <= 100
- status string enum required
  
  Verification status of the associated person
  
  missingLocationmissingRequirementsreadyForSubmissioninReviewverifiedrejected
- individual object required
  
  Individual data for the associated person
  individual object
  - nameFirst string
    
    First name of the individual
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - nameLast string
    
    Last name of the individual
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\.\-]+$
  - birthdate object
    
    Birthdate
    
    birthdate object
    
    Same shape as Birthdate.
  - phoneNumber object
    
    phoneNumber object
    
    countryCode string required
    
    Country code of the phone number
    
    matches ^[0-9]+$
    
    phoneNumber string required
    
    Phone number (without country code)
    
    matches ^[0-9]+$
  - email string email
    
    Email address of the individual
  - occupation string enum
    
    Occupation category of the individual
    
    AgricultureArt Dealer / Auctioneer / Import / Export CompanyFinancial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co)Casinos and Gambling EstablishmentsCharity/NGO/Non-Profit/Foundation/EndowmentComputer Programmer / Administrator / Software Engineer / IT or Software / Technology CompanyCrypto Services (ATM, Exchange, Lender, Coins/Token)Education / TeacherExtractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious MetalsFamily OfficeFilm / TV / Entertainment (not adult)Government/State owned/Political Org. (i.e. Sovereign Wealth Fund)HealthcareLaw Enforcement / Military / Protective ServicesMiner / Mining PoolMoney Service BusinessOtherPrivate Equity / Venture CapitalProfessional Service Providers (lawyers accountants etc.)Real estate brokers developers and appraisersRecreation / HospitalityStudent / Unemployed / RetiredTraders / Trading (High Frequency, Proprietary, Market Maker)Weapons Dealers
  - countryOfCitizenship object
    
    Country of citizenship (ISO 3166-1 alpha-3)
  - countryOfResidence object
    
    Country of residence (ISO 3166-1 alpha-3)
  - govIdCountryOfIssuance object
    
    Country where government ID was issued (ISO 3166-1 alpha-3)
  - govIdClass string enum
    
    Class of government ID. Valid values: cct - Citizenship Certificate, cid - Consular ID, dl - Driver's License, foid - CO Foreigner ID, hic - Health Insurance Card, id - Identification Card, ipp - Internal Passport, keyp - AU Keypass ID, ltpass - Long Term Pass, munid - US Municipal ID (e.g. NYC ID), myn - JP My Number Card (SSN), nbi - PH National Bureau of Investigation Certificate, nric - SG National Residency ID, ofw - PH Overseas Foreign Worker Card, rp - Residence Permit, pan - IN Permanent Account Number card (SSN), pid - PH Postal Identity Card, pp - Passport, ppc - Passport Card, pr - Permanent Residence Card, sss - PH Social Security System Card (SSN), td - US Travel Document, tribalid - US/CA Tribal ID, umid - PH Unified Multi Purpose ID, vid - Voter ID, visa - Visa, wp - Work Permit
    
    cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp
  - address object
    
    address object
    
    street1 string required
    
    Street address line 1
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
    
    street2 string
    
    Street address line 2
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
    
    city string required
    
    City name
    
    matches ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&]+$
    
    subdivision string required
    
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    
    1 to 3 characters
    
    zip string required
    
    ZIP or postal code
    
    country object required
    
    Country (formatted as ISO 3166-1 alpha-3)
  - identificationNumber string
    
    National identification number (e.g., SSN, passport number)
  - politicallyExposedPerson boolean
    
    Whether the individual is a politically exposed person
- userId string required
  
  User ID of the associated person
- missingRequirements array of objects required
  
  List of missing requirements for the associated person
  missingRequirements object
  - id string required
    
    Unique identifier for the missing requirement
  - kind string enum required
    
    Type of missing requirement
    
    businessInformationdatadocumentassociatedPerson
  - name string required
    
    Name of the missing requirement
  - status string enum required
    
    Current status of the missing requirement
    
    missingcountExceededsubmittedinReviewverified
- documents array of objects
  
  Documents associated with the associated person
  documents object
  - Same shape as Document.
id string required

The unique ID of the created identity
ignoredFields array of strings

Ignored fields
requestedProducts array of objects required

List of products requested for this identity
requestedProducts object
- Same shape as RequestedProductResponse.
requirements array of objects required

List of requirements related to the identity
requirements object
- Same shape as Requirement.
documents array of objects

List of documents associated with the identity
documents object
- Same shape as Document.
finalizeSubmission boolean required

Whether identity is ready for final submission and requirements validation

400

Response Body

object

error string required

Description of the error
details array of strings

401

Response Body

object

error string required

Description of the error
details array of strings

404

No response body

500

No response body

Language

Credentials

Bearer

Request

curl --request PATCH \
     --url 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'content-type: application/json' \
     --data '{,"finalizeSubmission":true,"requestedProducts":[{,"name":"Trade","bitgoOrg":"BitGo Trust","country":"string","subdivision":"string"}],"individual":{,"nameFirst":"string","nameLast":"string","birthdate":{,"month":"string","day":"string","year":"string"},"phoneNumber":{,"countryCode":"string","phoneNumber":"string"},"email":"string","occupation":"Agriculture","countryOfCitizenship":"string","countryOfResidence":"string","govIdCountryOfIssuance":"string","govIdClass":"cct","address":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"identificationNumber":"string","politicallyExposedPerson":true},"business":{,"businessName":"string","incorporationCountryCode":"string","primaryOperationsCountryCode":"string","einTinIdentificationNumber":"string","otherEntityId":"string","physicalBusinessAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"mailingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"billingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"legalEntityStructure":"llc","formationDate":"string","dbaName":"string","companyWebsiteAddress":"string","primaryBusinessType":"Crypto Services (Exchange, ATM, Borrow/Lend)","descriptionBusinessActivities":"string","billingContact":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"authorizedSigner":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"tradeStrategy":"string","activeCoinTokens":"string","tradeVolumeUsd":"string","activeExchanges":"string","diligenceRetailInstitutional":"retail0To25","customerBaseLocations":"string","sanctionAffiliates":true,"hasAuditor":true,"firmAuditor":"string","hasLegalCounsel":true,"diligenceCounselName":"string","walletAddress":"string","isRegulated":true,"regulatorCountryCode":"string","regulatorName":"string","regulatoryRegistrationNumber":"string","amlAttestation":{,"userId":"string","attestationDate":"string","attested":true},"fundsSource":"proprietary","diligenceMaterialFindings":true,"diligenceMaterialFindingsDescription":"string","prescreenWalletAddressAtm":true,"outsourcedFunctions":true,"outsourcedVendors":"string","diligenceFinancialInstitutionsUsed":"string","diligenceCanReceiveThirdPartyPayments":true,"diligenceCanSendRemittances":"yesBothFiatAndCrypto","diligenceRemittancesOther":"string","diligenceAllowWhitelist":true},"associatedPeople":[{,"role":"beneficialOwner","percentageOwnership":0,"identityId":"string"}],"documents":[{,"id":"string","documentId":"string","documentType":"governmentId","status":"missing"}]}'

Request

const url = 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId';
const options = {
  method: 'PATCH',
  headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'},
  body: JSON.stringify({,"finalizeSubmission":true,"requestedProducts":[{,"name":"Trade","bitgoOrg":"BitGo Trust","country":"string","subdivision":"string"}],"individual":{,"nameFirst":"string","nameLast":"string","birthdate":{,"month":"string","day":"string","year":"string"},"phoneNumber":{,"countryCode":"string","phoneNumber":"string"},"email":"string","occupation":"Agriculture","countryOfCitizenship":"string","countryOfResidence":"string","govIdCountryOfIssuance":"string","govIdClass":"cct","address":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"identificationNumber":"string","politicallyExposedPerson":true},"business":{,"businessName":"string","incorporationCountryCode":"string","primaryOperationsCountryCode":"string","einTinIdentificationNumber":"string","otherEntityId":"string","physicalBusinessAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"mailingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"billingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"legalEntityStructure":"llc","formationDate":"string","dbaName":"string","companyWebsiteAddress":"string","primaryBusinessType":"Crypto Services (Exchange, ATM, Borrow/Lend)","descriptionBusinessActivities":"string","billingContact":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"authorizedSigner":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"tradeStrategy":"string","activeCoinTokens":"string","tradeVolumeUsd":"string","activeExchanges":"string","diligenceRetailInstitutional":"retail0To25","customerBaseLocations":"string","sanctionAffiliates":true,"hasAuditor":true,"firmAuditor":"string","hasLegalCounsel":true,"diligenceCounselName":"string","walletAddress":"string","isRegulated":true,"regulatorCountryCode":"string","regulatorName":"string","regulatoryRegistrationNumber":"string","amlAttestation":{,"userId":"string","attestationDate":"string","attested":true},"fundsSource":"proprietary","diligenceMaterialFindings":true,"diligenceMaterialFindingsDescription":"string","prescreenWalletAddressAtm":true,"outsourcedFunctions":true,"outsourcedVendors":"string","diligenceFinancialInstitutionsUsed":"string","diligenceCanReceiveThirdPartyPayments":true,"diligenceCanSendRemittances":"yesBothFiatAndCrypto","diligenceRemittancesOther":"string","diligenceAllowWhitelist":true},"associatedPeople":[{,"role":"beneficialOwner","percentageOwnership":0,"identityId":"string"}],"documents":[{,"id":"string","documentId":"string","documentType":"governmentId","status":"missing"}]})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/identity-service/v1/identities/identityId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["content-type"] = 'application/json'
request.body = '{,"finalizeSubmission":true,"requestedProducts":[{,"name":"Trade","bitgoOrg":"BitGo Trust","country":"string","subdivision":"string"}],"individual":{,"nameFirst":"string","nameLast":"string","birthdate":{,"month":"string","day":"string","year":"string"},"phoneNumber":{,"countryCode":"string","phoneNumber":"string"},"email":"string","occupation":"Agriculture","countryOfCitizenship":"string","countryOfResidence":"string","govIdCountryOfIssuance":"string","govIdClass":"cct","address":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"identificationNumber":"string","politicallyExposedPerson":true},"business":{,"businessName":"string","incorporationCountryCode":"string","primaryOperationsCountryCode":"string","einTinIdentificationNumber":"string","otherEntityId":"string","physicalBusinessAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"mailingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"billingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"legalEntityStructure":"llc","formationDate":"string","dbaName":"string","companyWebsiteAddress":"string","primaryBusinessType":"Crypto Services (Exchange, ATM, Borrow/Lend)","descriptionBusinessActivities":"string","billingContact":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"authorizedSigner":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"tradeStrategy":"string","activeCoinTokens":"string","tradeVolumeUsd":"string","activeExchanges":"string","diligenceRetailInstitutional":"retail0To25","customerBaseLocations":"string","sanctionAffiliates":true,"hasAuditor":true,"firmAuditor":"string","hasLegalCounsel":true,"diligenceCounselName":"string","walletAddress":"string","isRegulated":true,"regulatorCountryCode":"string","regulatorName":"string","regulatoryRegistrationNumber":"string","amlAttestation":{,"userId":"string","attestationDate":"string","attested":true},"fundsSource":"proprietary","diligenceMaterialFindings":true,"diligenceMaterialFindingsDescription":"string","prescreenWalletAddressAtm":true,"outsourcedFunctions":true,"outsourcedVendors":"string","diligenceFinancialInstitutionsUsed":"string","diligenceCanReceiveThirdPartyPayments":true,"diligenceCanSendRemittances":"yesBothFiatAndCrypto","diligenceRemittancesOther":"string","diligenceAllowWhitelist":true},"associatedPeople":[{,"role":"beneficialOwner","percentageOwnership":0,"identityId":"string"}],"documents":[{,"id":"string","documentId":"string","documentType":"governmentId","status":"missing"}]}'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'content-type' => 'application/json',
  ],
  'body' => '{,"finalizeSubmission":true,"requestedProducts":[{,"name":"Trade","bitgoOrg":"BitGo Trust","country":"string","subdivision":"string"}],"individual":{,"nameFirst":"string","nameLast":"string","birthdate":{,"month":"string","day":"string","year":"string"},"phoneNumber":{,"countryCode":"string","phoneNumber":"string"},"email":"string","occupation":"Agriculture","countryOfCitizenship":"string","countryOfResidence":"string","govIdCountryOfIssuance":"string","govIdClass":"cct","address":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"identificationNumber":"string","politicallyExposedPerson":true},"business":{,"businessName":"string","incorporationCountryCode":"string","primaryOperationsCountryCode":"string","einTinIdentificationNumber":"string","otherEntityId":"string","physicalBusinessAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"mailingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"billingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"legalEntityStructure":"llc","formationDate":"string","dbaName":"string","companyWebsiteAddress":"string","primaryBusinessType":"Crypto Services (Exchange, ATM, Borrow/Lend)","descriptionBusinessActivities":"string","billingContact":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"authorizedSigner":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"tradeStrategy":"string","activeCoinTokens":"string","tradeVolumeUsd":"string","activeExchanges":"string","diligenceRetailInstitutional":"retail0To25","customerBaseLocations":"string","sanctionAffiliates":true,"hasAuditor":true,"firmAuditor":"string","hasLegalCounsel":true,"diligenceCounselName":"string","walletAddress":"string","isRegulated":true,"regulatorCountryCode":"string","regulatorName":"string","regulatoryRegistrationNumber":"string","amlAttestation":{,"userId":"string","attestationDate":"string","attested":true},"fundsSource":"proprietary","diligenceMaterialFindings":true,"diligenceMaterialFindingsDescription":"string","prescreenWalletAddressAtm":true,"outsourcedFunctions":true,"outsourcedVendors":"string","diligenceFinancialInstitutionsUsed":"string","diligenceCanReceiveThirdPartyPayments":true,"diligenceCanSendRemittances":"yesBothFiatAndCrypto","diligenceRemittancesOther":"string","diligenceAllowWhitelist":true},"associatedPeople":[{,"role":"beneficialOwner","percentageOwnership":0,"identityId":"string"}],"documents":[{,"id":"string","documentId":"string","documentType":"governmentId","status":"missing"}]}',
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/identity-service/v1/identities/identityId"

payload = {,"finalizeSubmission":true,"requestedProducts":[{,"name":"Trade","bitgoOrg":"BitGo Trust","country":"string","subdivision":"string"}],"individual":{,"nameFirst":"string","nameLast":"string","birthdate":{,"month":"string","day":"string","year":"string"},"phoneNumber":{,"countryCode":"string","phoneNumber":"string"},"email":"string","occupation":"Agriculture","countryOfCitizenship":"string","countryOfResidence":"string","govIdCountryOfIssuance":"string","govIdClass":"cct","address":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"identificationNumber":"string","politicallyExposedPerson":true},"business":{,"businessName":"string","incorporationCountryCode":"string","primaryOperationsCountryCode":"string","einTinIdentificationNumber":"string","otherEntityId":"string","physicalBusinessAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"mailingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"billingAddress":{,"street1":"string","street2":"string","city":"string","subdivision":"string","zip":"string","country":"string"},"legalEntityStructure":"llc","formationDate":"string","dbaName":"string","companyWebsiteAddress":"string","primaryBusinessType":"Crypto Services (Exchange, ATM, Borrow/Lend)","descriptionBusinessActivities":"string","billingContact":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"authorizedSigner":{,"nameFirst":"string","nameLast":"string","emailAddress":"string","phoneNumber":{,"countryCode":"string","phoneNumber":"string"}},"tradeStrategy":"string","activeCoinTokens":"string","tradeVolumeUsd":"string","activeExchanges":"string","diligenceRetailInstitutional":"retail0To25","customerBaseLocations":"string","sanctionAffiliates":true,"hasAuditor":true,"firmAuditor":"string","hasLegalCounsel":true,"diligenceCounselName":"string","walletAddress":"string","isRegulated":true,"regulatorCountryCode":"string","regulatorName":"string","regulatoryRegistrationNumber":"string","amlAttestation":{,"userId":"string","attestationDate":"string","attested":true},"fundsSource":"proprietary","diligenceMaterialFindings":true,"diligenceMaterialFindingsDescription":"string","prescreenWalletAddressAtm":true,"outsourcedFunctions":true,"outsourcedVendors":"string","diligenceFinancialInstitutionsUsed":"string","diligenceCanReceiveThirdPartyPayments":true,"diligenceCanSendRemittances":"yesBothFiatAndCrypto","diligenceRemittancesOther":"string","diligenceAllowWhitelist":true},"associatedPeople":[{,"role":"beneficialOwner","percentageOwnership":0,"identityId":"string"}],"documents":[{,"id":"string","documentId":"string","documentType":"governmentId","status":"missing"}]}
headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response

{
  "type": "individual",
  "userId": "string",
  "individual": {
    "nameFirst": "string",
    "nameLast": "string",
    "birthdate": {
      "month": "string",
      "day": "string",
      "year": "string"
    },
    "phoneNumber": {
      "countryCode": "string",
      "phoneNumber": "string"
    },
    "email": "string",
    "occupation": "Agriculture",
    "countryOfCitizenship": "string",
    "countryOfResidence": "string",
    "govIdCountryOfIssuance": "string",
    "govIdClass": "cct",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "subdivision": "string",
      "zip": "string",
      "country": "string"
    },
    "identificationNumber": "string",
    "politicallyExposedPerson": true
  },
  "id": "string",
  "ignoredFields": [
    "string"
  ],
  "requestedProducts": [
    {
      "id": "string",
      "name": "Instant Fee Wallets",
      "bitgoOrg": "BitGo Trust",
      "country": "string",
      "subdivision": "string",
      "status": "missingLocation"
    }
  ],
  "requirements": [
    {
      "id": "string",
      "kind": "businessInformation",
      "name": "string",
      "status": "missing",
      "minRequired": 0,
      "maxAllowed": 0
    }
  ],
  "documents": [
    {
      "id": "string",
      "documentId": "string",
      "documentType": "governmentId",
      "status": "missing"
    }
  ],
  "finalizeSubmission": true
}

{
  "error": "string",
  "details": [
    "string"
  ]
}

{
  "error": "string",
  "details": [
    "string"
  ]
}

{}

{}