Skip to main content
Version: 21.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:114


authorizations

authorizations: IdentityAuthorizations

Defined in

api/entities/Identity/index.ts:112


did

did: string

Identity ID as stored in the blockchain

Defined in

api/entities/Identity/index.ts:109


portfolios

portfolios: Portfolios

Defined in

api/entities/Identity/index.ts:113


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

Defined in

api/entities/Identity/index.ts:700

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<boolean>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:701


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:433


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:866


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

Defined in

api/entities/Identity/index.ts:183

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

NameType
argsObject
args.tickerstring
callbackSubCallback<BigNumber>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:184


getHeldAssets

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

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

Parameters

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

Returns

Promise<ResultSet <Asset>>

Note

uses the middleware

Note

supports pagination

Defined in

api/entities/Identity/index.ts:337


getHeldAssetsV2

getHeldAssetsV2(opts?): Promise<ResultSet <Asset>>

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 <Asset>>

Note

uses the middlewareV2

Note

supports pagination

Defined in

api/entities/Identity/index.ts:391


getHistoricalInstructions

getHistoricalInstructions(): Promise<HistoricInstruction[]>

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

Returns

Promise<HistoricInstruction[]>

Note

uses the middleware V2

Defined in

api/entities/Identity/index.ts:898


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:555


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:641


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

Defined in

api/entities/Identity/index.ts:284

getPrimaryAccount(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback <PermissionedAccount>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:285


getScopeId

getScopeId(args): Promise<null | string>

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none

Parameters

NameType
argsObject
args.assetstring | Asset

Returns

Promise<null | string>

Note

more on Investor Uniqueness here and here

Defined in

api/entities/Identity/index.ts:533


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

Defined in

api/entities/Identity/index.ts:792

getSecondaryAccounts(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback <PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:796

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Parameters

NameType
paginationOptsPaginationOptions
callbackSubCallback <PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:800


getTrustingAssets

getTrustingAssets(): Promise<Asset[]>

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

Returns

Promise<Asset[]>

Note

uses the middleware

Defined in

api/entities/Identity/index.ts:457


getTrustingAssetsV2

getTrustingAssetsV2(): Promise<Asset[]>

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

Returns

Promise<Asset[]>

Note

uses the middlewareV2

Defined in

api/entities/Identity/index.ts:478


getVenues

getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

Returns

Promise<Venue[]>

Note

can be subscribed to

Defined in

api/entities/Identity/index.ts:497

getVenues(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback <Venue[]>

Returns

Promise<UnsubCallback>

Defined in

api/entities/Identity/index.ts:498


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:135


hasValidCdd

hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:232


isCddProvider

isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

Defined in

api/entities/Identity/index.ts:265


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:248


toHuman

toHuman(): string

Return the Identity's DID

Returns

string

Overrides

Entity.toHuman

Defined in

api/entities/Identity/index.ts:889


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