Identity

Represents an Identity in the Polymesh blockchain

Hierarchy

Entity‹UniqueIdentifiers›
↳ Identity
↳ CurrentIdentity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity

Overrides void

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

Create an Identity entity

Parameters:

Returns: Identity

Properties

authorizations

• authorizations: IdentityAuthorizations

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

`Protected` context

• context: Context

Inherited from Entity.context

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

did

• did: string

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

identity ID as stored in the blockchain

portfolios

• portfolios: Portfolios

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

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

getHeldTokens

▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››

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

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

note uses the middleware

note supports pagination

Parameters:

▪Default value opts: object= { order: Order.Asc }

Returns: Promise‹ResultSet‹SecurityToken››

getPrimaryKey

▸ getPrimaryKey(): Promise‹string›

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

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹string›

▸ getPrimaryKey(callback: SubCallback‹string›): Promise‹UnsubCallback›

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

Parameters:

Returns: Promise‹UnsubCallback›

getScopeId

▸ getScopeId(args: object): Promise‹string›

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

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token

note more on Investor Uniqueness: https://developers.polymesh.live/confidential_identity

Parameters:

▪ args: object

Returns: Promise‹string›

getTokenBalance

▸ getTokenBalance(args: object): Promise‹BigNumber›

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

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

▪ args: object

Returns: Promise‹BigNumber›

▸ getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›

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

Parameters:

▪ args: object

▪ callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

getTrustingTokens

▸ getTrustingTokens(args: object): Promise‹SecurityToken[]›

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

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

note uses the middleware

Parameters:

▪Default value args: object= { order: Order.Asc }

Returns: Promise‹SecurityToken[]›

getVenues

▸ getVenues(): Promise‹Venue[]›

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

Retrieve all Venues created by this Identity

note can be subscribed to

Returns: Promise‹Venue[]›

▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›

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

Parameters:

Returns: Promise‹UnsubCallback›

hasRole

▸ hasRole(role: Role): Promise‹boolean›

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

Check whether this Identity possesses the specified Role

Parameters: