Skip to main content
Version: 25.1.x

Module: Entities Types

Enumerations​

Interfaces​

References​

AccountBalance​

Re-exports AccountBalance

AccountIdentityRelation​

Re-exports AccountIdentityRelation

AccountKeyType​

Re-exports AccountKeyType

AccountTypeInfo​

Re-exports AccountTypeInfo

AffirmationStatus​

Re-exports AffirmationStatus

AgentWithGroup​

Re-exports AgentWithGroup

AnyJson​

Re-exports AnyJson

Asset​

Re-exports Asset

AssetDetails​

Re-exports AssetDetails

AssetDocument​

Re-exports AssetDocument

AssetWithGroup​

Re-exports AssetWithGroup

Balance​

Re-exports Balance

BaseHistoricAssetTransaction​

Re-exports BaseHistoricAssetTransaction

CaCheckpointType​

Re-exports CaCheckpointType

CheckpointScheduleParams​

Re-exports CheckpointScheduleParams

CollectionKey​

Re-exports CollectionKey

CorporateActionDefaultConfig​

Re-exports CorporateActionDefaultConfig

CorporateActionKind​

Re-exports CorporateActionKind

CorporateActionParams​

Renames and re-exports Params

CorporateActionTargets​

Re-exports CorporateActionTargets

DistributionParticipant​

Re-exports DistributionParticipant

DividendDistributionDetails​

Re-exports DividendDistributionDetails

DividendDistributionParams​

Re-exports DividendDistributionParams

FungibleLeg​

Re-exports FungibleLeg

GlobalMetadataKey​

Re-exports GlobalMetadataKey

GroupedInstructions​

Re-exports GroupedInstructions

GroupedInvolvedInstructions​

Re-exports GroupedInvolvedInstructions

HeldNfts​

Re-exports HeldNfts

HistoricAgentOperation​

Re-exports HistoricAgentOperation

HistoricAssetTransaction​

Re-exports HistoricAssetTransaction

HistoricInstruction​

Re-exports HistoricInstruction

HistoricNftTransaction​

Re-exports HistoricNftTransaction

HistoricPolyxTransaction​

Re-exports HistoricPolyxTransaction

HistoricSettlement​

Re-exports HistoricSettlement

IdentityBalance​

Re-exports IdentityBalance

IdentityHeldNfts​

Re-exports IdentityHeldNfts

InputCaCheckpoint​

Re-exports InputCaCheckpoint

InputTargets​

Re-exports InputTargets

InputTaxWithholding​

Re-exports InputTaxWithholding

InstructionAffirmation​

Re-exports InstructionAffirmation

InstructionDetails​

Re-exports InstructionDetails

InstructionEndCondition​

Re-exports InstructionEndCondition

InstructionStatus​

Re-exports InstructionStatus

InstructionStatusResult​

Re-exports InstructionStatusResult

InstructionType​

Re-exports InstructionType

InstructionsByStatus​

Re-exports InstructionsByStatus

Investment​

Re-exports Investment

KnownAssetType​

Re-exports KnownAssetType

KnownNftType​

Re-exports KnownNftType

Leg​

Re-exports Leg

MediatorAffirmation​

Re-exports MediatorAffirmation

MetadataDetails​

Re-exports MetadataDetails

MetadataKeyId​

Re-exports MetadataKeyId

MetadataLockStatus​

Re-exports MetadataLockStatus

MetadataSpec​

Re-exports MetadataSpec

MetadataType​

Re-exports MetadataType

MetadataValue​

Re-exports MetadataValue

MetadataValueDetails​

Re-exports MetadataValueDetails

MetadataWithValue​

Re-exports MetadataWithValue

MultiSigDetails​

Re-exports MultiSigDetails

MultiSigProposalAction​

Re-exports MultiSigProposalAction

MultiSigProposalDetails​

Re-exports MultiSigProposalDetails

MultiSigProposalVote​

Re-exports MultiSigProposalVote

MultiSigSigners​

Re-exports MultiSigSigners

NftLeg​

Re-exports NftLeg

NftMetadata​

Re-exports NftMetadata

OffChainAffirmation​

Re-exports OffChainAffirmation

OffChainLeg​

Re-exports OffChainLeg

OfferingBalanceStatus​

Re-exports OfferingBalanceStatus

OfferingDetails​

Re-exports OfferingDetails

OfferingSaleStatus​

Re-exports OfferingSaleStatus

OfferingStatus​

Re-exports OfferingStatus

OfferingTier​

Re-exports OfferingTier

OfferingTimingStatus​

Re-exports OfferingTimingStatus

PortfolioBalance​

Re-exports PortfolioBalance

PortfolioCollection​

Re-exports PortfolioCollection

ProposalStatus​

Re-exports ProposalStatus

ScheduleDetails​

Re-exports ScheduleDetails

SecurityIdentifier​

Re-exports SecurityIdentifier

SecurityIdentifierType​

Re-exports SecurityIdentifierType

