Skip to main content
Version: 27.0.x

Class: Identity

api/entities/Identity.Identity

Represents an Identity in the Polymesh blockchain

Hierarchy

Properties

assetPermissions

assetPermissions: AssetPermissions

Defined in

api/entities/Identity/index.ts:128


authorizations

authorizations: IdentityAuthorizations

Defined in

api/entities/Identity/index.ts:126


did

did: string

Identity ID as stored in the blockchain

Defined in

api/entities/Identity/index.ts:123


portfolios

portfolios: Portfolios

Defined in

api/entities/Identity/index.ts:127


uuid

uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(): Promise<boolean>

Check whether secondary Accounts are frozen

Returns

Promise<boolean>

Note

can be subscribed to, if connected to node using a web socket

Defined in

api/entities/Identity/index.ts:698

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<boolean>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:699


checkRoles

checkRoles(roles): Promise<CheckRolesResult>

Check whether this Identity possesses all specified roles

Parameters

NameType
rolesRole[]

Returns

Promise<CheckRolesResult>

Defined in

api/entities/Identity/index.ts:481


exists

exists(): Promise<boolean>

Determine whether this Identity exists on chain

Returns

Promise<boolean>

Note

asset Identities aren't considered to exist for this check

Overrides

Entity.exists

Defined in

api/entities/Identity/index.ts:870


getAssetBalance

getAssetBalance(args): Promise<BigNumber>

Retrieve the balance of a particular Asset

Parameters

NameType
argsObject
args.tickerstring

Returns

Promise<BigNumber>

Note

can be subscribed to, if connected to node using a web socket

Defined in

api/entities/Identity/index.ts:204

getAssetBalance(args): Promise<BigNumber>

Parameters

NameType
argsObject
args.assetIdstring

Returns

Promise<BigNumber>

Defined in

api/entities/Identity/index.ts:205

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

NameType
argsObject
args.tickerstring
callbackSubCallback<BigNumber>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:206

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

NameType
argsObject
args.assetIdstring
callbackSubCallback<BigNumber>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:211


getChildIdentities

getChildIdentities(): Promise<ChildIdentity[]>

Returns the list of all child identities

Returns

Promise<ChildIdentity[]>

Note

this query can be potentially SLOW depending on the number of parent Identities present on the chain

Defined in

api/entities/Identity/index.ts:928


getHeldAssets

getHeldAssets(opts?): Promise<ResultSet<FungibleAsset>>

Retrieve a list of all Assets which were held at one point by this Identity

Parameters

NameType
optsObject
opts.order?AssetHoldersOrderBy
opts.size?BigNumber
opts.start?BigNumber

Returns

Promise<ResultSet<FungibleAsset>>

Note

uses the middlewareV2

Note

supports pagination

Defined in

api/entities/Identity/index.ts:378


getHeldNfts

getHeldNfts(opts?): Promise<ResultSet<HeldNfts>>

Retrieve a list of all NftCollections which were held at one point by this Identity

Parameters

NameType
optsObject
opts.order?NftHoldersOrderBy
opts.size?BigNumber
opts.start?BigNumber

Returns

Promise<ResultSet<HeldNfts>>

Note

uses the middlewareV2

Note

supports pagination

Defined in

api/entities/Identity/index.ts:424


getHistoricalInstructions

getHistoricalInstructions(filter?): Promise<HistoricInstruction[]>

Retrieve all Instructions that have been associated with this Identity's DID

Parameters

NameType
filter?Omit<InstructionPartiesFilters, "identity">

Returns

Promise<HistoricInstruction[]>

Note

uses the middleware V2

Note

supports pagination

Defined in

api/entities/Identity/index.ts:904


getInstructions

getInstructions(): Promise<GroupedInstructions>

Retrieve all Instructions where this Identity is a custodian of one or more portfolios in the legs, grouped by status

Returns

Promise<GroupedInstructions>

Defined in

api/entities/Identity/index.ts:552


getInvolvedInstructions

getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status

Returns

Promise<GroupedInvolvedInstructions>

Defined in

api/entities/Identity/index.ts:639


getMultiSigSigners

getMultiSigSigners(): Promise<MultiSigSigners[]>

Returns the list of MultiSig accounts along with their signatories this identity has responsibility for. The roles possible are:

  • Admin: The identity is able to unilaterally modify the MultiSig properties, such as the signers and signatures required for a proposal
  • Payer: The identity's primary key will be deducted any POLYX fees the MultiSig may incur

Returns

Promise<MultiSigSigners[]>

Note

this query can be potentially SLOW depending on the number of MultiSigs present on the chain

Defined in

api/entities/Identity/index.ts:1042


getOffChainAuthorizationNonce

getOffChainAuthorizationNonce(): Promise<BigNumber>

Returns the off chain authorization nonce for this Identity

Returns

Promise<BigNumber>

Defined in

api/entities/Identity/index.ts:1120


getPendingDistributions

getPendingDistributions(): Promise<DistributionWithDetails[]>

Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid

Returns

Promise<DistributionWithDetails[]>

Note

uses the middleware

Note

this query can be potentially SLOW depending on which Assets this Identity has held

Defined in

api/entities/Identity/index.ts:737


getPrimaryAccount

getPrimaryAccount(): Promise<PermissionedAccount>

Retrieve the primary Account associated with the Identity

Returns

Promise<PermissionedAccount>

Note

can be subscribed to, if connected to node using a web socket

Defined in

api/entities/Identity/index.ts:314

getPrimaryAccount(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<PermissionedAccount>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:315


getSecondaryAccounts

getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>

Get the list of secondary Accounts related to the Identity

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet<PermissionedAccount>>

Note

supports pagination

Note

can be subscribed to, if connected to node using a web socket

Defined in

api/entities/Identity/index.ts:787

getSecondaryAccounts(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:791

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Parameters

NameType
paginationOptsPaginationOptions
callbackSubCallback<PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:795


getTrustingAssets

getTrustingAssets(): Promise<FungibleAsset[]>

Get the list of Assets for which this Identity is a trusted claim issuer

Returns

Promise<FungibleAsset[]>

Note

uses the middlewareV2

Defined in

api/entities/Identity/index.ts:505


getVenues

getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

Returns

Promise<Venue[]>

Defined in

api/entities/Identity/index.ts:524


hasRole

hasRole(role): Promise<boolean>

Check whether this Identity possesses the specified Role

Parameters

NameType
roleRole

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:156


hasValidCdd

hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:262


isAssetPreApproved

isAssetPreApproved(asset): Promise<boolean>

Returns whether or not this Identity has pre-approved a particular asset

Parameters

NameType
assetstring | BaseAsset

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:1014


isCddProvider

isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:295


isChild

isChild(): Promise<boolean>

Check whether this Identity is a child Identity

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:969


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61


isGcMember

isGcMember(): Promise<boolean>

Check whether this Identity is Governance Committee member

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:278


preApprovedAssets

preApprovedAssets(paginationOpts?): Promise<ResultSet<Asset>>

Returns a list of all assets this Identity has pre-approved. These assets will not require affirmation when being received in settlements

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet<Asset>>

Defined in

api/entities/Identity/index.ts:980


toHuman

toHuman(): string

Return the Identity's DID

Returns

string

Overrides

Entity.toHuman

Defined in

api/entities/Identity/index.ts:893


unlinkChild

unlinkChild(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Unlinks a child identity

Parameters

NameType
argsUnlinkChildParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Throws

if

  • the child is not a child of this identity
  • the transaction signer is not the primary key of the parent identity

Note

this method is of type ProcedureMethod, which means you can call unlinkChild.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Identity/index.ts:962


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23