Identity

Represents an Identity in the Polymesh blockchain

Hierarchy

• Entity‹UniqueIdentifiers, string›

  ↳ Identity

  ↳ DefaultTrustedClaimIssuer

Index

Constructors

• constructor

Properties

• authorizations

• context

• did

• portfolios

• tokenPermissions

• uuid

Methods

• areSecondaryKeysFrozen

• createVenue

• freezeSecondaryKeys

• getHeldTokens

• getInstructions

• getPendingDistributions

• getPendingInstructions

• getPrimaryKey

• getScopeId

• getSecondaryKeys

• getTokenBalance

• getTrustingTokens

• getVenues

• hasRole

• hasRoles

• hasValidCdd

• inviteAccount

• isCddProvider

• isEqual

• isGcMember

• modifyPermissions

• removeSecondaryKeys

• revokePermissions

• toJson

• unfreezeSecondaryKeys

• generateUuid

• unserialize

Constructors

constructor

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

Overrides void

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

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

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

identity ID as stored in the blockchain

portfolios

• portfolios: Portfolios

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

tokenPermissions

• tokenPermissions: TokenPermissions

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

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

areSecondaryKeysFrozen

▸ areSecondaryKeysFrozen(): Promise‹boolean›

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

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

Parameters:

Name	Type
callback	SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

createVenue

▸ createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Venue››

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

Create a Venue

note this method is of type ProcedureMethod, which means you can call createVenue.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	CreateVenueParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Venue››

freezeSecondaryKeys

▸ freezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Freeze all the secondary keys in this Identity. This means revoking their permission to perform any operation on the blockchain and freezing their funds until the keys are unfrozen via unfreezeSecondaryKeys

note this method is of type ProcedureMethod, which means you can call freezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

getHeldTokens

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

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

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

getInstructions

▸ getInstructions(): Promise‹GroupedInstructions›

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

Retrieve all Instructions where this Identity is a participant, grouped by status

Returns: Promise‹GroupedInstructions›

getPendingDistributions

▸ getPendingDistributions(): Promise‹DistributionWithDetails[]›

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

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

note uses the middleware

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

Returns: Promise‹DistributionWithDetails[]›

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

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

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

getPrimaryKey

▸ getPrimaryKey(): Promise‹string›

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

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

Parameters:

Name	Type
callback	SubCallback‹string›

Returns: Promise‹UnsubCallback›

getScopeId

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

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

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›

getSecondaryKeys

▸ getSecondaryKeys(): Promise‹SecondaryKey[]›

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

Get the list of secondary keys related to the Identity

note can be subscribed to

Returns: Promise‹SecondaryKey[]›

▸ getSecondaryKeys(callback: SubCallback‹SecondaryKey[]›): Promise‹UnsubCallback›

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

Parameters:

Name	Type
callback	SubCallback‹SecondaryKey[]›

Returns: Promise‹UnsubCallback›

getTokenBalance

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

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

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

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

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

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

Parameters:

Name	Type
callback	SubCallback‹Venue[]›

Returns: Promise‹UnsubCallback›

hasRole

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

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

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

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

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

inviteAccount

▸ inviteAccount(args: InviteAccountParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Send an invitation to an Account to join this Identity

note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note this method is of type ProcedureMethod, which means you can call inviteAccount.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	InviteAccountParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

isCddProvider

▸ isCddProvider(): Promise‹boolean›

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

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

isGcMember

▸ isGcMember(): Promise‹boolean›

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

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

modifyPermissions

▸ modifyPermissions(args: ModifySignerPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Modify all permissions of a list of secondary keys associated with the Identity

note this method is of type ProcedureMethod, which means you can call modifyPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifySignerPermissionsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

removeSecondaryKeys

▸ removeSecondaryKeys(args: RemoveSecondaryKeysParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Remove a list of secondary keys associated with the Identity

note this method is of type ProcedureMethod, which means you can call removeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	RemoveSecondaryKeysParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

revokePermissions

▸ revokePermissions(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Revoke all permissions of a list of secondary keys associated with the Identity

note this method is of type ProcedureMethod, which means you can call revokePermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

▪ args: object

Name	Type
secondaryKeys	Signer[]

▪Optional opts: ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

▸ toJson(): string

Overrides Entity.toJson

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

Return the Identity's DID

Returns: string

unfreezeSecondaryKeys

▸ unfreezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Unfreeze all the secondary keys in this Identity. This will restore their permissions as they were before being frozen

note this method is of type ProcedureMethod, which means you can call unfreezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

Static generateUuid

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

Inherited from Entity.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

Static unserialize

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

Inherited from Entity.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers