Ctrl+K

Update existing product requirement (Admin only)

patch/api/identity-service/v1/admin/product-requirements/{productRequirementId}

Path Parameters

  • productRequirementIdstring<uuid>Required

Request Body

Body
bitgoOrg string
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
Country (formatted as ISO 3166-1 alpha-3)
subdivision
string or null
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
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>
requirementId string <uuid>
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

200 Response

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

400 Response

error string

403 Response

error string

404 Response

error string

409 Response

error string

500 Response

error string