GET
Get KYB Identity
Retrieve an identity by its ID, including all related information. Requires User-Id header and user can only access identities they created.
Path Params
-
identityIdstring requiredThe unique ID of the identity to retrieve
Responses
200
200
Response Body
ONE OF
-
typestring enum requiredType of identityindividual -
userIdstring requiredThe ID of the user -
individualobject requiredindividual object
-
nameFirststringFirst name of the individual -
nameLaststringLast name of the individual -
birthdateobjectBirthdatebirthdate object
-
monthstring requiredbirthdate month (MM, e.g. "06") -
daystring requiredbirthdate day (DD, e.g. "15") -
yearstring requiredbirthdate year (YYYY, e.g. "1990")
-
-
phoneNumberobjectphoneNumber object
-
countryCodestring requiredCountry code of the phone number -
phoneNumberstring requiredPhone number (without country code)
-
-
emailstring emailEmail address of the individual -
occupationstring enumOccupation category of the individualAgricultureArt 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 -
countryOfCitizenshipobjectCountry of citizenship (ISO 3166-1 alpha-3) -
countryOfResidenceobjectCountry of residence (ISO 3166-1 alpha-3) -
govIdCountryOfIssuanceobjectCountry where government ID was issued (ISO 3166-1 alpha-3) -
govIdClassstring enumClass 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 Permitcctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp -
addressobjectaddress object
-
street1string requiredStreet address line 1 -
street2stringStreet address line 2 -
citystring requiredCity name -
subdivisionstring requiredState, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code) -
zipstring requiredZIP or postal code -
countryobject requiredCountry (formatted as ISO 3166-1 alpha-3)
-
-
identificationNumberstringNational identification number (e.g., SSN, passport number) -
politicallyExposedPersonbooleanWhether the individual is a politically exposed person
-
-
idstring requiredThe unique ID of the created identity -
ignoredFieldsarray of stringsIgnored fields -
requestedProductsarray of objects requiredList of products requested for this identityrequestedProducts object
-
idstring requiredUnique identifier for the requested permission -
namestring enum requiredName of the BitGo productInstant Fee WalletsGo AccountACH DebitsSettlementTaxTrade APIMargin TradingEllipticCryptoCompareMetaMaskCustodyBorrowingLendingDeFiCold Self-CustodyGo NetworkStakingTradeHot Self-CustodyEscrowEscrow - TripartyDistributed Custody -
bitgoOrgstring enum requiredThe BitGo entity identifierBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Mena FzeBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc -
countryobjectThe country where the permission is being requested -
subdivisionstringThe subdivision where the permission is being requested -
statusstring enum requiredStatus of the requested permissionmissingLocationmissingEntityStructuremissingRequirementsreadyForSubmissioninReviewapprovedrejected
-
-
requirementsarray of objects requiredList of requirements related to the identityrequirements object
-
idstring requiredUnique identifier for the requirement -
kindstring enum requiredType of requirementbusinessInformationdatadocumentassociatedPerson -
namestring requiredName of the requirement -
statusstring enum requiredCurrent status of the requirementmissingcountExceededsubmittedinReviewverified -
minRequirednumberMinimum number required (for associated persons) -
maxAllowednumberMaximum number allowed (for associated persons)
-
-
documentsarray of objectsList of documents associated with the identitydocuments object
-
idstring requiredInternal ID for the document association -
documentIdstring requiredExternal document service ID -
documentTypestring enum requiredType of document being uploadedgovernmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalent -
statusstring enum requiredVerification statusmissingcountExceededsubmittedinReviewverified
-
-
finalizeSubmissionboolean requiredWhether identity is ready for final submission and requirements validation
-
typestring enum requiredType of identitybusiness -
organizationIdstring requiredThe ID of the organization -
enterpriseIdstring requiredThe ID of the enterprise -
businessobject requiredbusiness object
-
businessNamestringLegal name of the business -
incorporationCountryCodeobjectCountry of incorporation (ISO 3166-1 alpha-3) -
primaryOperationsCountryCodeobjectPrimary country of operations (ISO 3166-1 alpha-3) -
einTinIdentificationNumberstringEIN/TIN of the business -
otherEntityIdstringAny additional entity identifier (e.g. company registration name or official registry ID) -
physicalBusinessAddressobjectphysicalBusinessAddress object
-
street1string requiredStreet address line 1 -
street2stringStreet address line 2 -
citystring requiredCity name -
subdivisionstring requiredState, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code) -
zipstring requiredZIP or postal code -
countryobject requiredCountry (formatted as ISO 3166-1 alpha-3)
-
-
mailingAddressobjectmailingAddress object
-
street1string requiredStreet address line 1 -
street2stringStreet address line 2 -
citystring requiredCity name -
subdivisionstring requiredState, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code) -
zipstring requiredZIP or postal code -
countryobject requiredCountry (formatted as ISO 3166-1 alpha-3)
-
-
billingAddressobjectbillingAddress object
-
street1string requiredStreet address line 1 -
street2stringStreet address line 2 -
citystring requiredCity name -
subdivisionstring requiredState, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code) -
zipstring requiredZIP or postal code -
countryobject requiredCountry (formatted as ISO 3166-1 alpha-3)
-
-
legalEntityStructurestring enumBusiness entity legal structure used to filter requirements (enum).llccorporationCAndSpartnershipLimitedAndLLPgeneralPartnershiptrustsprivateInvestmentOrFoundationunincorporatedBusinesssoleProprietorshipgovernmentOwnedpubliclyTradedsupranationalBodiesspecialPurposeVehiclesegregatedPortfolioCompany -
formationDatestringBusiness formation date (YYYY-MM-DD) -
dbaNamestringDBA (Doing Business As) name -
companyWebsiteAddressstring uriOfficial company website -
primaryBusinessTypestring enumPrimary type of businessCrypto 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 -
descriptionBusinessActivitiesstringShort description of the business -
billingContactobjectbillingContact object
-
nameFirststring requiredFirst name -
nameLaststring requiredLast name -
emailAddressstring email requiredEmail address -
phoneNumberobject requiredphoneNumber object
-
countryCodestring requiredCountry code of the phone number -
phoneNumberstring requiredPhone number (without country code)
-
-
-
authorizedSignerobjectauthorizedSigner object
-
nameFirststring requiredFirst name -
nameLaststring requiredLast name -
emailAddressstring email requiredEmail address -
phoneNumberobject requiredphoneNumber object
-
countryCodestring requiredCountry code of the phone number -
phoneNumberstring requiredPhone number (without country code)
-
-
-
tradeStrategystringTrading strategy of the business -
activeCoinTokensstringActive cryptocurrencies traded -
tradeVolumeUsdstringEstimated trade volume in USD -
activeExchangesstringList of active exchanges -
diligenceRetailInstitutionalstring enumPercentage breakdown of retail vs institutional customer baseretail0To25retail25To50retail50To75retail75To100 -
customerBaseLocationsstringLocations of customer base -
sanctionAffiliatesbooleanWhether the business has sanctioned affiliates -
hasAuditorbooleanWhether the business has an auditor -
firmAuditorstring nullableName of audit firm (if applicable) -
hasLegalCounselbooleanWhether the business has legal counsel -
diligenceCounselNamestring nullableName of legal counsel (if applicable) -
walletAddressstringBusiness wallet address -
isRegulatedbooleanWhether the business is regulated -
regulatorCountryCodeobject nullableCountry of regulator (ISO 3166-1 alpha-3) -
regulatorNamestring nullableName of the regulator -
regulatoryRegistrationNumberstring nullableRegulatory registration number -
amlAttestationobjectAML attestation data (who attested, when, and the yes/no answer)amlAttestation object
-
userIdstring requiredBitGo user ID of the person performing the attestation -
attestationDatestring date-time requiredISO 8601 date of the attestation -
attestedboolean requiredWhether the AML attestation was affirmed
-
-
fundsSourcestring enumWhether funds deposited are proprietary or customer fundsproprietarycustomer -
diligenceMaterialFindingsbooleanHas there been any recent Financial Crime related civil or criminal proceedings, regulatory actions, or findings against the company in the past year? -
diligenceMaterialFindingsDescriptionstring nullableDescription of material findings (required if diligenceMaterialFindings is true) -
prescreenWalletAddressAtmbooleanDoes the business pre-screen wallet addresses at ATMs? -
outsourcedFunctionsbooleanDoes the business outsource any AML/compliance functions? -
outsourcedVendorsstring nullableNames of vendors providing outsourced functions (required if outsourcedFunctions is true) -
diligenceFinancialInstitutionsUsedstringFinancial institutions used by the business -
diligenceCanReceiveThirdPartyPaymentsbooleanCan the business receive payments from third parties? -
diligenceCanSendRemittancesstring enumCan the business send remittances?yesBothFiatAndCryptoyesFiatyesCryptonoother -
diligenceRemittancesOtherstring nullableDescription of remittance type (required if diligenceCanSendRemittances is "other") -
diligenceAllowWhitelistbooleanDoes the business allow wallet address whitelisting?
-
-
associatedPeoplearray of objects requiredList of associated people linked to this identityassociatedPeople object
-
identityIdstring requiredThe individual identity ID of the associated person -
rolestring enum requiredRole of the associated personbeneficialOwnercontrolPersonplatformAdmin -
percentageOwnershipnumber nullable requiredPercentage of ownership (only applicable to beneficial owners) -
statusstring enum requiredVerification status of the associated personmissingLocationmissingRequirementsreadyForSubmissioninReviewverifiedrejected -
individualobject requiredIndividual data for the associated personindividual object
-
nameFirststringFirst name of the individual -
nameLaststringLast name of the individual -
birthdateobjectBirthdatebirthdate object
- Same shape as
Birthdate.
- Same shape as
-
phoneNumberobjectphoneNumber object
-
countryCodestring requiredCountry code of the phone number -
phoneNumberstring requiredPhone number (without country code)
-
-
emailstring emailEmail address of the individual -
occupationstring enumOccupation category of the individualAgricultureArt 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 -
countryOfCitizenshipobjectCountry of citizenship (ISO 3166-1 alpha-3) -
countryOfResidenceobjectCountry of residence (ISO 3166-1 alpha-3) -
govIdCountryOfIssuanceobjectCountry where government ID was issued (ISO 3166-1 alpha-3) -
govIdClassstring enumClass 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 Permitcctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp -
addressobjectaddress object
-
street1string requiredStreet address line 1 -
street2stringStreet address line 2 -
citystring requiredCity name -
subdivisionstring requiredState, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code) -
zipstring requiredZIP or postal code -
countryobject requiredCountry (formatted as ISO 3166-1 alpha-3)
-
-
identificationNumberstringNational identification number (e.g., SSN, passport number) -
politicallyExposedPersonbooleanWhether the individual is a politically exposed person
-
-
userIdstring requiredUser ID of the associated person -
missingRequirementsarray of objects requiredList of missing requirements for the associated personmissingRequirements object
-
idstring requiredUnique identifier for the missing requirement -
kindstring enum requiredType of missing requirementbusinessInformationdatadocumentassociatedPerson -
namestring requiredName of the missing requirement -
statusstring enum requiredCurrent status of the missing requirementmissingcountExceededsubmittedinReviewverified
-
-
documentsarray of objectsDocuments associated with the associated persondocuments object
- Same shape as
Document.
- Same shape as
-
-
idstring requiredThe unique ID of the created identity -
ignoredFieldsarray of stringsIgnored fields -
requestedProductsarray of objects requiredList of products requested for this identityrequestedProducts object
- Same shape as
RequestedProductResponse.
- Same shape as
-
requirementsarray of objects requiredList of requirements related to the identityrequirements object
- Same shape as
Requirement.
- Same shape as
-
documentsarray of objectsList of documents associated with the identitydocuments object
- Same shape as
Document.
- Same shape as
-
finalizeSubmissionboolean requiredWhether identity is ready for final submission and requirements validation
401
401
Response Body
object
-
errorstring requiredDescription of the error -
detailsarray of strings
404
404
Response Body
object
-
errorstring requiredDescription of the error -
detailsarray of strings
500
500
No response body