Identity

Represents an Identity in the Polymesh blockchain

Hierarchy

• Entity‹UniqueIdentifiers›

  ↳ Identity

  ↳ CurrentIdentity

Index

Constructors

• constructor

Properties

• authorizations

• context

• did

• portfolios

• uuid

Methods

• areSecondaryKeysFrozen
• getHeldTokens
• getPendingInstructions
• getPrimaryKey
• getScopeId
• getTokenBalance
• getTrustingTokens
• getVenues
• hasRole
• hasRoles
• hasValidCdd
• isCddProvider
• isEqual
• isGcMember
• generateUuid
• unserialize

Constructors

constructor

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

Overrides void

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

Create an Identity entity

Parameters:

Name	Type
identifiers	UniqueIdentifiers
context	Context

Returns: Identity

Properties

authorizations

• authorizations: IdentityAuthorizations

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

Protected context

• context: Context

Inherited from CheckpointSchedule.context

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

did

• did: string

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

identity ID as stored in the blockchain

portfolios

• portfolios: Portfolios

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

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

areSecondaryKeysFrozen

▸ areSecondaryKeysFrozen(): Promise‹boolean›

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

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

▸ areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback›

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

Parameters:

Name	Type
callback	SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

getHeldTokens

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

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

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 }

Name	Type
order?	Order
size?	undefined | number
start?	undefined | number

Returns: Promise‹ResultSet‹SecurityToken››

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

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

Retrieve all pending Instructions involving this Identity

Returns: Promise‹Instruction[]›

getPrimaryKey

▸ getPrimaryKey(): Promise‹string›

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

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

Parameters:

Name	Type
callback	SubCallback‹string›

Returns: Promise‹UnsubCallback›

getScopeId

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

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

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

Name	Type
token	SecurityToken | string

Returns: Promise‹string›

getTokenBalance

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

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

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

▪ args: object

Name	Type
ticker	string

Returns: Promise‹BigNumber›

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

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

Parameters:

▪ args: object

Name	Type
ticker	string

▪ callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

getTrustingTokens

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

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

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 }

Name	Type
order	Order

Returns: Promise‹SecurityToken[]›

getVenues

▸ getVenues(): Promise‹Venue[]›

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

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

Parameters:

Name	Type
callback	SubCallback‹Venue[]›

Returns: Promise‹UnsubCallback›

hasRole

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

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

Check whether this Identity possesses the specified Role

Parameters:

Name	Type
role	Role

Returns: Promise‹boolean›

hasRoles

▸ hasRoles(roles: Role[]): Promise‹boolean›

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

Check whether this Identity possesses all specified roles

Parameters:

Name	Type
roles	Role[]

Returns: Promise‹boolean›

hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

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

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

isCddProvider

▸ isCddProvider(): Promise‹boolean›

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

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

isEqual

▸ isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹object›

Returns: boolean

isGcMember

▸ isGcMember(): Promise‹boolean›

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

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers