Ctrl+K

Create new requirement (Admin only)

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

Request Body

Body
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

201 Response

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

400 Response

error string

403 Response

error string

409 Response

error string

500 Response

error string