> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules.md).

# modules

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes.md) / Modules

## @polymeshassociation/polymesh-sdk

### Table of contents

#### Modules

* [api/client/AccountManagement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_accountmanagement.md)
* [api/client/Assets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_assets.md)
* [api/client/Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims.md)
* [api/client/Identities](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_identities.md)
* [api/client/Network](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_network.md)
* [api/client/Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_polymesh.md)
* [api/client/Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_settlements.md)
* [api/entities/Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_account.md)
* [api/entities/Asset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset.md)
* [api/entities/Asset/AssetHolders](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_assetholders.md)
* [api/entities/Asset/Checkpoints](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints.md)
* [api/entities/Asset/Checkpoints/Schedules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_schedules.md)
* [api/entities/Asset/Checkpoints/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_types.md)
* [api/entities/Asset/Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance.md)
* [api/entities/Asset/Compliance/Requirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance_requirements.md)
* [api/entities/Asset/Compliance/TrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance_trustedclaimissuers.md)
* [api/entities/Asset/CorporateActions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions.md)
* [api/entities/Asset/CorporateActions/Distributions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions_distributions.md)
* [api/entities/Asset/CorporateActions/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions_types.md)
* [api/entities/Asset/Documents](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_documents.md)
* [api/entities/Asset/Issuance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_issuance.md)
* [api/entities/Asset/Offerings](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_offerings.md)
* [api/entities/Asset/Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_permissions.md)
* [api/entities/Asset/Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_settlements.md)
* [api/entities/Asset/TransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions.md)
* [api/entities/Asset/TransferRestrictions/Count](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_count.md)
* [api/entities/Asset/TransferRestrictions/Percentage](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_percentage.md)
* [api/entities/Asset/TransferRestrictions/TransferRestrictionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_transferrestrictionbase.md)
* [api/entities/Asset/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_types.md)
* [api/entities/AuthorizationRequest](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_authorizationrequest.md)
* [api/entities/Checkpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpoint.md)
* [api/entities/CheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpointschedule.md)
* [api/entities/CheckpointSchedule/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpointschedule_types.md)
* [api/entities/CorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateaction.md)
* [api/entities/CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase.md)
* [api/entities/CorporateActionBase/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase_types.md)
* [api/entities/CustomPermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_custompermissiongroup.md)
* [api/entities/DefaultPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_defaultportfolio.md)
* [api/entities/DefaultTrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_defaulttrustedclaimissuer.md)
* [api/entities/DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution.md)
* [api/entities/DividendDistribution/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution_types.md)
* [api/entities/Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_entity.md)
* [api/entities/Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity.md)
* [api/entities/Identity/AssetPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_assetpermissions.md)
* [api/entities/Identity/IdentityAuthorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_identityauthorizations.md)
* [api/entities/Identity/Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_portfolios.md)
* [api/entities/Instruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction.md)
* [api/entities/Instruction/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction_types.md)
* [api/entities/KnownPermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_knownpermissiongroup.md)
* [api/entities/Namespace](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_namespace.md)
* [api/entities/NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_numberedportfolio.md)
* [api/entities/Offering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_offering.md)
* [api/entities/Offering/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_offering_types.md)
* [api/entities/PermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_permissiongroup.md)
* [api/entities/Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_portfolio.md)
* [api/entities/Portfolio/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_portfolio_types.md)
* [api/entities/Subsidy](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_subsidy.md)
* [api/entities/Subsidy/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_subsidy_types.md)
* [api/entities/TickerReservation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation.md)
* [api/entities/TickerReservation/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation_types.md)
* [api/entities/Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue.md)
* [api/entities/Venue/types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue_types.md)
* [api/entities/common/namespaces/Authorizations](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_common_namespaces_authorizations.md)
* [api/procedures/addAssetRequirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addassetrequirement.md)
* [api/procedures/addInstruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addinstruction.md)
* [api/procedures/addInvestorUniquenessClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addinvestoruniquenessclaim.md)
* [api/procedures/addTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addtransferrestriction.md)
* [api/procedures/claimClassicTicker](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_claimclassicticker.md)
* [api/procedures/claimDividends](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_claimdividends.md)
* [api/procedures/closeOffering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_closeoffering.md)
* [api/procedures/configureDividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_configuredividenddistribution.md)
* [api/procedures/consumeAddMultiSigSignerAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumeaddmultisigsignerauthorization.md)
* [api/procedures/consumeAuthorizationRequests](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumeauthorizationrequests.md)
* [api/procedures/consumeJoinOrRotateAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumejoinorrotateauthorization.md)
* [api/procedures/controllerTransfer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_controllertransfer.md)
* [api/procedures/createAsset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createasset.md)
* [api/procedures/createCheckpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createcheckpoint.md)
* [api/procedures/createCheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createcheckpointschedule.md)
* [api/procedures/createGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_creategroup.md)
* [api/procedures/createPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createportfolio.md)
* [api/procedures/createVenue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createvenue.md)
* [api/procedures/deletePortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_deleteportfolio.md)
* [api/procedures/investInOffering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_investinoffering.md)
* [api/procedures/inviteAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_inviteaccount.md)
* [api/procedures/inviteExternalAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_inviteexternalagent.md)
* [api/procedures/issueTokens](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_issuetokens.md)
* [api/procedures/launchOffering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_launchoffering.md)
* [api/procedures/leaveIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_leaveidentity.md)
* [api/procedures/linkCaDocs](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_linkcadocs.md)
* [api/procedures/modifyAllowance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyallowance.md)
* [api/procedures/modifyAsset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyasset.md)
* [api/procedures/modifyAssetTrustedClaimIssuers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyassettrustedclaimissuers.md)
* [api/procedures/modifyCaCheckpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycacheckpoint.md)
* [api/procedures/modifyCaDefaultConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycadefaultconfig.md)
* [api/procedures/modifyClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyclaims.md)
* [api/procedures/modifyComplianceRequirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycompliancerequirement.md)
* [api/procedures/modifyCorporateActionsAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycorporateactionsagent.md)
* [api/procedures/modifyDistributionCheckpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifydistributioncheckpoint.md)
* [api/procedures/modifyInstructionAffirmation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyinstructionaffirmation.md)
* [api/procedures/modifyOfferingTimes](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyofferingtimes.md)
* [api/procedures/modifyPrimaryIssuanceAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyprimaryissuanceagent.md)
* [api/procedures/modifySignerPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifysignerpermissions.md)
* [api/procedures/modifyVenue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyvenue.md)
* [api/procedures/moveFunds](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_movefunds.md)
* [api/procedures/payDividends](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_paydividends.md)
* [api/procedures/quitCustody](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_quitcustody.md)
* [api/procedures/quitSubsidy](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_quitsubsidy.md)
* [api/procedures/reclaimDividendDistributionFunds](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_reclaimdividenddistributionfunds.md)
* [api/procedures/redeemTokens](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_redeemtokens.md)
* [api/procedures/registerIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_registeridentity.md)
* [api/procedures/removeAssetRequirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeassetrequirement.md)
* [api/procedures/removeCheckpointSchedule](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecheckpointschedule.md)
* [api/procedures/removeCorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecorporateaction.md)
* [api/procedures/removeCorporateActionsAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecorporateactionsagent.md)
* [api/procedures/removeExternalAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeexternalagent.md)
* [api/procedures/removePrimaryIssuanceAgent](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeprimaryissuanceagent.md)
* [api/procedures/removeSecondaryAccounts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removesecondaryaccounts.md)
* [api/procedures/renamePortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_renameportfolio.md)
* [api/procedures/rescheduleInstruction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_rescheduleinstruction.md)
* [api/procedures/reserveTicker](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_reserveticker.md)
* [api/procedures/setAssetDocuments](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setassetdocuments.md)
* [api/procedures/setAssetRequirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setassetrequirements.md)
* [api/procedures/setCustodian](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setcustodian.md)
* [api/procedures/setGroupPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setgrouppermissions.md)
* [api/procedures/setPermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setpermissiongroup.md)
* [api/procedures/setTransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_settransferrestrictions.md)
* [api/procedures/subsidizeAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_subsidizeaccount.md)
* [api/procedures/toggleFreezeOffering](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezeoffering.md)
* [api/procedures/toggleFreezeSecondaryAccounts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezesecondaryaccounts.md)
* [api/procedures/toggleFreezeTransfers](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezetransfers.md)
* [api/procedures/togglePauseRequirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglepauserequirements.md)
* [api/procedures/transferAssetOwnership](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transferassetownership.md)
* [api/procedures/transferPolyx](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transferpolyx.md)
* [api/procedures/transferTickerOwnership](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transfertickerownership.md)
* [api/procedures/utils](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_utils.md)
* [api/procedures/waivePermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_waivepermissions.md)
* [types](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md)
* [types/utils](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md)
