Ctrl+K

Get product requirements by query parameters (Admin only)

get/api/identity-service/v1/admin/product-requirements

Query Parameters

  • bitgoOrgstring
    BitGo organization types
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Mena Fze BitGo Custody MENA FZE BitGo Inc
  • country
    Country (formatted as ISO 3166-1 alpha-3)
  • subdivisionstring
    State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
    Min length: >= 1 characters
    Max length: <= 3 characters
  • typestring
    Enum: individual associatedPerson business
  • entityStructurestring
    Enum: llc corporationCAndS partnershipLimitedAndLLP generalPartnership trusts privateInvestmentOrFoundation unincorporatedBusiness soleProprietorship governmentOwned publiclyTraded supranationalBodies specialPurposeVehicle segregatedPortfolioCompany
  • primaryBusinessTypestring
    Primary type of business
    Enum: 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
  • productIdstring<uuid>
  • requirementIdstring<uuid>
  • pagestringDefault: 1
    Page number (starts at 1)
    Pattern: ^[1-9]\d*$
  • pageSizestringDefault: 20
    Number of items per page
    Pattern: ^[1-9]\d*$
  • sortBystringDefault: bitgoOrg
    Enum: bitgoOrg country subdivision type entityStructure primaryBusinessType productId requirementId minRequired maxAllowed id createdAt updatedAt
  • sortOrderstringDefault: ASC
    Enum: ASC DESC

200 Response

data array[object] required
bitgoOrg string required
BitGo organization types
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Mena Fze BitGo Custody MENA FZE BitGo Inc
country required
Country (formatted as ISO 3166-1 alpha-3)
subdivision
string or null
required
State, province, or region (formatted as subdivision section of ISO 3166-2, excludes country code)
Min length: >= 1 characters
Max length: <= 3 characters
type string required
Allowed values: individual associatedPerson business
entityStructure
string or null
Allowed values: llc corporationCAndS partnershipLimitedAndLLP generalPartnership trusts privateInvestmentOrFoundation unincorporatedBusiness soleProprietorship governmentOwned publiclyTraded supranationalBodies specialPurposeVehicle segregatedPortfolioCompany
primaryBusinessType
string or null
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
productId string <uuid>required
requirementId string <uuid>required
minRequired number
Applies only to the specific requirements "beneficialOwners", "controlPeople", "platformAdmins"
Minimum: >= 0
maxAllowed number
Applies only to the specific requirements "beneficialOwners", "controlPeople", "platformAdmins"
Minimum: >= 0
id string <uuid>required
createdAt string <date-time>required
updatedAt string <date-time>required
pagination object required
currentPage integer required
Minimum: >= 1
pageSize integer required
Minimum: >= 1
totalPages integer required
Minimum: >= 0
totalItems integer required
Minimum: >= 0

400 Response

error string

403 Response

error string

500 Response

error string