Ctrl+K

Get all requirements with pagination, sorting, and filtering (Admin only)

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

Query Parameters

  • namestring or string or string or string
    Requirement name - must be valid for the requirement kind
  • kindstring
    Enum: businessInformation data document associatedPerson
  • documentTypestring
    Document type that satisfies this requirement. Only applicable for requirements with kind "document".
    Enum: governmentId commercialRegister articlesOfAssociation certificateOfIncorporation certificateOfTrust certificateOfIncumbency certificateOfIncumbencyOrShareRegister proofOfPrincipalPlaceOfBusiness activeTradeLicense resolutionToOpenBitgoUaeAccount resolutionToOpenBitgoSingaporeAccount proofOfAuthorizedSignatories memorandumOfAssociation memorandumAndArticlesOfAssociation bylawsOrOperatingAgreement operatingAgreement w8 w9 evidenceOfLegalStatus evidenceOfActiveStatus proofOfJfsaLicense proofOfGamingLicense organizationDocument partnershipAgreement articlesOfOrganization businessLicenseOrRegistration evidenceOfGovernmentOrStateOwnership secFilingsAsEvidenceOfPublicTradingStatus foundingTreatyOrEquivalent
  • pagestringDefault: 1
    Page number (starts at 1)
    Pattern: ^[1-9]\d*$
  • pageSizestringDefault: 20
    Number of items per page
    Pattern: ^[1-9]\d*$
  • sortBystringDefault: id
    Enum: name kind documentType id createdAt updatedAt
  • sortOrderstringDefault: ASC
    Enum: ASC DESC

200 Response

data array[object] required
nameOne ofrequired
Requirement name - must be valid for the requirement kind
Allowed values: beneficialOwners controlPeople platformAdmins
kind string required
Allowed values: businessInformation data document associatedPerson
documentType string
Document type that satisfies this requirement. Only applicable for requirements with kind "document".
Allowed values: governmentId commercialRegister articlesOfAssociation certificateOfIncorporation certificateOfTrust certificateOfIncumbency certificateOfIncumbencyOrShareRegister proofOfPrincipalPlaceOfBusiness activeTradeLicense resolutionToOpenBitgoUaeAccount resolutionToOpenBitgoSingaporeAccount proofOfAuthorizedSignatories memorandumOfAssociation memorandumAndArticlesOfAssociation bylawsOrOperatingAgreement operatingAgreement w8 w9 evidenceOfLegalStatus evidenceOfActiveStatus proofOfJfsaLicense proofOfGamingLicense organizationDocument partnershipAgreement articlesOfOrganization businessLicenseOrRegistration evidenceOfGovernmentOrStateOwnership secFilingsAsEvidenceOfPublicTradingStatus foundingTreatyOrEquivalent
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