# Globals

## Index

### Enumerations

* [AffirmationStatus](/polymesh-sdk-api-reference/docs-v4/enums/affirmationstatus.md)
* [AuthorizationType](/polymesh-sdk-api-reference/docs-v4/enums/authorizationtype.md)
* [ClaimType](/polymesh-sdk-api-reference/docs-v4/enums/claimtype.md)
* [ConditionTarget](/polymesh-sdk-api-reference/docs-v4/enums/conditiontarget.md)
* [ConditionType](/polymesh-sdk-api-reference/docs-v4/enums/conditiontype.md)
* [CountryCode](/polymesh-sdk-api-reference/docs-v4/enums/countrycode.md)
* [ErrorCode](/polymesh-sdk-api-reference/docs-v4/enums/errorcode.md)
* [InstructionStatus](/polymesh-sdk-api-reference/docs-v4/enums/instructionstatus.md)
* [InstructionType](/polymesh-sdk-api-reference/docs-v4/enums/instructiontype.md)
* [KnownTokenType](/polymesh-sdk-api-reference/docs-v4/enums/knowntokentype.md)
* [ProposalStage](/polymesh-sdk-api-reference/docs-v4/enums/proposalstage.md)
* [RoleType](/polymesh-sdk-api-reference/docs-v4/enums/roletype.md)
* [ScopeType](/polymesh-sdk-api-reference/docs-v4/enums/scopetype.md)
* [StoStatus](/polymesh-sdk-api-reference/docs-v4/enums/stostatus.md)
* [TickerReservationStatus](/polymesh-sdk-api-reference/docs-v4/enums/tickerreservationstatus.md)
* [TokenIdentifierType](/polymesh-sdk-api-reference/docs-v4/enums/tokenidentifiertype.md)
* [TransactionArgumentType](/polymesh-sdk-api-reference/docs-v4/enums/transactionargumenttype.md)
* [TransactionQueueStatus](/polymesh-sdk-api-reference/docs-v4/enums/transactionqueuestatus.md)
* [TransactionStatus](/polymesh-sdk-api-reference/docs-v4/enums/transactionstatus.md)
* [TransferStatus](/polymesh-sdk-api-reference/docs-v4/enums/transferstatus.md)
* [TxGroup](/polymesh-sdk-api-reference/docs-v4/enums/txgroup.md)
* [VenueType](/polymesh-sdk-api-reference/docs-v4/enums/venuetype.md)

### Classes

* [Account](/polymesh-sdk-api-reference/docs-v4/classes/account.md)
* [AuthorizationRequest](/polymesh-sdk-api-reference/docs-v4/classes/authorizationrequest.md)
* [Authorizations](/polymesh-sdk-api-reference/docs-v4/classes/authorizations.md)
* [Claims](/polymesh-sdk-api-reference/docs-v4/classes/claims.md)
* [Compliance](/polymesh-sdk-api-reference/docs-v4/classes/compliance.md)
* [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md)
* [Count](/polymesh-sdk-api-reference/docs-v4/classes/count.md)
* [CurrentAccount](/polymesh-sdk-api-reference/docs-v4/classes/currentaccount.md)
* [CurrentIdentity](/polymesh-sdk-api-reference/docs-v4/classes/currentidentity.md)
* [DefaultPortfolio](/polymesh-sdk-api-reference/docs-v4/classes/defaultportfolio.md)
* [DefaultTrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v4/classes/defaulttrustedclaimissuer.md)
* [Documents](/polymesh-sdk-api-reference/docs-v4/classes/documents.md)
* [Entity](/polymesh-sdk-api-reference/docs-v4/classes/entity.md)
* [Identity](/polymesh-sdk-api-reference/docs-v4/classes/identity.md)
* [IdentityAuthorizations](/polymesh-sdk-api-reference/docs-v4/classes/identityauthorizations.md)
* [Instruction](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md)
* [Issuance](/polymesh-sdk-api-reference/docs-v4/classes/issuance.md)
* [Middleware](/polymesh-sdk-api-reference/docs-v4/classes/middleware.md)
* [NumberedPortfolio](/polymesh-sdk-api-reference/docs-v4/classes/numberedportfolio.md)
* [Offerings](/polymesh-sdk-api-reference/docs-v4/classes/offerings.md)
* [Percentage](/polymesh-sdk-api-reference/docs-v4/classes/percentage.md)
* [Polymesh](/polymesh-sdk-api-reference/docs-v4/classes/polymesh.md)
* [PolymeshError](/polymesh-sdk-api-reference/docs-v4/classes/polymesherror.md)
* [PolymeshTransaction](/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransaction.md)
* [PolymeshTransactionBase](/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransactionbase.md)
* [PolymeshTransactionBatch](/polymesh-sdk-api-reference/docs-v4/classes/polymeshtransactionbatch.md)
* [Portfolio](/polymesh-sdk-api-reference/docs-v4/classes/portfolio.md)
* [Portfolios](/polymesh-sdk-api-reference/docs-v4/classes/portfolios.md)
* [Requirements](/polymesh-sdk-api-reference/docs-v4/classes/requirements.md)
* [SecurityToken](/polymesh-sdk-api-reference/docs-v4/classes/securitytoken.md)
* [Settlements](/polymesh-sdk-api-reference/docs-v4/classes/settlements.md)
* [Sto](/polymesh-sdk-api-reference/docs-v4/classes/sto.md)
* [TickerReservation](/polymesh-sdk-api-reference/docs-v4/classes/tickerreservation.md)
* [TokenHolders](/polymesh-sdk-api-reference/docs-v4/classes/tokenholders.md)
* [TransactionQueue](/polymesh-sdk-api-reference/docs-v4/classes/transactionqueue.md)
* [TransferRestrictionBase](/polymesh-sdk-api-reference/docs-v4/classes/transferrestrictionbase.md)
* [TransferRestrictions](/polymesh-sdk-api-reference/docs-v4/classes/transferrestrictions.md)
* [TrustedClaimIssuers](/polymesh-sdk-api-reference/docs-v4/classes/trustedclaimissuers.md)
* [Venue](/polymesh-sdk-api-reference/docs-v4/classes/venue.md)

