Class: Identity

Defined in: src/api/entities/Identity/index.ts:108

Represents an Identity in the Polymesh blockchain

Extends

• Entity<UniqueIdentifiers, string>

Extended by

• DefaultTrustedClaimIssuer
• ChildIdentity

Properties

assetPermissions

assetPermissions: AssetPermissions

Defined in: src/api/entities/Identity/index.ts:127

---

authorizations

authorizations: IdentityAuthorizations

Defined in: src/api/entities/Identity/index.ts:125

---

did

did: string

Defined in: src/api/entities/Identity/index.ts:122

Identity ID as stored in the blockchain

---

portfolios

portfolios: Portfolios

Defined in: src/api/entities/Identity/index.ts:126

---

uuid

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from

Entity.uuid

Methods

areSecondaryAccountsFrozen()

Call Signature

areSecondaryAccountsFrozen(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:805

Check whether secondary Accounts are frozen

Returns

Promise<boolean>

Promise that resolves to true if secondary accounts are frozen, false otherwise

Call Signature

areSecondaryAccountsFrozen(callback: SubCallback<boolean>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:816

Check whether secondary Accounts are frozen (with subscription support)

Parameters

Parameter	Type	Description
callback	SubCallback<boolean>	Callback function that receives frozen status updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

---

checkRoles()

checkRoles(roles: Role[]): Promise<CheckRolesResult>

Defined in: src/api/entities/Identity/index.ts:545

Check whether this Identity possesses all specified roles

Parameters

Parameter	Type
roles	Role[]

Returns

Promise<CheckRolesResult>

---

exists()

exists(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:1016

Determine whether this Identity exists on chain

Returns

Promise<boolean>

Note

asset Identities aren't considered to exist for this check

Overrides

Entity.exists

---

getAssetBalance()

Call Signature

getAssetBalance(args: object): Promise<BigNumber>

Defined in: src/api/entities/Identity/index.ts:215

Retrieve the balance of a particular Asset by ticker

Parameters

Parameter	Type	Description
args	{ ticker: string; }	‐
args.ticker	string	Asset ticker

Returns

Promise<BigNumber>

Promise that resolves to the Asset balance

Call Signature

getAssetBalance(args: object): Promise<BigNumber>

Defined in: src/api/entities/Identity/index.ts:224

Retrieve the balance of a particular Asset by Asset ID

Parameters

Parameter	Type	Description
args	{ assetId: string; }	‐
args.assetId	string	Asset identifier

Returns

Promise<BigNumber>

Promise that resolves to the Asset balance

Call Signature

getAssetBalance(args: object, callback: SubCallback<BigNumber>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:236

Retrieve the balance of a particular Asset by ticker (with subscription support)

Parameters

Parameter	Type	Description
args	{ ticker: string; }	‐
args.ticker	string	Asset ticker
callback	SubCallback<BigNumber>	Callback function that receives balance updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

Call Signature

getAssetBalance(args: object, callback: SubCallback<BigNumber>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:251

Retrieve the balance of a particular Asset by Asset ID (with subscription support)

Parameters

Parameter	Type	Description
args	{ assetId: string; }	‐
args.assetId	string	Asset identifier
callback	SubCallback<BigNumber>	Callback function that receives balance updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

---

getChildIdentities()

getChildIdentities(): Promise<ChildIdentity[]>

Defined in: src/api/entities/Identity/index.ts:1082

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

Deprecated

Child identites are no longer supported in chain v8

---

getHeldAssets()

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

Defined in: src/api/entities/Identity/index.ts:440

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

Parameters

Parameter	Type
opts	{ order?: AssetHoldersOrderBy; size?: BigNumber; start?: BigNumber; }
opts.order?	AssetHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Returns

Promise<ResultSet<FungibleAsset>>

Note

uses the middlewareV2

Note

supports pagination

---

getHeldNfts()

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

Defined in: src/api/entities/Identity/index.ts:487

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

Parameters

Parameter	Type
opts	{ order?: NftHoldersOrderBy; size?: BigNumber; start?: BigNumber; }
opts.order?	NftHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Returns

Promise<ResultSet<HeldNfts>>

Note

uses the middlewareV2

Note

supports pagination

---

getHistoricalInstructions()

getHistoricalInstructions(filter?: Omit<HistoricalInstructionFilters, "identity">): Promise<ResultSet<HistoricInstruction>>

Defined in: src/api/entities/Identity/index.ts:1050

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

Parameters

Parameter	Type
filter?	Omit<HistoricalInstructionFilters, "identity">

Returns

Promise<ResultSet<HistoricInstruction>>

Note

uses the middleware V2

Note

supports pagination

---

getInstructions()

getInstructions(): Promise<GroupedInstructions>

Defined in: src/api/entities/Identity/index.ts:618

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

Returns

Promise<GroupedInstructions>

---

getInvolvedInstructions()

getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

Defined in: src/api/entities/Identity/index.ts:731

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

Returns

Promise<GroupedInvolvedInstructions>

---

getMultiSigSigners()

getMultiSigSigners(): Promise<MultiSigSigners[]>

Defined in: src/api/entities/Identity/index.ts:1232

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

---

getOffChainAuthorizationNonce()

getOffChainAuthorizationNonce(): Promise<BigNumber>

Defined in: src/api/entities/Identity/index.ts:1310

Returns the off chain authorization nonce for this Identity

Returns

Promise<BigNumber>

---

getPendingDistributions()

getPendingDistributions(): Promise<DistributionWithDetails[]>

Defined in: src/api/entities/Identity/index.ts:854

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

---

getPrimaryAccount()

Call Signature

getPrimaryAccount(): Promise<PermissionedAccount>

Defined in: src/api/entities/Identity/index.ts:366

Retrieve the primary Account associated with the Identity

Returns

Promise<PermissionedAccount>

Promise that resolves to the primary Account information

Call Signature

getPrimaryAccount(callback: SubCallback<PermissionedAccount>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:377

Retrieve the primary Account associated with the Identity (with subscription support)

Parameters

Parameter	Type	Description
callback	SubCallback<PermissionedAccount>	Callback function that receives primary Account updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

---

getSecondaryAccounts()

Call Signature

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

Defined in: src/api/entities/Identity/index.ts:913

Get the list of secondary Accounts related to the Identity

Parameters

Parameter	Type	Description
paginationOpts?	PaginationOptions	Options for pagination

Returns

Promise<ResultSet<PermissionedAccount>>

Promise that resolves to a paginated result of secondary accounts

Note

supports pagination

Call Signature

getSecondaryAccounts(callback: SubCallback<PermissionedAccount[]>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:926

Get the list of secondary Accounts related to the Identity (with subscription support)

Parameters

Parameter	Type	Description
callback	SubCallback<PermissionedAccount[]>	Callback function that receives secondary account updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

Call Signature

getSecondaryAccounts(paginationOpts: PaginationOptions, callback: SubCallback<PermissionedAccount[]>): Promise<UnsubCallback>

Defined in: src/api/entities/Identity/index.ts:941

Get the list of secondary Accounts related to the Identity (with pagination and subscription support)

Parameters

Parameter	Type	Description
paginationOpts	PaginationOptions	Options for pagination
callback	SubCallback<PermissionedAccount[]>	Callback function that receives secondary account updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

supports pagination

Note

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

---

getTrustingAssets()

getTrustingAssets(): Promise<FungibleAsset[]>

Defined in: src/api/entities/Identity/index.ts:571

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

Returns

Promise<FungibleAsset[]>

Note

uses the middlewareV2

---

getVenues()

getVenues(): Promise<Venue[]>

Defined in: src/api/entities/Identity/index.ts:590

Retrieve all Venues created by this Identity

Returns

Promise<Venue[]>

---

hasRole()

hasRole(role: Role): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:162

Check whether this Identity possesses the specified Role

Parameters

Parameter	Type
role	Role

Returns

Promise<boolean>

---

hasValidCdd()

hasValidCdd(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:304

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Deprecated

CDD claims are discontinued from chain v8. If invoked with a v8 chain, this returns true if DID exists

---

isAssetPreApproved()

isAssetPreApproved(asset: string | BaseAsset): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:1171

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

Parameters

Parameter	Type
asset	string | BaseAsset

Returns

Promise<boolean>

---

isCddProvider()

isCddProvider(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:343

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

---

isChild()

isChild(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:1126

Check whether this Identity is a child Identity

Returns

Promise<boolean>

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

isGcMember()

isGcMember(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:326

Check whether this Identity is Governance Committee member

Returns

Promise<boolean>

---

isMandatoryReceiverAffirmationEnabled()

isMandatoryReceiverAffirmationEnabled(): Promise<boolean>

Defined in: src/api/entities/Identity/index.ts:1196

Returns whether or not this Identity has opted in to mandatory receiver affirmation. When true, the identity must explicitly affirm incoming asset transfer in settlements unless an asset level or portfolio level exemption applies.

Returns

Promise<boolean>

---

preApprovedAssets()

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

Defined in: src/api/entities/Identity/index.ts:1137

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

Parameters

Parameter	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<Asset>>

---

setMandatoryReceiverAffirmation()

setMandatoryReceiverAffirmation(args: object, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Identity/index.ts:1219

Enable or disable mandatory receiver affirmation for incoming settlement transfers. When enabled (ReceiverAffirmationRequirement.Required), the signing identity must explicitly affirm any incoming asset transfer unless an asset level or portfolio level exemption applies. When disabled (ReceiverAffirmationRequirement.Automatic), all incoming transfers are auto-affirmed.

Parameters

Parameter	Type
args	{ requirement: ReceiverAffirmationRequirement; }
args.requirement	ReceiverAffirmationRequirement
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

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

---

toHuman()

toHuman(): string

Defined in: src/api/entities/Identity/index.ts:1039

Return the Identity's DID

Returns

string

Overrides

Entity.toHuman

---

unlinkChild()

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

Defined in: src/api/entities/Identity/index.ts:1121

Unlinks a child identity

Parameters

Parameter	Type
args	UnlinkChildParams
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

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers	‐

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize