# types

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / types

## Module: types

### Table of contents

#### References

* [AffirmationStatus](#affirmationstatus)
* [AgentWithGroup](#agentwithgroup)
* [AssetDetails](#assetdetails)
* [CaCheckpointType](#cacheckpointtype)
* [CheckpointScheduleParams](#checkpointscheduleparams)
* [CorporateActionDefaultConfig](#corporateactiondefaultconfig)
* [CorporateActionKind](#corporateactionkind)
* [CorporateActionParams](#corporateactionparams)
* [CorporateActionTargets](#corporateactiontargets)
* [DistributionParticipant](#distributionparticipant)
* [DividendDistributionDetails](#dividenddistributiondetails)
* [DividendDistributionParams](#dividenddistributionparams)
* [HistoricSettlement](#historicsettlement)
* [IdentityBalance](#identitybalance)
* [InputCaCheckpoint](#inputcacheckpoint)
* [InputTargets](#inputtargets)
* [InputTaxWithholding](#inputtaxwithholding)
* [InstructionAffirmation](#instructionaffirmation)
* [InstructionDetails](#instructiondetails)
* [InstructionStatus](#instructionstatus)
* [InstructionStatusResult](#instructionstatusresult)
* [InstructionType](#instructiontype)
* [Investment](#investment)
* [Leg](#leg)
* [OfferingBalanceStatus](#offeringbalancestatus)
* [OfferingDetails](#offeringdetails)
* [OfferingSaleStatus](#offeringsalestatus)
* [OfferingStatus](#offeringstatus)
* [OfferingTier](#offeringtier)
* [OfferingTimingStatus](#offeringtimingstatus)
* [PortfolioBalance](#portfoliobalance)
* [ScheduleDetails](#scheduledetails)
* [SettlementLeg](#settlementleg)
* [SubsidyData](#subsidydata)
* [SubsidyWithAllowance](#subsidywithallowance)
* [TargetTreatment](#targettreatment)
* [TaxWithholding](#taxwithholding)
* [TickerReservationDetails](#tickerreservationdetails)
* [TickerReservationStatus](#tickerreservationstatus)
* [Tier](#tier)
* [TransferBreakdown](#transferbreakdown)
* [TransferRestrictionResult](#transferrestrictionresult)
* [VenueDetails](#venuedetails)
* [VenueType](#venuetype)

#### Enumerations

* [AuthorizationType](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md)
* [CalendarUnit](/polymesh-sdk-api-reference/docs-alpha/enums/types.calendarunit.md)
* [ClaimType](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md)
* [ConditionTarget](/polymesh-sdk-api-reference/docs-alpha/enums/types.conditiontarget.md)
* [ConditionType](/polymesh-sdk-api-reference/docs-alpha/enums/types.conditiontype.md)
* [ErrorCode](/polymesh-sdk-api-reference/docs-alpha/enums/types.errorcode.md)
* [KnownAssetType](/polymesh-sdk-api-reference/docs-alpha/enums/types.knownassettype.md)
* [PayingAccountType](/polymesh-sdk-api-reference/docs-alpha/enums/types.payingaccounttype.md)
* [PermissionGroupType](/polymesh-sdk-api-reference/docs-alpha/enums/types.permissiongrouptype.md)
* [PermissionType](/polymesh-sdk-api-reference/docs-alpha/enums/types.permissiontype.md)
* [RoleType](/polymesh-sdk-api-reference/docs-alpha/enums/types.roletype.md)
* [ScopeType](/polymesh-sdk-api-reference/docs-alpha/enums/types.scopetype.md)
* [SecurityIdentifierType](/polymesh-sdk-api-reference/docs-alpha/enums/types.securityidentifiertype.md)
* [SignerType](/polymesh-sdk-api-reference/docs-alpha/enums/types.signertype.md)
* [TransactionArgumentType](/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionargumenttype.md)
* [TransactionQueueStatus](/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionqueuestatus.md)
* [TransactionStatus](/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionstatus.md)
* [TransferError](/polymesh-sdk-api-reference/docs-alpha/enums/types.transfererror.md)
* [TransferRestrictionType](/polymesh-sdk-api-reference/docs-alpha/enums/types.transferrestrictiontype.md)
* [TransferStatus](/polymesh-sdk-api-reference/docs-alpha/enums/types.transferstatus.md)
* [TxGroup](/polymesh-sdk-api-reference/docs-alpha/enums/types.txgroup.md)

#### Interfaces

* [AccreditedClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.accreditedclaim.md)
* [ActiveTransferRestrictions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.activetransferrestrictions.md)
* [AffiliateClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.affiliateclaim.md)
* [ArrayTransactionArgument](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.arraytransactionargument.md)
* [AssetDocument](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.assetdocument.md)
* [AssetWithGroup](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.assetwithgroup.md)
* [Balance](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance.md)
* [BlockedClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.blockedclaim.md)
* [BuyLockupClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.buylockupclaim.md)
* [CalendarPeriod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.calendarperiod.md)
* [CddClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim.md)
* [CddProviderRole](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddproviderrole.md)
* [CheckPermissionsResult](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpermissionsresult.md)
* [CheckRolesResult](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkrolesresult.md)
* [CheckpointWithData](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpointwithdata.md)
* [ClaimData](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)
* [ClaimScope](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope.md)
* [ClaimTarget](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimtarget.md)
* [ComplexTransactionArgument](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.complextransactionargument.md)
* [Compliance](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.compliance.md)
* [ComplianceRequirements](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.compliancerequirements.md)
* [ConditionBase](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase.md)
* [ConditionCompliance](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditioncompliance.md)
* [CountTransferRestriction](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.counttransferrestriction.md)
* [CountTransferRestrictionInput](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.counttransferrestrictioninput.md)
* [DistributionPayment](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionpayment.md)
* [DistributionWithDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionwithdetails.md)
* [EventIdentifier](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.eventidentifier.md)
* [ExemptKey](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptkey.md)
* [ExemptedClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptedclaim.md)
* [ExternalAgentCondition](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition.md)
* [ExtrinsicData](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdata.md)
* [ExtrinsicDataWithFees](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdatawithfees.md)
* [Fees](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.fees.md)
* [FeesBreakdown](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.feesbreakdown.md)
* [GroupedInstructions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.groupedinstructions.md)
* [HistoricAgentOperation](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.historicagentoperation.md)
* [IdentityCondition](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition.md)
* [IdentityRole](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identityrole.md)
* [IdentityWithClaims](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims.md)
* [InvestorUniquenessClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim.md)
* [InvestorUniquenessV2Claim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessv2claim.md)
* [JurisdictionClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.jurisdictionclaim.md)
* [KycClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.kycclaim.md)
* [MiddlewareConfig](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.middlewareconfig.md)
* [MultiClaimCondition](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition.md)
* [NetworkProperties](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.networkproperties.md)
* [NoArgsProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod.md)
* [NoDataClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.nodataclaim.md)
* [NoTypeClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.notypeclaim.md)
* [OfferingWithDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.offeringwithdetails.md)
* [PaginationOptions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.paginationoptions.md)
* [PayingAccount](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.payingaccount.md)
* [PercentageTransferRestriction](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.percentagetransferrestriction.md)
* [PercentageTransferRestrictionInput](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.percentagetransferrestrictioninput.md)
* [PermissionGroups](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissiongroups.md)
* [PermissionedAccount](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissionedaccount.md)
* [Permissions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions.md)
* [PlainTransactionArgument](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.plaintransactionargument.md)
* [PortfolioCustodianRole](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliocustodianrole.md)
* [PortfolioMovement](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliomovement.md)
* [ProcedureAuthorizationStatus](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureauthorizationstatus.md)
* [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md)
* [ProcedureOpts](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)
* [ProtocolFees](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.protocolfees.md)
* [Requirement](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirement.md)
* [RequirementCompliance](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirementcompliance.md)
* [ResultSet](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)
* [ScheduleWithDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.schedulewithdetails.md)
* [Scope](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope.md)
* [SectionPermissions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions.md)
* [SecurityIdentifier](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.securityidentifier.md)
* [SellLockupClaim](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.selllockupclaim.md)
* [SignerValue](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.signervalue.md)
* [SimpleEnumTransactionArgument](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simpleenumtransactionargument.md)
* [SimplePermissions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simplepermissions.md)
* [SingleClaimCondition](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition.md)
* [ThirdPartyFees](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.thirdpartyfees.md)
* [TickerOwnerRole](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.tickerownerrole.md)
* [TransactionPermissions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transactionpermissions.md)
* [TransferRestriction](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transferrestriction.md)
* [TrustedClaimIssuer](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.trustedclaimissuer.md)
* [VenueOwnerRole](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.venueownerrole.md)

#### Type Aliases

* [AccountBalance](#accountbalance)
* [AddRelayerPayingKeyAuthorizationData](#addrelayerpayingkeyauthorizationdata)
* [Authorization](#authorization)
* [BecomeAgentAuthorizationData](#becomeagentauthorizationdata)
* [Claim](#claim)
* [Condition](#condition)
* [GenericAuthorizationData](#genericauthorizationdata)
* [GroupPermissions](#grouppermissions)
* [InputCondition](#inputcondition)
* [InputConditionBase](#inputconditionbase)
* [InputCorporateActionTargets](#inputcorporateactiontargets)
* [InputCorporateActionTaxWithholdings](#inputcorporateactiontaxwithholdings)
* [InputRequirement](#inputrequirement)
* [InputTrustedClaimIssuer](#inputtrustedclaimissuer)
* [JoinIdentityAuthorizationData](#joinidentityauthorizationdata)
* [NextKey](#nextkey)
* [PermissionsLike](#permissionslike)
* [PortfolioCustodyAuthorizationData](#portfoliocustodyauthorizationdata)
* [PortfolioLike](#portfoliolike)
* [PrivateKey](#privatekey)
* [Role](#role)
* [RotatePrimaryKeyAuthorizationData](#rotateprimarykeyauthorizationdata)
* [RotatePrimaryKeyToSecondaryData](#rotateprimarykeytosecondarydata)
* [ScopedClaim](#scopedclaim)
* [Signer](#signer)
* [SubCallback](#subcallback)
* [TransactionArgument](#transactionargument)
* [UnscopedClaim](#unscopedclaim)
* [UnsubCallback](#unsubcallback)

### References

#### AffirmationStatus

Re-exports [AffirmationStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.affirmationstatus.md)

***

#### AgentWithGroup

Re-exports [AgentWithGroup](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.agentwithgroup.md)

***

#### AssetDetails

Re-exports [AssetDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.assetdetails.md)

***

#### CaCheckpointType

Re-exports [CaCheckpointType](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_asset_checkpoints_types.cacheckpointtype.md)

***

#### CheckpointScheduleParams

Re-exports [CheckpointScheduleParams](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpointschedule_types.md#checkpointscheduleparams)

***

#### CorporateActionDefaultConfig

Re-exports [CorporateActionDefaultConfig](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_corporateactions_types.corporateactiondefaultconfig.md)

***

#### CorporateActionKind

Re-exports [CorporateActionKind](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_corporateactionbase_types.corporateactionkind.md)

***

#### CorporateActionParams

Renames and re-exports [Params](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase.params.md)

***

#### CorporateActionTargets

Re-exports [CorporateActionTargets](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.corporateactiontargets.md)

***

#### DistributionParticipant

Re-exports [DistributionParticipant](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant.md)

***

#### DividendDistributionDetails

Re-exports [DividendDistributionDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.dividenddistributiondetails.md)

***

#### DividendDistributionParams

Re-exports [DividendDistributionParams](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution.dividenddistributionparams.md)

***

#### HistoricSettlement

Re-exports [HistoricSettlement](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.historicsettlement.md)

***

#### IdentityBalance

Re-exports [IdentityBalance](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.identitybalance.md)

***

#### InputCaCheckpoint

Re-exports [InputCaCheckpoint](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_types.md#inputcacheckpoint)

***

#### InputTargets

Re-exports [InputTargets](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase_types.md#inputtargets)

***

#### InputTaxWithholding

Re-exports [InputTaxWithholding](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase_types.md#inputtaxwithholding)

***

#### InstructionAffirmation

Re-exports [InstructionAffirmation](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.instructionaffirmation.md)

***

#### InstructionDetails

Re-exports [InstructionDetails](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction_types.md#instructiondetails)

***

#### InstructionStatus

Re-exports [InstructionStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md)

***

#### InstructionStatusResult

Re-exports [InstructionStatusResult](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction_types.md#instructionstatusresult)

***

#### InstructionType

Re-exports [InstructionType](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructiontype.md)

***

#### Investment

Re-exports [Investment](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.investment.md)

***

#### Leg

Re-exports [Leg](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.leg.md)

***

#### OfferingBalanceStatus

Re-exports [OfferingBalanceStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringbalancestatus.md)

***

#### OfferingDetails

Re-exports [OfferingDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringdetails.md)

***

#### OfferingSaleStatus

Re-exports [OfferingSaleStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringsalestatus.md)

***

#### OfferingStatus

Re-exports [OfferingStatus](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringstatus.md)

***

#### OfferingTier

Re-exports [OfferingTier](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringtier.md)

***

#### OfferingTimingStatus

Re-exports [OfferingTimingStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringtimingstatus.md)

***

#### PortfolioBalance

Re-exports [PortfolioBalance](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.portfoliobalance.md)

***

#### ScheduleDetails

Re-exports [ScheduleDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_checkpointschedule_types.scheduledetails.md)

***

#### SettlementLeg

Re-exports [SettlementLeg](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.settlementleg.md)

***

#### SubsidyData

Re-exports [SubsidyData](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidydata.md)

***

#### SubsidyWithAllowance

Re-exports [SubsidyWithAllowance](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidywithallowance.md)

***

#### TargetTreatment

Re-exports [TargetTreatment](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_corporateactionbase_types.targettreatment.md)

***

#### TaxWithholding

Re-exports [TaxWithholding](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.taxwithholding.md)

***

#### TickerReservationDetails

Re-exports [TickerReservationDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation_types.tickerreservationdetails.md)

***

#### TickerReservationStatus

Re-exports [TickerReservationStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_tickerreservation_types.tickerreservationstatus.md)

***

#### Tier

Re-exports [Tier](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.tier.md)

***

#### TransferBreakdown

Re-exports [TransferBreakdown](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.transferbreakdown.md)

***

#### TransferRestrictionResult

Re-exports [TransferRestrictionResult](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.transferrestrictionresult.md)

***

#### VenueDetails

Re-exports [VenueDetails](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_venue_types.venuedetails.md)

***

#### VenueType

Re-exports [VenueType](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_venue_types.venuetype.md)

### Type Aliases

#### AccountBalance

Ƭ **AccountBalance**: [`Balance`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance.md)

**Defined in**

[types/index.ts:682](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L682)

***

#### AddRelayerPayingKeyAuthorizationData

Ƭ **AddRelayerPayingKeyAuthorizationData**: `Object`

**Type declaration**

| Name    | Type                                                                                                                 |
| ------- | -------------------------------------------------------------------------------------------------------------------- |
| `type`  | [`AddRelayerPayingKey`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#addrelayerpayingkey) |
| `value` | [`SubsidyData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidydata.md)         |

**Defined in**

[types/index.ts:1062](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1062)

***

#### Authorization

Ƭ **Authorization**: [`RotatePrimaryKeyAuthorizationData`](#rotateprimarykeyauthorizationdata) | [`JoinIdentityAuthorizationData`](#joinidentityauthorizationdata) | [`PortfolioCustodyAuthorizationData`](#portfoliocustodyauthorizationdata) | [`BecomeAgentAuthorizationData`](#becomeagentauthorizationdata) | [`AddRelayerPayingKeyAuthorizationData`](#addrelayerpayingkeyauthorizationdata) | [`RotatePrimaryKeyToSecondaryData`](#rotateprimarykeytosecondarydata) | [`GenericAuthorizationData`](#genericauthorizationdata)

Authorization request data corresponding to type

**Defined in**

[types/index.ts:1082](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1082)

***

#### BecomeAgentAuthorizationData

Ƭ **BecomeAgentAuthorizationData**: `Object`

**Type declaration**

| Name    | Type                                                                                                                                                                                                                                                                        |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`  | [`BecomeAgent`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#becomeagent)                                                                                                                                                                        |
| `value` | [`KnownPermissionGroup`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_knownpermissiongroup.knownpermissiongroup.md) \| [`CustomPermissionGroup`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_custompermissiongroup.custompermissiongroup.md) |

**Defined in**

[types/index.ts:1057](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1057)

***

#### Claim

Ƭ **Claim**: [`ScopedClaim`](#scopedclaim) | [`UnscopedClaim`](#unscopedclaim)

**Defined in**

[types/index.ts:307](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L307)

***

#### Condition

Ƭ **Condition**: [`SingleClaimCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition.md) | [`MultiClaimCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition.md) | [`IdentityCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition.md) | [`ExternalAgentCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition.md) & [`ConditionBase`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase.md)

**Defined in**

[types/index.ts:420](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L420)

***

#### GenericAuthorizationData

Ƭ **GenericAuthorizationData**: `Object`

**Type declaration**

| Name    | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`  | `Exclude`<[`AuthorizationType`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md), [`RotatePrimaryKey`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#rotateprimarykey) \| [`JoinIdentity`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#joinidentity) \| [`PortfolioCustody`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#portfoliocustody) \| [`BecomeAgent`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#becomeagent) \| [`AddRelayerPayingKey`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#addrelayerpayingkey) \| [`RotatePrimaryKeyToSecondary`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#rotateprimarykeytosecondary)> |
| `value` | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

**Defined in**

[types/index.ts:1067](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1067)

***

#### GroupPermissions

Ƭ **GroupPermissions**: `Pick`<[`Permissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions.md), `"transactions"` | `"transactionGroups"`>

Asset permissions shared by agents in a group

**Defined in**

[types/index.ts:945](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L945)

***

#### InputCondition

Ƭ **InputCondition**: [`SingleClaimCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition.md) | [`MultiClaimCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition.md) | [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`IdentityCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition.md), { `identity`: `string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) }> | [`ExternalAgentCondition`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition.md) & [`InputConditionBase`](#inputconditionbase)

**Defined in**

[types/index.ts:428](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L428)

***

#### InputConditionBase

Ƭ **InputConditionBase**: [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`ConditionBase`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase.md), { `trustedClaimIssuers?`: [`InputTrustedClaimIssuer`](#inputtrustedclaimissuer)\[] }>

**Defined in**

[types/index.ts:391](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L391)

***

#### InputCorporateActionTargets

Ƭ **InputCorporateActionTargets**: [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`CorporateActionTargets`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.corporateactiontargets.md), { `identities`: (`string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md))\[] }>

Targets of a corporate action in a flexible structure for input purposes

**Defined in**

[types/index.ts:1419](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1419)

***

#### InputCorporateActionTaxWithholdings

Ƭ **InputCorporateActionTaxWithholdings**: [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`TaxWithholding`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.taxwithholding.md), { `identity`: `string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) }>\[]

Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes

**Defined in**

[types/index.ts:1429](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1429)

***

#### InputRequirement

Ƭ **InputRequirement**: [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`Requirement`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirement.md), { `conditions`: [`InputCondition`](#inputcondition)\[] }>

**Defined in**

[types/index.ts:454](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L454)

***

#### InputTrustedClaimIssuer

Ƭ **InputTrustedClaimIssuer**: [`Modify`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md#modify)<[`TrustedClaimIssuer`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.trustedclaimissuer.md), { `identity`: `string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) }>

**Defined in**

[types/index.ts:367](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L367)

***

#### JoinIdentityAuthorizationData

Ƭ **JoinIdentityAuthorizationData**: `Object`

**Type declaration**

| Name    | Type                                                                                                   |
| ------- | ------------------------------------------------------------------------------------------------------ |
| `type`  | [`JoinIdentity`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#joinidentity) |
| `value` | [`Permissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions.md)                |

**Defined in**

[types/index.ts:1047](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1047)

***

#### NextKey

Ƭ **NextKey**: `string` | `BigNumber` | `null`

**Defined in**

[types/index.ts:689](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L689)

***

#### PermissionsLike

Ƭ **PermissionsLike**: { `assets?`: [`SectionPermissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions.md)<`string` | [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)> | `null` ; `portfolios?`: [`SectionPermissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions.md)<[`PortfolioLike`](#portfoliolike)> | `null` } & { `transactions?`: [`TransactionPermissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transactionpermissions.md) | `null` } | { `transactionGroups?`: [`TxGroup`](/polymesh-sdk-api-reference/docs-alpha/enums/types.txgroup.md)\[] }

Permissions to grant to a Signer over an Identity

[Permissions](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions.md)

**`note`** TxGroups in the `transactionGroups` array will be transformed into their corresponding `TxTag`s

**Defined in**

[types/index.ts:1180](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1180)

***

#### PortfolioCustodyAuthorizationData

Ƭ **PortfolioCustodyAuthorizationData**: `Object`

**Type declaration**

| Name    | Type                                                                                                                                                                                                                                                |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`  | [`PortfolioCustody`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#portfoliocustody)                                                                                                                                      |
| `value` | [`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md) \| [`DefaultPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio.md) |

**Defined in**

[types/index.ts:1052](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1052)

***

#### PortfolioLike

Ƭ **PortfolioLike**: `string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | [`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md) | [`DefaultPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio.md) | { `id`: `BigNumber` ; `identity`: `string` | [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) }

**Defined in**

[types/index.ts:1166](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1166)

***

#### PrivateKey

Ƭ **PrivateKey**: { `uri`: `string` } | { `mnemonic`: `string` } | { `seed`: `string` }

URI|mnemonic|hex representation of a private key

**Defined in**

[types/index.ts:1405](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1405)

***

#### Role

Ƭ **Role**: [`TickerOwnerRole`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.tickerownerrole.md) | [`CddProviderRole`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddproviderrole.md) | [`VenueOwnerRole`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.venueownerrole.md) | [`PortfolioCustodianRole`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliocustodianrole.md) | [`IdentityRole`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identityrole.md)

**Defined in**

[types/index.ts:125](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L125)

***

#### RotatePrimaryKeyAuthorizationData

Ƭ **RotatePrimaryKeyAuthorizationData**: `Object`

**Type declaration**

| Name   | Type                                                                                                           |
| ------ | -------------------------------------------------------------------------------------------------------------- |
| `type` | [`RotatePrimaryKey`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#rotateprimarykey) |

**Defined in**

[types/index.ts:1038](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1038)

***

#### RotatePrimaryKeyToSecondaryData

Ƭ **RotatePrimaryKeyToSecondaryData**: `Object`

**Type declaration**

| Name    | Type                                                                                                                                 |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `type`  | [`RotatePrimaryKeyToSecondary`](/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype.md#rotateprimarykeytosecondary) |
| `value` | [`Permissions`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions.md)                                              |

**Defined in**

[types/index.ts:1042](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1042)

***

#### ScopedClaim

Ƭ **ScopedClaim**: [`JurisdictionClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.jurisdictionclaim.md) | [`InvestorUniquenessClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim.md) | [`AccreditedClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.accreditedclaim.md) | [`AffiliateClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.affiliateclaim.md) | [`BuyLockupClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.buylockupclaim.md) | [`SellLockupClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.selllockupclaim.md) | [`KycClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.kycclaim.md) | [`ExemptedClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptedclaim.md) | [`BlockedClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.blockedclaim.md)

**Defined in**

[types/index.ts:294](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L294)

***

#### Signer

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

**Defined in**

[types/index.ts:1148](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1148)

***

#### SubCallback

Ƭ **SubCallback**<`T`>: (`result`: `T`) => `void` | `Promise`<`void`>

**Type parameters**

| Name |
| ---- |
| `T`  |

**Type declaration**

▸ (`result`): `void` | `Promise`<`void`>

**Parameters**

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

**Returns**

`void` | `Promise`<`void`>

**Defined in**

[types/index.ts:651](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L651)

***

#### TransactionArgument

Ƭ **TransactionArgument**: { `_rawType`: `TypeDef` ; `name`: `string` ; `optional`: `boolean` } & [`PlainTransactionArgument`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.plaintransactionargument.md) | [`ArrayTransactionArgument`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.arraytransactionargument.md) | [`SimpleEnumTransactionArgument`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simpleenumtransactionargument.md) | [`ComplexTransactionArgument`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.complextransactionargument.md)

**Defined in**

[types/index.ts:1137](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1137)

***

#### UnscopedClaim

Ƭ **UnscopedClaim**: [`NoDataClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.nodataclaim.md) | [`NoTypeClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.notypeclaim.md) | [`CddClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim.md) | [`InvestorUniquenessV2Claim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessv2claim.md)

**Defined in**

[types/index.ts:305](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L305)

***

#### UnsubCallback

Ƭ **UnsubCallback**: () => `void`

**Type declaration**

▸ (): `void`

**Returns**

`void`

**Defined in**

[types/index.ts:653](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L653)


---

# 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-alpha/modules-1/types.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.