### Interfaces

* [AccountBalance](/polymesh-sdk-api-reference/docs-v4/interfaces/accountbalance.md)
* [AccountData](/polymesh-sdk-api-reference/docs-v4/interfaces/accountdata.md)
* [ActiveTransferRestrictions](/polymesh-sdk-api-reference/docs-v4/interfaces/activetransferrestrictions.md)
* [AddBatchTransactionOpts](/polymesh-sdk-api-reference/docs-v4/interfaces/addbatchtransactionopts.md)
* [AddClaimsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/addclaimsparams.md)
* [AddInstructionParams](/polymesh-sdk-api-reference/docs-v4/interfaces/addinstructionparams.md)
* [AddInvestorUniquenessClaimParams](/polymesh-sdk-api-reference/docs-v4/interfaces/addinvestoruniquenessclaimparams.md)
* [AddTransactionOpts](/polymesh-sdk-api-reference/docs-v4/interfaces/addtransactionopts.md)
* [AddTransactionOptsBase](/polymesh-sdk-api-reference/docs-v4/interfaces/addtransactionoptsbase.md)
* [ArrayTransactionArgument](/polymesh-sdk-api-reference/docs-v4/interfaces/arraytransactionargument.md)
* [CddProviderRole](/polymesh-sdk-api-reference/docs-v4/interfaces/cddproviderrole.md)
* [ClaimData](/polymesh-sdk-api-reference/docs-v4/interfaces/claimdata.md)
* [ClaimScope](/polymesh-sdk-api-reference/docs-v4/interfaces/claimscope.md)
* [ClaimTarget](/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget.md)
* [ComplexTransactionArgument](/polymesh-sdk-api-reference/docs-v4/interfaces/complextransactionargument.md)
* [ConditionCompliance](/polymesh-sdk-api-reference/docs-v4/interfaces/conditioncompliance.md)
* [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v4/interfaces/connectparamsbase.md)
* [ConstructorParams](/polymesh-sdk-api-reference/docs-v4/interfaces/constructorparams.md)
* [ConsumeParams](/polymesh-sdk-api-reference/docs-v4/interfaces/consumeparams.md)
* [CountTransferRestriction](/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestriction.md)
* [CountTransferRestrictionInput](/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestrictioninput.md)
* [CreateSecurityTokenParams](/polymesh-sdk-api-reference/docs-v4/interfaces/createsecuritytokenparams.md)
* [CreateVenueParams](/polymesh-sdk-api-reference/docs-v4/interfaces/createvenueparams.md)
* [DeletePortfolioParams](/polymesh-sdk-api-reference/docs-v4/interfaces/deleteportfolioparams.md)
* [EditClaimsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/editclaimsparams.md)
* [EventIdentifier](/polymesh-sdk-api-reference/docs-v4/interfaces/eventidentifier.md)
* [ExtrinsicData](/polymesh-sdk-api-reference/docs-v4/interfaces/extrinsicdata.md)
* [Fees](/polymesh-sdk-api-reference/docs-v4/interfaces/fees.md)
* [HistoricSettlement](/polymesh-sdk-api-reference/docs-v4/interfaces/historicsettlement.md)
* [IdentityBalance](/polymesh-sdk-api-reference/docs-v4/interfaces/identitybalance.md)
* [IdentityWithClaims](/polymesh-sdk-api-reference/docs-v4/interfaces/identitywithclaims.md)
* [InstructionAffirmation](/polymesh-sdk-api-reference/docs-v4/interfaces/instructionaffirmation.md)
* [Investment](/polymesh-sdk-api-reference/docs-v4/interfaces/investment.md)
* [InviteAccountParams](/polymesh-sdk-api-reference/docs-v4/interfaces/inviteaccountparams.md)
* [IssueTokensParams](/polymesh-sdk-api-reference/docs-v4/interfaces/issuetokensparams.md)
* [KeyringPair](/polymesh-sdk-api-reference/docs-v4/interfaces/keyringpair.md)
* [Leg](/polymesh-sdk-api-reference/docs-v4/interfaces/leg.md)
* [MiddlewareConfig](/polymesh-sdk-api-reference/docs-v4/interfaces/middlewareconfig.md)
* [ModifyInstructionAffirmationParams](/polymesh-sdk-api-reference/docs-v4/interfaces/modifyinstructionaffirmationparams.md)
* [ModifyPrimaryIssuanceAgentParams](/polymesh-sdk-api-reference/docs-v4/interfaces/modifyprimaryissuanceagentparams.md)
* [ModifySignerPermissionsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/modifysignerpermissionsparams.md)
* [ModifyTokenTrustedClaimIssuersAddSetParams](/polymesh-sdk-api-reference/docs-v4/interfaces/modifytokentrustedclaimissuersaddsetparams.md)
* [ModifyTokenTrustedClaimIssuersRemoveParams](/polymesh-sdk-api-reference/docs-v4/interfaces/modifytokentrustedclaimissuersremoveparams.md)
* [MoveFundsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/movefundsparams.md)
* [NetworkProperties](/polymesh-sdk-api-reference/docs-v4/interfaces/networkproperties.md)
* [PaginationOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions.md)
* [PercentageTransferRestriction](/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestriction.md)
* [PercentageTransferRestrictionInput](/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestrictioninput.md)
* [Permissions](/polymesh-sdk-api-reference/docs-v4/interfaces/permissions.md)
* [PermissionsLike](/polymesh-sdk-api-reference/docs-v4/interfaces/permissionslike.md)
* [PlainTransactionArgument](/polymesh-sdk-api-reference/docs-v4/interfaces/plaintransactionargument.md)
* [PortfolioBalance](/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliobalance.md)
* [PortfolioCustodianRole](/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliocustodianrole.md)
* [PortfolioMovement](/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliomovement.md)
* [ProcedureAuthorizationStatus](/polymesh-sdk-api-reference/docs-v4/interfaces/procedureauthorizationstatus.md)
* [ProposalDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/proposaldetails.md)
* [ProposalTimeFrames](/polymesh-sdk-api-reference/docs-v4/interfaces/proposaltimeframes.md)
* [ProposalVote](/polymesh-sdk-api-reference/docs-v4/interfaces/proposalvote.md)
* [RedeemTokenParams](/polymesh-sdk-api-reference/docs-v4/interfaces/redeemtokenparams.md)
* [RegisterIdentityParams](/polymesh-sdk-api-reference/docs-v4/interfaces/registeridentityparams.md)
* [RemoveSecondaryKeysParams](/polymesh-sdk-api-reference/docs-v4/interfaces/removesecondarykeysparams.md)
* [RenamePortfolioParams](/polymesh-sdk-api-reference/docs-v4/interfaces/renameportfolioparams.md)
* [Requirement](/polymesh-sdk-api-reference/docs-v4/interfaces/requirement.md)
* [RequirementCompliance](/polymesh-sdk-api-reference/docs-v4/interfaces/requirementcompliance.md)
* [ReserveTickerParams](/polymesh-sdk-api-reference/docs-v4/interfaces/reservetickerparams.md)
* [ResultSet](/polymesh-sdk-api-reference/docs-v4/interfaces/resultset.md)
* [RevokeClaimsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/revokeclaimsparams.md)
* [Scope](/polymesh-sdk-api-reference/docs-v4/interfaces/scope.md)
* [SecondaryKey](/polymesh-sdk-api-reference/docs-v4/interfaces/secondarykey.md)
* [SecurityTokenDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/securitytokendetails.md)
* [SetAssetRequirementsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/setassetrequirementsparams.md)
* [SetCountTransferRestrictionsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/setcounttransferrestrictionsparams.md)
* [SetCustodianParams](/polymesh-sdk-api-reference/docs-v4/interfaces/setcustodianparams.md)
* [SetPercentageTransferRestrictionsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/setpercentagetransferrestrictionsparams.md)
* [SetTokenDocumentsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/settokendocumentsparams.md)
* [SettlementLeg](/polymesh-sdk-api-reference/docs-v4/interfaces/settlementleg.md)
* [SimpleEnumTransactionArgument](/polymesh-sdk-api-reference/docs-v4/interfaces/simpleenumtransactionargument.md)
* [StoDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/stodetails.md)
* [StoTier](/polymesh-sdk-api-reference/docs-v4/interfaces/stotier.md)
* [StoWithDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/stowithdetails.md)
* [TickerOwnerRole](/polymesh-sdk-api-reference/docs-v4/interfaces/tickerownerrole.md)
* [TickerReservationDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/tickerreservationdetails.md)
* [Tier](/polymesh-sdk-api-reference/docs-v4/interfaces/tier.md)
* [ToggleFreezeStoParams](/polymesh-sdk-api-reference/docs-v4/interfaces/togglefreezestoparams.md)
* [ToggleFreezeTransfersParams](/polymesh-sdk-api-reference/docs-v4/interfaces/togglefreezetransfersparams.md)
* [TogglePauseRequirementsParams](/polymesh-sdk-api-reference/docs-v4/interfaces/togglepauserequirementsparams.md)
* [TokenDocument](/polymesh-sdk-api-reference/docs-v4/interfaces/tokendocument.md)
* [TokenHolderOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenholderoptions.md)
* [TokenHolderProperties](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenholderproperties.md)
* [TokenIdentifier](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenidentifier.md)
* [TokenOwnerRole](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenownerrole.md)
* [TokenPiaRole](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenpiarole.md)
* [TransferPolyXParams](/polymesh-sdk-api-reference/docs-v4/interfaces/transferpolyxparams.md)
* [TransferRestrictionInputBase](/polymesh-sdk-api-reference/docs-v4/interfaces/transferrestrictioninputbase.md)
* [TransferTokenOwnershipParams](/polymesh-sdk-api-reference/docs-v4/interfaces/transfertokenownershipparams.md)
* [TrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer.md)
* [UiKeyring](/polymesh-sdk-api-reference/docs-v4/interfaces/uikeyring.md)
* [UniqueIdentifiers](/polymesh-sdk-api-reference/docs-v4/interfaces/uniqueidentifiers.md)
* [VenueDetails](/polymesh-sdk-api-reference/docs-v4/interfaces/venuedetails.md)
* [VenueOwnerRole](/polymesh-sdk-api-reference/docs-v4/interfaces/venueownerrole.md)