SettlementLeg​

Re-exports SettlementLeg

SubsidyData​

Re-exports SubsidyData

SubsidyWithAllowance​

Re-exports SubsidyWithAllowance

TargetTreatment​

Re-exports TargetTreatment

TaxWithholding​

Re-exports TaxWithholding

TickerReservationDetails​

Re-exports TickerReservationDetails

TickerReservationStatus​

Re-exports TickerReservationStatus

Tier​

Re-exports Tier

TransferBreakdown​

Re-exports TransferBreakdown

TransferError​

Re-exports TransferError

TransferRestrictionResult​

Re-exports TransferRestrictionResult

TransferStatus​

Re-exports TransferStatus

UniqueIdentifiers​

Re-exports UniqueIdentifiers

VenueDetails​

Re-exports VenueDetails

VenueFilteringDetails​

Re-exports VenueFilteringDetails

VenueType​

Re-exports VenueType

Type Aliases​

Account​

Ƭ Account: Account

Defined in​

api/entities/types.ts:43

ActiveStats​

Ƭ ActiveStats: Object

Type declaration​

NameType
claims?{ claimType: ClaimType ; issuer: Identity }[]
isSetboolean

Defined in​

api/entities/types.ts:826

AddRelayerPayingKeyAuthorizationData​

Ƭ AddRelayerPayingKeyAuthorizationData: Object

Type declaration​

NameType
typeAddRelayerPayingKey
valueSubsidyData

Defined in​

api/entities/types.ts:454

AttestPrimaryKeyRotationAuthorizationData​

Ƭ AttestPrimaryKeyRotationAuthorizationData: Object

Type declaration​

NameType
typeAttestPrimaryKeyRotation
valueIdentity

Defined in​

api/entities/types.ts:425

Authorization​

Ƭ Authorization: AttestPrimaryKeyRotationAuthorizationData | RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData

Authorization request data corresponding to type

Defined in​

api/entities/types.ts:475

AuthorizationRequest​

Ƭ AuthorizationRequest: AuthorizationRequest

Defined in​

api/entities/types.ts:46

BecomeAgentAuthorizationData​

Ƭ BecomeAgentAuthorizationData: Object

Type declaration​

NameType
typeBecomeAgent
valueKnownPermissionGroup | CustomPermissionGroup

Defined in​

api/entities/types.ts:449

Checkpoint​

Ƭ Checkpoint: Checkpoint

Defined in​

api/entities/types.ts:47

CheckpointSchedule​

Ƭ CheckpointSchedule: CheckpointSchedule

Defined in​

api/entities/types.ts:48

ChildIdentity​

Ƭ ChildIdentity: ChildIdentity

Defined in​

api/entities/types.ts:55

Claim​

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in​

api/entities/types.ts:233

ClaimCountStatInput​

Ƭ ClaimCountStatInput: { claimType: Accredited ; issuer: Identity ; value: { accredited: BigNumber ; nonAccredited: BigNumber } } | { claimType: Affiliate ; issuer: Identity ; value: { affiliate: BigNumber ; nonAffiliate: BigNumber } } | { claimType: Jurisdiction ; issuer: Identity ; value: { count: BigNumber ; countryCode: CountryCode }[] }

Defined in​

api/entities/types.ts:558

Condition​

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase

Defined in​

api/entities/types.ts:367

CorporateAction​

Ƭ CorporateAction: CorporateAction

Defined in​

api/entities/types.ts:49

CustomPermissionGroup​

Ƭ CustomPermissionGroup: CustomPermissionGroup

Defined in​

api/entities/types.ts:50

DefaultPortfolio​

Ƭ DefaultPortfolio: DefaultPortfolio

Defined in​

api/entities/types.ts:51

DefaultTrustedClaimIssuer​

Ƭ DefaultTrustedClaimIssuer: DefaultTrustedClaimIssuer

Defined in​

api/entities/types.ts:52

DividendDistribution​

Ƭ DividendDistribution: DividendDistribution

Defined in​

api/entities/types.ts:53

FungibleAsset​

Ƭ FungibleAsset: FungibleAsset

Defined in​

api/entities/types.ts:59

GenericAuthorizationData​

Ƭ GenericAuthorizationData: Object

Type declaration​

NameType
typeExclude<AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary | AttestPrimaryKeyRotation>
valuestring

Defined in​

api/entities/types.ts:459

GroupPermissions​

Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">

Asset permissions shared by agents in a group

Defined in​

api/entities/types.ts:660

Identity​

Ƭ Identity: Identity

Defined in​

api/entities/types.ts:54

InputCondition​

Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify<IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase

Defined in​

api/entities/types.ts:375

InputConditionBase​

Ƭ InputConditionBase: Modify<ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>

Defined in​

api/entities/types.ts:338

InputRequirement​

Ƭ InputRequirement: Modify<Requirement, { conditions: InputCondition[] }>

Defined in​

api/entities/types.ts:401

