Polymesh SDK API Reference
v11.0.2
v11.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Constructors
  • Properties
  • Methods
  • Constructors
  • constructor
  • Properties
  • authorizations
  • Protected context
  • did
  • portfolios
  • tokenPermissions
  • uuid
  • Methods
  • areSecondaryKeysFrozen
  • createVenue
  • exists
  • freezeSecondaryKeys
  • getHeldTokens
  • getInstructions
  • getPendingDistributions
  • getPendingInstructions
  • getPrimaryKey
  • getScopeId
  • getSecondaryKeys
  • getTokenBalance
  • getTrustingTokens
  • getVenues
  • hasRole
  • hasRoles
  • hasValidCdd
  • inviteAccount
  • isCddProvider
  • isEqual
  • isGcMember
  • modifyPermissions
  • removeSecondaryKeys
  • revokePermissions
  • toJson
  • unfreezeSecondaryKeys
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Identity

PreviousEntityNextIdentityAuthorizations

Last updated 3 years ago

Was this helpful?

Represents an Identity in the Polymesh blockchain

Hierarchy

  • ‹, string›

    ↳ Identity

    ↳

Index

Constructors

Properties

Methods

Constructors

constructor

Overrides void

Create an Identity entity

Parameters:

Name
Type

identifiers

context

Properties

authorizations


Protected context


did

• did: string

identity ID as stored in the blockchain


portfolios


tokenPermissions


uuid

• uuid: string

Methods

areSecondaryKeysFrozen

▸ areSecondaryKeysFrozen(): Promise‹boolean›

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

Parameters:

Name
Type

callback


createVenue

Create a Venue

Parameters:

Name
Type

args

opts?


exists

▸ exists(): Promise‹boolean›

Determine whether this Identity exists on chain

Returns: Promise‹boolean›


freezeSecondaryKeys

Parameters:

Name
Type

args

void

opts?


getHeldTokens

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


getInstructions

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


getPendingDistributions

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


getPendingInstructions

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions


getPrimaryKey

Retrieve the primary key associated with the Identity

note can be subscribed to

Parameters:

Name
Type

callback


getScopeId

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

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

Returns: Promise‹string›


getSecondaryKeys

Get the list of secondary keys related to the Identity

note can be subscribed to

Parameters:

Name
Type

callback


getTokenBalance

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

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

â–ª args: object

Name
Type

ticker

string

Returns: Promise‹BigNumber›

Parameters:

â–ª args: object

Name
Type

ticker

string


getTrustingTokens

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


getVenues

Retrieve all Venues created by this Identity

note can be subscribed to

Parameters:

Name
Type

callback


hasRole

Check whether this Identity possesses the specified Role

Parameters:

Name
Type

role

Returns: Promise‹boolean›


hasRoles

Check whether this Identity possesses all specified roles

Parameters:

Name
Type

roles

Returns: Promise‹boolean›


hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›


inviteAccount

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

Parameters:

Name
Type

args

opts?


isCddProvider

▸ isCddProvider(): Promise‹boolean›

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


isGcMember

▸ isGcMember(): Promise‹boolean›

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›


modifyPermissions

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

Parameters:

Name
Type

args

opts?


removeSecondaryKeys

Remove a list of secondary keys associated with the Identity

Parameters:

Name
Type

args

opts?


revokePermissions

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

Parameters:

â–ª args: object

Name
Type

secondaryKeys


toJson

â–¸ toJson(): string

Return the Identity's DID

Returns: string


unfreezeSecondaryKeys

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

Parameters:

Name
Type

args

void

opts?


Static generateUuid

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

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

+ new Identity(identifiers: , context: ):

Defined in

Returns:

• authorizations:

Defined in

• context:

Inherited from .

Defined in

Defined in

• portfolios:

Defined in

• tokenPermissions:

Defined in

Inherited from .

Defined in

Defined in

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

Defined in

‹boolean›

Returns: Promise‹›