### Type aliases

* [AddCountTransferRestrictionParams](/polymesh-sdk-api-reference/docs-v4/globals.md#addcounttransferrestrictionparams)
* [AddPercentageTransferRestrictionParams](/polymesh-sdk-api-reference/docs-v4/globals.md#addpercentagetransferrestrictionparams)
* [AddRestrictionParams](/polymesh-sdk-api-reference/docs-v4/globals.md#addrestrictionparams)
* [Authorization](/polymesh-sdk-api-reference/docs-v4/globals.md#authorization)
* [CddClaim](/polymesh-sdk-api-reference/docs-v4/globals.md#cddclaim)
* [Claim](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)
* [CommonKeyring](/polymesh-sdk-api-reference/docs-v4/globals.md#commonkeyring)
* [Condition](/polymesh-sdk-api-reference/docs-v4/globals.md#condition)
* [ConditionBase](/polymesh-sdk-api-reference/docs-v4/globals.md#conditionbase)
* [Ensured](/polymesh-sdk-api-reference/docs-v4/globals.md#ensured)
* [GetReturnType](/polymesh-sdk-api-reference/docs-v4/globals.md#getreturntype)
* [IdentityCondition](/polymesh-sdk-api-reference/docs-v4/globals.md#identitycondition)
* [InstructionDetails](/polymesh-sdk-api-reference/docs-v4/globals.md#instructiondetails)
* [InvestorUniquenessClaim](/polymesh-sdk-api-reference/docs-v4/globals.md#investoruniquenessclaim)
* [ModifyClaimsParams](/polymesh-sdk-api-reference/docs-v4/globals.md#modifyclaimsparams)
* [ModifyStoTimesParams](/polymesh-sdk-api-reference/docs-v4/globals.md#modifystotimesparams)
* [ModifyTokenParams](/polymesh-sdk-api-reference/docs-v4/globals.md#modifytokenparams)
* [MultiClaimCondition](/polymesh-sdk-api-reference/docs-v4/globals.md#multiclaimcondition)
* [Mutable](/polymesh-sdk-api-reference/docs-v4/globals.md#mutable)
* [NextKey](/polymesh-sdk-api-reference/docs-v4/globals.md#nextkey)
* [PortfolioLike](/polymesh-sdk-api-reference/docs-v4/globals.md#portfoliolike)
* [PrimaryIssuanceAgentCondition](/polymesh-sdk-api-reference/docs-v4/globals.md#primaryissuanceagentcondition)
* [Role](/polymesh-sdk-api-reference/docs-v4/globals.md#role)
* [ScopedClaim](/polymesh-sdk-api-reference/docs-v4/globals.md#scopedclaim)
* [SetRestrictionsParams](/polymesh-sdk-api-reference/docs-v4/globals.md#setrestrictionsparams)
* [SetTransferRestrictionsParams](/polymesh-sdk-api-reference/docs-v4/globals.md#settransferrestrictionsparams)
* [Signer](/polymesh-sdk-api-reference/docs-v4/globals.md#signer)
* [SingleClaimCondition](/polymesh-sdk-api-reference/docs-v4/globals.md#singleclaimcondition)
* [SubCallback](/polymesh-sdk-api-reference/docs-v4/globals.md#subcallback)
* [TokenType](/polymesh-sdk-api-reference/docs-v4/globals.md#tokentype)
* [TransactionArgument](/polymesh-sdk-api-reference/docs-v4/globals.md#transactionargument)
* [UnionOfProcedures](/polymesh-sdk-api-reference/docs-v4/globals.md#unionofprocedures)
* [UnscopedClaim](/polymesh-sdk-api-reference/docs-v4/globals.md#unscopedclaim)
* [UnsubCallback](/polymesh-sdk-api-reference/docs-v4/globals.md#unsubcallback)

### Functions

* [areSameClaimIssuers](/polymesh-sdk-api-reference/docs-v4/globals.md#const-aresameclaimissuers)
* [areSameClaims](/polymesh-sdk-api-reference/docs-v4/globals.md#const-aresameclaims)
* [convertArgsToRaw](/polymesh-sdk-api-reference/docs-v4/globals.md#const-convertargstoraw)
* [createProcedureMethod](/polymesh-sdk-api-reference/docs-v4/globals.md#createproceduremethod)
* [findClaimsByOtherIssuers](/polymesh-sdk-api-reference/docs-v4/globals.md#const-findclaimsbyotherissuers)
* [findPositiveBalanceIuClaims](/polymesh-sdk-api-reference/docs-v4/globals.md#const-findpositivebalanceiuclaims)
* [tickerToDid](/polymesh-sdk-api-reference/docs-v4/globals.md#tickertodid)
* [tuple](/polymesh-sdk-api-reference/docs-v4/globals.md#const-tuple)
* [txGroupToTxTags](/polymesh-sdk-api-reference/docs-v4/globals.md#txgrouptotxtags)

### Object literals

* [ErrorMessagesPerCode](/polymesh-sdk-api-reference/docs-v4/globals.md#const-errormessagespercode)

## Type aliases

### AddCountTransferRestrictionParams

Ƭ **AddCountTransferRestrictionParams**: [*CountTransferRestrictionInput*](/polymesh-sdk-api-reference/docs-v4/interfaces/counttransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/addTransferRestriction.ts#L24)

### AddPercentageTransferRestrictionParams

Ƭ **AddPercentageTransferRestrictionParams**: [*PercentageTransferRestrictionInput*](/polymesh-sdk-api-reference/docs-v4/interfaces/percentagetransferrestrictioninput.md) *& object*

*Defined in* [*src/api/procedures/addTransferRestriction.ts:28*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/addTransferRestriction.ts#L28)

### AddRestrictionParams

Ƭ **AddRestrictionParams**: *Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:29*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L29)

### Authorization

Ƭ **Authorization**: *object | object | object | object*

*Defined in* [*src/types/index.ts:232*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L232)

Authorization request data corresponding to type

### CddClaim

Ƭ **CddClaim**: *object*

*Defined in* [*src/types/index.ts:278*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L278)

#### Type declaration:

* **id**: *string*
* **type**: [*CustomerDueDiligence*](/polymesh-sdk-api-reference/docs-v4/enums/claimtype.md#customerduediligence)

### Claim

Ƭ **Claim**: [*ScopedClaim*](/polymesh-sdk-api-reference/docs-v4/globals.md#scopedclaim) *|* [*UnscopedClaim*](/polymesh-sdk-api-reference/docs-v4/globals.md#unscopedclaim)

*Defined in* [*src/types/index.ts:303*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L303)

### CommonKeyring

Ƭ **CommonKeyring**: *Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri" | "addFromMnemonic"›*

*Defined in* [*src/types/index.ts:487*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L487)

### Condition

Ƭ **Condition**: [*SingleClaimCondition*](/polymesh-sdk-api-reference/docs-v4/globals.md#singleclaimcondition) *|* [*MultiClaimCondition*](/polymesh-sdk-api-reference/docs-v4/globals.md#multiclaimcondition) *|* [*IdentityCondition*](/polymesh-sdk-api-reference/docs-v4/globals.md#identitycondition) *|* [*PrimaryIssuanceAgentCondition*](/polymesh-sdk-api-reference/docs-v4/globals.md#primaryissuanceagentcondition)

*Defined in* [*src/types/index.ts:389*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L389)

### ConditionBase

Ƭ **ConditionBase**: *object*

*Defined in* [*src/types/index.ts:368*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L368)

#### Type declaration:

* **target**: [*ConditionTarget*](/polymesh-sdk-api-reference/docs-v4/enums/conditiontarget.md)
* **trustedClaimIssuers**? : [*TrustedClaimIssuer*](/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer.md)*\[]*

### Ensured

Ƭ **Ensured**: *Required‹Pick‹T, K››*

*Defined in* [*src/types/index.ts:480*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L480)

### GetReturnType

Ƭ **GetReturnType**: [*ActiveTransferRestrictions*](/polymesh-sdk-api-reference/docs-v4/interfaces/activetransferrestrictions.md)*‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:43*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L43)

### IdentityCondition

Ƭ **IdentityCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v4/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:380*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L380)

### InstructionDetails

Ƭ **InstructionDetails**: *object & object | object*

*Defined in* [*src/api/entities/Instruction/types.ts:15*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/types.ts#L15)

### InvestorUniquenessClaim

Ƭ **InvestorUniquenessClaim**: *object*

*Defined in* [*src/types/index.ts:280*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L280)

#### Type declaration:

* **cddId**: *string*
* **scope**: [*Scope*](/polymesh-sdk-api-reference/docs-v4/interfaces/scope.md)
* **scopeId**: *string*
* **type**: [*InvestorUniqueness*](/polymesh-sdk-api-reference/docs-v4/enums/claimtype.md#investoruniqueness)

### ModifyClaimsParams

Ƭ **ModifyClaimsParams**: [*AddClaimsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/addclaimsparams.md) *|* [*EditClaimsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/editclaimsparams.md) *|* [*RevokeClaimsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/revokeclaimsparams.md)

*Defined in* [*src/api/procedures/modifyClaims.ts:54*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L54)

### ModifyStoTimesParams

Ƭ **ModifyStoTimesParams**: *object | object | object*

*Defined in* [*src/api/procedures/modifyStoTimes.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyStoTimes.ts#L9)

### ModifyTokenParams

Ƭ **ModifyTokenParams**: *object | object | object | object*

*Defined in* [*src/api/procedures/modifyToken.ts:13*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyToken.ts#L13)

### MultiClaimCondition

Ƭ **MultiClaimCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v4/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:375*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L375)

### Mutable

Ƭ **Mutable**: *object*

*Defined in* [*src/types/utils/index.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L3)

#### Type declaration:

### NextKey

Ƭ **NextKey**: *string | number | null*

*Defined in* [*src/types/index.ts:516*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L516)

### PortfolioLike

Ƭ **PortfolioLike**: *string |* [*Identity*](/polymesh-sdk-api-reference/docs-v4/classes/identity.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v4/classes/numberedportfolio.md) *|* [*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v4/classes/defaultportfolio.md) *| object*

*Defined in* [*src/types/index.ts:705*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L705)

### PrimaryIssuanceAgentCondition

Ƭ **PrimaryIssuanceAgentCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v4/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:385*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L385)

### Role

Ƭ **Role**: [*TickerOwnerRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/tickerownerrole.md) *|* [*TokenOwnerRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenownerrole.md) *|* [*TokenPiaRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/tokenpiarole.md) *|* [*CddProviderRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/cddproviderrole.md) *|* [*VenueOwnerRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/venueownerrole.md) *|* [*PortfolioCustodianRole*](/polymesh-sdk-api-reference/docs-v4/interfaces/portfoliocustodianrole.md)

*Defined in* [*src/types/index.ts:159*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L159)

### ScopedClaim

Ƭ **ScopedClaim**: *object |* [*InvestorUniquenessClaim*](/polymesh-sdk-api-reference/docs-v4/globals.md#investoruniquenessclaim) *| object*

*Defined in* [*src/types/index.ts:287*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L287)

### SetRestrictionsParams

Ƭ **SetRestrictionsParams**: *Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›*

*Defined in* [*src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts#L36)

### SetTransferRestrictionsParams

Ƭ **SetTransferRestrictionsParams**: *object &* [*SetCountTransferRestrictionsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/setcounttransferrestrictionsparams.md) *|* [*SetPercentageTransferRestrictionsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/setpercentagetransferrestrictionsparams.md)

*Defined in* [*src/api/procedures/setTransferRestrictions.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/setTransferRestrictions.ts#L36)

### Signer

Ƭ **Signer**: [*Identity*](/polymesh-sdk-api-reference/docs-v4/classes/identity.md) *|* [*Account*](/polymesh-sdk-api-reference/docs-v4/classes/account.md)

*Defined in* [*src/types/index.ts:615*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L615)

### SingleClaimCondition

Ƭ **SingleClaimCondition**: [*ConditionBase*](/polymesh-sdk-api-reference/docs-v4/globals.md#conditionbase) *& object*

*Defined in* [*src/types/index.ts:370*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L370)

### SubCallback

Ƭ **SubCallback**: *function*

*Defined in* [*src/types/index.ts:476*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L476)

#### Type declaration:

▸ (`result`: T): *void | Promise‹void›*

**Parameters:**

| Name     | Type |
| -------- | ---- |
| `result` | T    |

### TokenType

Ƭ **TokenType**: [*KnownTokenType*](/polymesh-sdk-api-reference/docs-v4/enums/knowntokentype.md) *| object*

*Defined in* [*src/types/index.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L182)

Type of security that the token represents

### TransactionArgument

Ƭ **TransactionArgument**: *object &* [*PlainTransactionArgument*](/polymesh-sdk-api-reference/docs-v4/interfaces/plaintransactionargument.md) *|* [*ArrayTransactionArgument*](/polymesh-sdk-api-reference/docs-v4/interfaces/arraytransactionargument.md) *|* [*SimpleEnumTransactionArgument*](/polymesh-sdk-api-reference/docs-v4/interfaces/simpleenumtransactionargument.md) *|* [*ComplexTransactionArgument*](/polymesh-sdk-api-reference/docs-v4/interfaces/complextransactionargument.md)

*Defined in* [*src/types/index.ts:604*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L604)

### UnionOfProcedures

Ƭ **UnionOfProcedures**: *Args extends unknown ? Procedure‹Args, ReturnValue, Storage› : never*

*Defined in* [*src/types/utils/index.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L7)

### UnscopedClaim

Ƭ **UnscopedClaim**: *object |* [*CddClaim*](/polymesh-sdk-api-reference/docs-v4/globals.md#cddclaim)

*Defined in* [*src/types/index.ts:301*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L301)

### UnsubCallback

Ƭ **UnsubCallback**: *function*

*Defined in* [*src/types/index.ts:478*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/index.ts#L478)

#### Type declaration:

▸ (): *void*

## Functions

### `Const` areSameClaimIssuers

▸ **areSameClaimIssuers**(`currentClaimIssuers`: [TrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer.md)\[], `claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]): *boolean*

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L65)

**Parameters:**

| Name                  | Type                                                                                          |
| --------------------- | --------------------------------------------------------------------------------------------- |
| `currentClaimIssuers` | [TrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v4/interfaces/trustedclaimissuer.md)\[] |
| `claimIssuers`        | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]                                   |

**Returns:** *boolean*

### `Const` areSameClaims

▸ **areSameClaims**(`claim`: [Claim](/polymesh-sdk-api-reference/docs-v4/globals.md#claim), `__namedParameters`: object): *boolean*

*Defined in* [*src/api/procedures/modifyClaims.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L65)

**Parameters:**

▪ **claim**: [*Claim*](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)

▪ **\_\_namedParameters**: *object*

| Name    | Type                                                                        |
| ------- | --------------------------------------------------------------------------- |
| `scope` | Falsyable‹[Scope](/polymesh-sdk-api-reference/docs-v4/interfaces/scope.md)› |
| `type`  | ClaimTypeEnum                                                               |

**Returns:** *boolean*

### `Const` convertArgsToRaw

▸ **convertArgsToRaw**(`claimIssuers`: ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"], `rawTicker`: Ticker, `context`: [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md)): *object*

*Defined in* [*src/api/procedures/modifyTokenTrustedClaimIssuers.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyTokenTrustedClaimIssuers.ts#L36)

**Parameters:**

| Name           | Type                                                              |
| -------------- | ----------------------------------------------------------------- |
| `claimIssuers` | ModifyTokenTrustedClaimIssuersAddSetParams\["claimIssuers"]       |
| `rawTicker`    | Ticker                                                            |
| `context`      | [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md) |

**Returns:** *object*

* **claimIssuersToAdd**: *\[Ticker, TrustedIssuer]\[]*
* **inputDids**: *string\[]*

### createProcedureMethod

▸ **createProcedureMethod**‹**MethodArgs**, **ProcedureArgs**, **ReturnValue**, **Storage**›(`getProcedureAndArgs`: function, `context`: [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md)): *ProcedureMethod‹MethodArgs, ReturnValue›*

*Defined in* [*src/utils/internal.ts:377*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/internal.ts#L377)

Create a method that prepares a procedure

**Type parameters:**

▪ **MethodArgs**

▪ **ProcedureArgs**: *unknown*

▪ **ReturnValue**

▪ **Storage**

**Parameters:**

▪ **getProcedureAndArgs**: *function*

▸ (`args`: MethodArgs): *\[*[*UnionOfProcedures*](/polymesh-sdk-api-reference/docs-v4/globals.md#unionofprocedures)*‹ProcedureArgs, ReturnValue, Storage› | Procedure‹ProcedureArgs, ReturnValue, Storage›, ProcedureArgs]*

**Parameters:**

| Name   | Type       |
| ------ | ---------- |
| `args` | MethodArgs |

▪ **context**: [*Context*](/polymesh-sdk-api-reference/docs-v4/classes/context.md)

**Returns:** *ProcedureMethod‹MethodArgs, ReturnValue›*

### `Const` findClaimsByOtherIssuers

▸ **findClaimsByOtherIssuers**(`claims`: [ClaimTarget](/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget.md)\[], `claimsByDid`: Record‹string, MiddlewareClaim\[]›): [*Claim*](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)*\[]*

*Defined in* [*src/api/procedures/modifyClaims.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L75)

**Parameters:**

| Name          | Type                                                                            |
| ------------- | ------------------------------------------------------------------------------- |
| `claims`      | [ClaimTarget](/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget.md)\[] |
| `claimsByDid` | Record‹string, MiddlewareClaim\[]›                                              |

**Returns:** [*Claim*](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)*\[]*

### `Const` findPositiveBalanceIuClaims

▸ **findPositiveBalanceIuClaims**(`claims`: [ClaimTarget](/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget.md)\[], `context`: [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md)): *Promise‹*[*Claim*](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)*\[]›*

*Defined in* [*src/api/procedures/modifyClaims.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/procedures/modifyClaims.ts#L91)

**Parameters:**

| Name      | Type                                                                            |
| --------- | ------------------------------------------------------------------------------- |
| `claims`  | [ClaimTarget](/polymesh-sdk-api-reference/docs-v4/interfaces/claimtarget.md)\[] |
| `context` | [Context](/polymesh-sdk-api-reference/docs-v4/classes/context.md)               |

**Returns:** *Promise‹*[*Claim*](/polymesh-sdk-api-reference/docs-v4/globals.md#claim)*\[]›*

### tickerToDid

▸ **tickerToDid**(`ticker`: string): *string*

*Defined in* [*src/utils/conversion.ts:181*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/conversion.ts#L181)

Generate a Security Token's DID from a ticker

**Parameters:**

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

**Returns:** *string*

### `Const` tuple

▸ **tuple**‹**T**›(...`args`: T): *T*

*Defined in* [*src/types/utils/index.ts:16*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/types/utils/index.ts#L16)

Create a literal tuple type from a list of arguments

**Type parameters:**

▪ **T**: *unknown\[]*

**Parameters:**

| Name      | Type | Description                 |
| --------- | ---- | --------------------------- |
| `...args` | T    | values to turn into a tuple |

**Returns:** *T*

### txGroupToTxTags

▸ **txGroupToTxTags**(`group`: [TxGroup](/polymesh-sdk-api-reference/docs-v4/enums/txgroup.md)): *TxTag\[]*

*Defined in* [*src/utils/conversion.ts:525*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/utils/conversion.ts#L525)

Retrieve every Transaction Tag associated to a Transaction Group

**Parameters:**

| Name    | Type                                                            |
| ------- | --------------------------------------------------------------- |
| `group` | [TxGroup](/polymesh-sdk-api-reference/docs-v4/enums/txgroup.md) |

**Returns:** *TxTag\[]*

## Object literals

### `Const` ErrorMessagesPerCode

### ▪ **ErrorMessagesPerCode**: *object*

*Defined in* [*src/base/PolymeshError.ts:3*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/base/PolymeshError.ts#L3)

### \[ErrorCode.TransactionAborted]

• **\[ErrorCode.TransactionAborted]**: *string* = "The transaction was removed from the transaction pool. This might mean that it was malformed (nonce too large/nonce too small/duplicated or invalid transaction)"

*Defined in* [*src/base/PolymeshError.ts:7*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/base/PolymeshError.ts#L7)

### \[ErrorCode.TransactionRejectedByUser]

• **\[ErrorCode.TransactionRejectedByUser]**: *string* = "The user canceled the transaction signature"

*Defined in* [*src/base/PolymeshError.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/base/PolymeshError.ts#L9)

### \[ErrorCode.TransactionReverted]

• **\[ErrorCode.TransactionReverted]**: *string* = "The transaction execution reverted due to an error"

*Defined in* [*src/base/PolymeshError.ts:6*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/base/PolymeshError.ts#L6)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.