InputStatClaim​

Ƭ InputStatClaim: StatJurisdictionClaimInput | StatAccreditedClaimInput | StatAffiliateClaimInput

Defined in​

api/entities/types.ts:261

InputStatType​

Ƭ InputStatType: { type: Count | Balance } | { claimIssuer: StatClaimIssuer ; type: ScopedCount | ScopedBalance }

Defined in​

api/entities/types.ts:266

InputTrustedClaimIssuer​

Ƭ InputTrustedClaimIssuer: Modify<TrustedClaimIssuer, { identity: string | Identity }>

Defined in​

api/entities/types.ts:314

Instruction​

Ƭ Instruction: Instruction

Defined in​

api/entities/types.ts:56

JoinIdentityAuthorizationData​

Ƭ JoinIdentityAuthorizationData: Object

Type declaration​

NameType
typeJoinIdentity
valuePermissions

Defined in​

api/entities/types.ts:439

KnownPermissionGroup​

Ƭ KnownPermissionGroup: KnownPermissionGroup

Defined in​

api/entities/types.ts:57

MetadataEntry​

Ƭ MetadataEntry: MetadataEntry

Defined in​

api/entities/types.ts:62

MultiSig​

Ƭ MultiSig: MultiSig

Defined in​

api/entities/types.ts:44

MultiSigProposal​

Ƭ MultiSigProposal: MultiSigProposal

Defined in​

api/entities/types.ts:45

NextKey​

Ƭ NextKey: string | BigNumber | null

Defined in​

api/entities/types.ts:92

Nft​

Ƭ Nft: Nft

Defined in​

api/entities/types.ts:60

NftCollection​

Ƭ NftCollection: NftCollection

Defined in​

api/entities/types.ts:61

NonFungiblePortfolioMovement​

Ƭ NonFungiblePortfolioMovement: Object

Type declaration​

NameTypeDescription
assetNftCollection | string-
memo?stringidentifier string to help differentiate transfers
nfts(Nft | BigNumber)[]-

Defined in​

api/entities/types.ts:815

NumberedPortfolio​

Ƭ NumberedPortfolio: NumberedPortfolio

Defined in​

api/entities/types.ts:58

Offering​

Ƭ Offering: Offering

Defined in​

api/entities/types.ts:63

PermissionsLike​

Ƭ PermissionsLike: { assets?: SectionPermissions<string | FungibleAsset> | null ; portfolios?: SectionPermissions<PortfolioLike> | null } & { transactions?: TransactionPermissions | null } | { transactionGroups?: TxGroup[] }

Permissions to grant to a Signer over an Identity

Permissions

Note

TxGroups in the transactionGroups array will be transformed into their corresponding TxTags

Defined in​

api/entities/types.ts:785

PortfolioCustodyAuthorizationData​

Ƭ PortfolioCustodyAuthorizationData: Object

Type declaration​

NameType
typePortfolioCustody
valueNumberedPortfolio | DefaultPortfolio

Defined in​

api/entities/types.ts:444

PortfolioLike​

Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }

Defined in​

api/entities/types.ts:771

PortfolioMovement​

Ƭ PortfolioMovement: FungiblePortfolioMovement | NonFungiblePortfolioMovement

Defined in​

api/entities/types.ts:824

RotatePrimaryKeyAuthorizationData​

Ƭ RotatePrimaryKeyAuthorizationData: Object

Type declaration​

NameType
typeRotatePrimaryKey

Defined in​

api/entities/types.ts:430

RotatePrimaryKeyToSecondaryData​

Ƭ RotatePrimaryKeyToSecondaryData: Object

Type declaration​

NameType
typeRotatePrimaryKeyToSecondary
valuePermissions

Defined in​

api/entities/types.ts:434

ScopedClaim​

Ƭ ScopedClaim: JurisdictionClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim | CustomClaim

Defined in​

api/entities/types.ts:220

Signer​

Ƭ Signer: Identity | Account

Defined in​

api/entities/types.ts:753

StatClaimType​

Ƭ StatClaimType: Accredited | Affiliate | Jurisdiction

Defined in​

api/entities/types.ts:244

SubCallback​

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

Type parameters​

Name
T

Type declaration​

▸ (result): void | Promise<void>

Parameters​
NameType
resultT
Returns​

void | Promise<void>

Defined in​

api/entities/types.ts:83

Subsidy​

Ƭ Subsidy: Subsidy

Defined in​

api/entities/types.ts:66

TickerReservation​

Ƭ TickerReservation: TickerReservation

Defined in​

api/entities/types.ts:64

UnscopedClaim​

Ƭ UnscopedClaim: CddClaim

Defined in​

api/entities/types.ts:231

UnsubCallback​

Ƭ UnsubCallback: () => void

Type declaration​

▸ (): void

Returns​

void

Defined in​

api/entities/types.ts:85

Venue​

Ƭ Venue: Venue

Defined in​

api/entities/types.ts:65