▸ createVenue(args: , opts?: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

Overrides .

Defined in

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

Defined in

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

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

Returns: Promise‹‹void››

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

Defined in

Returns: Promise‹‹››

▸ getInstructions(): Promise‹›

Defined in

Returns: Promise‹›

▸ getPendingDistributions(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getPendingInstructions(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getPrimaryKey(): Promise‹›

Defined in

Returns: Promise‹›

▸ getPrimaryKey(callback: ‹›): Promise‹›

Defined in

‹›

Returns: Promise‹›

Defined in

| string

▸ getSecondaryKeys(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getSecondaryKeys(callback: ‹[]›): Promise‹›

Defined in

‹[]›

Returns: Promise‹›

Defined in

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

Defined in

▪ callback: ‹BigNumber›

Returns: Promise‹›

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

Defined in

Returns: Promise‹[]›

▸ getVenues(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getVenues(callback: ‹[]›): Promise‹›

Defined in

‹[]›

Returns: Promise‹›

▸ hasRole(role: ): Promise‹boolean›

Defined in

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

Defined in

[]

Defined in

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

Defined in

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

Returns: Promise‹‹void››

Defined in

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

Inherited from .

Defined in

‹unknown, unknown›

Defined in

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

Defined in

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

Returns: Promise‹‹void››

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

Defined in

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

Returns: Promise‹‹void››

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

Defined in

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

[]

â–ªOptional opts:

Returns: Promise‹‹void››

Overrides .

Defined in

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

Defined in

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

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

UniqueIdentifiers
Context
Identity
src/api/entities/Identity/index.ts:111
Identity
IdentityAuthorizations
src/api/entities/Identity/index.ts:109
Context
src/api/entities/Entity.ts:48
src/api/entities/Identity/index.ts:106
Portfolios
src/api/entities/Identity/index.ts:110
TokenPermissions
src/api/entities/Identity/index.ts:111
src/api/entities/Entity.ts:46
src/api/entities/Identity/index.ts:681
src/api/entities/Identity/index.ts:682
CreateVenueParams
ProcedureOpts
TransactionQueue
Venue
src/api/entities/Identity/index.ts:225
ProcedureMethod
TransactionQueue
Venue
src/api/entities/Identity/index.ts:804
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:235
ProcedureMethod
TransactionQueue
ResultSet
SecurityToken
src/api/entities/Identity/index.ts:435
ResultSet
SecurityToken
GroupedInstructions
src/api/entities/Identity/index.ts:559
GroupedInstructions
DistributionWithDetails
src/api/entities/Identity/index.ts:717
DistributionWithDetails
Instruction
src/api/entities/Identity/index.ts:628
Instruction
Account
src/api/entities/Identity/index.ts:400
Account
src/api/entities/Identity/index.ts:401
src/api/entities/Identity/index.ts:541
SecondaryKey
src/api/entities/Identity/index.ts:769
SecondaryKey
src/api/entities/Identity/index.ts:770
src/api/entities/Identity/index.ts:300
src/api/entities/Identity/index.ts:301
SecurityToken
src/api/entities/Identity/index.ts:486
SecurityToken
Venue
src/api/entities/Identity/index.ts:507
Venue
src/api/entities/Identity/index.ts:508
src/api/entities/Identity/index.ts:252
src/api/entities/Identity/index.ts:475
src/api/entities/Identity/index.ts:348
InviteAccountParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:215
ProcedureMethod
TransactionQueue
src/api/entities/Identity/index.ts:381
Entity
src/api/entities/Entity.ts:61
src/api/entities/Identity/index.ts:364
ModifySignerPermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:201
ProcedureMethod
TransactionQueue
RemoveSecondaryKeysParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:181
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:191
ProcedureMethod
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:817
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:245
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
UniqueIdentifiers
DefaultTrustedClaimIssuer
constructor
authorizations
context
did
portfolios
tokenPermissions
uuid
areSecondaryKeysFrozen
createVenue
exists
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
unfreezeSecondaryKeys
UniqueIdentifiers
Context
CreateVenueParams
ProcedureOpts
ProcedureOpts
SecurityToken
InviteAccountParams
ProcedureOpts
Entity
ModifySignerPermissionsParams
ProcedureOpts
RemoveSecondaryKeysParams
ProcedureOpts
ProcedureOpts
Entity
Entity
Entity
Account
SecondaryKey
Venue
Entity
Entity
Entity
Entity
Account
SecondaryKey
Venue
context
uuid
exists
isEqual
toJson
generateUuid
unserialize
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
Role
Role
SubCallback
SubCallback
SubCallback
SubCallback
Role
Role
Signer