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 Sister Trust 1 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
  • 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 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 Sister Trust 1 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
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