REST APIIdentityKnow Your Business (KYB)

GET

Retrieve an identity by its ID, including all related information. Requires User-Id header and user can only access identities they created.

Path Params

  • identityId string required
    The unique ID of the identity to retrieve

Responses

200
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
401
401

Response Body

object

  • error string required
    Description of the error
  • details array of strings
404
404

Response Body

object

  • error string required
    Description of the error
  • details array of strings
500
500
No response body