api/entities/Identity.Identity

Represents an Identity in the Polymesh blockchain

• Entity<UniqueIdentifiers, string>

  ↳ Identity

  ↳↳ DefaultTrustedClaimIssuer

  ↳↳ ChildIdentity

• assetPermissions
• authorizations
• did
• portfolios
• uuid

• areSecondaryAccountsFrozen
• checkRoles
• exists
• getAssetBalance
• getChildIdentities
• getHeldAssets
• getHeldNfts
• getHistoricalInstructions
• getInstructions
• getInvolvedInstructions
• getMultiSigSigners
• getPendingDistributions
• getPrimaryAccount
• getSecondaryAccounts
• getTrustingAssets
• getVenues
• hasRole
• hasValidCdd
• isAssetPreApproved
• isCddProvider
• isChild
• isEqual
• isGcMember
• preApprovedAssets
• toHuman
• unlinkChild
• generateUuid
• unserialize

• assetPermissions: AssetPermissions

api/entities/Identity/index.ts:131

---

• authorizations: IdentityAuthorizations

api/entities/Identity/index.ts:129

---

• did: string

Identity ID as stored in the blockchain

api/entities/Identity/index.ts:126

---

• portfolios: Portfolios

api/entities/Identity/index.ts:130

---

• uuid: string

Entity.uuid

api/entities/Entity.ts:46

▸ areSecondaryAccountsFrozen(): Promise<boolean>

Check whether secondary Accounts are frozen

Promise<boolean>

Note

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

api/entities/Identity/index.ts:681

▸ areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Name	Type
callback	SubCallback<boolean>

Promise<UnsubCallback>

api/entities/Identity/index.ts:682

---

▸ checkRoles(roles): Promise<CheckRolesResult>

Check whether this Identity possesses all specified roles

Name	Type
roles	Role[]

Promise<CheckRolesResult>

api/entities/Identity/index.ts:466

---

▸ exists(): Promise<boolean>

Determine whether this Identity exists on chain

Promise<boolean>

Note

asset Identities aren't considered to exist for this check

Entity.exists

api/entities/Identity/index.ts:858

---

▸ getAssetBalance(args): Promise<BigNumber>

Retrieve the balance of a particular Asset

Name	Type
args	Object
args.ticker	string

Promise<BigNumber>

Note

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

api/entities/Identity/index.ts:207

▸ getAssetBalance(args, callback): Promise<UnsubCallback>

Name	Type
args	Object
args.ticker	string
callback	SubCallback<BigNumber>

Promise<UnsubCallback>

api/entities/Identity/index.ts:208

---

▸ getChildIdentities(): Promise<ChildIdentity[]>

Returns the list of all child identities

Promise<ChildIdentity[]>

Note

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

api/entities/Identity/index.ts:910

---

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

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

Name	Type
opts	Object
opts.order?	AssetHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Promise<ResultSet<FungibleAsset>>

Note

uses the middlewareV2

Note

supports pagination

api/entities/Identity/index.ts:374

---

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

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

Name	Type
opts	Object
opts.order?	NftHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Promise<ResultSet<HeldNfts>>

Note

uses the middlewareV2

Note

supports pagination

api/entities/Identity/index.ts:419

---

▸ getHistoricalInstructions(): Promise<HistoricInstruction[]>

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

Promise<HistoricInstruction[]>

Note

uses the middleware V2

api/entities/Identity/index.ts:890

---

▸ getInstructions(): Promise<GroupedInstructions>

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

Promise<GroupedInstructions>

api/entities/Identity/index.ts:535

---

▸ getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

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

Promise<GroupedInvolvedInstructions>

api/entities/Identity/index.ts:622

---

▸ getMultiSigSigners(): Promise<MultiSigSigners[]>

Returns the list of MultiSig accounts linked with this Identity along with the signatories

Promise<MultiSigSigners[]>

Note

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

api/entities/Identity/index.ts:1025

---

▸ getPendingDistributions(): Promise<DistributionWithDetails[]>

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

Promise<DistributionWithDetails[]>

Note

uses the middleware

Note

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

api/entities/Identity/index.ts:720

---

▸ getPrimaryAccount(): Promise<PermissionedAccount>

Retrieve the primary Account associated with the Identity

Promise<PermissionedAccount>

Note

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

api/entities/Identity/index.ts:310

▸ getPrimaryAccount(callback): Promise<UnsubCallback>

Name	Type
callback	SubCallback<PermissionedAccount>

Promise<UnsubCallback>

api/entities/Identity/index.ts:311

---

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

Get the list of secondary Accounts related to the Identity

Name	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<PermissionedAccount>>

Note

supports pagination

Note

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

api/entities/Identity/index.ts:775

▸ getSecondaryAccounts(callback): Promise<UnsubCallback>

Name	Type
callback	SubCallback<PermissionedAccount[]>

Promise<UnsubCallback>

api/entities/Identity/index.ts:779

▸ getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Name	Type
paginationOpts	PaginationOptions
callback	SubCallback<PermissionedAccount[]>

Promise<UnsubCallback>

api/entities/Identity/index.ts:783

---

▸ getTrustingAssets(): Promise<FungibleAsset[]>

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

Promise<FungibleAsset[]>

Note

uses the middlewareV2

api/entities/Identity/index.ts:490

---

▸ getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

Promise<Venue[]>

api/entities/Identity/index.ts:507

---

▸ hasRole(role): Promise<boolean>

Check whether this Identity possesses the specified Role

Name	Type
role	Role

Promise<boolean>

api/entities/Identity/index.ts:159

---

▸ hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Promise<boolean>

api/entities/Identity/index.ts:258

---

▸ isAssetPreApproved(asset): Promise<boolean>

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

Name	Type
asset	string | BaseAsset

Promise<boolean>

api/entities/Identity/index.ts:998

---

▸ isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Promise<boolean>

api/entities/Identity/index.ts:291

---

▸ isChild(): Promise<boolean>

Check whether this Identity is a child Identity

Promise<boolean>

api/entities/Identity/index.ts:951

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

api/entities/Entity.ts:61

---

▸ isGcMember(): Promise<boolean>

Check whether this Identity is Governance Committee member

Promise<boolean>

api/entities/Identity/index.ts:274

---

▸ 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

Name	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<Asset>>

api/entities/Identity/index.ts:962

---

▸ toHuman(): string

Return the Identity's DID

string

Entity.toHuman

api/entities/Identity/index.ts:881

---

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

Unlinks a child identity

Name	Type
args	UnlinkChildParams
opts?	ProcedureOpts

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

api/entities/Identity/index.ts:944

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Entity.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

api/entities/Entity.ts:23