Identity
Represents an Identity in the Polymesh blockchain

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity
Overrides void
Create an Identity entity
Parameters:
Name
Type
identifiers
context
Context
Returns: Identity

Properties

authorizations

authorizations: IdentityAuthorizations

Protected context

context: Context
Inherited from Entity.context

did

did: string
identity ID as stored in the blockchain

portfolios

portfolios: Portfolios

tokenPermissions

tokenPermissions: TokenPermissions

uuid

uuid: string
Inherited from Entity.uuid

Methods

areSecondaryKeysFrozen

areSecondaryKeysFrozen(): Promise‹boolean›
Check whether secondary keys are frozen
note can be subscribed to
Returns: Promise‹boolean›
areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback

createVenue

createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueueVenue››
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
opts?
Returns: Promise‹TransactionQueueVenue››

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Identity exists on chain
Returns: Promise‹boolean›

freezeSecondaryKeys

freezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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?
Returns: Promise‹TransactionQueue‹void››

getHeldTokens

getHeldTokens(opts: object): Promise‹ResultSetSecurityToken››
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‹ResultSetSecurityToken››

getInstructions

getInstructions(): Promise‹GroupedInstructions
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns: Promise‹GroupedInstructions

getPendingDistributions

getPendingDistributions(): Promise‹DistributionWithDetails[]›
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[]›
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›

getPrimaryKey

getPrimaryKey(): Promise‹Account
Retrieve the primary key associated with the Identity
note can be subscribed to
Returns: Promise‹Account
getPrimaryKey(callback: SubCallbackAccount›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

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
SecurityToken | string
Returns: Promise‹string›

getSecondaryKeys

getSecondaryKeys(): Promise‹SecondaryKey[]›
Get the list of secondary keys related to the Identity
note can be subscribed to
Returns: Promise‹SecondaryKey[]›
getSecondaryKeys(callback: SubCallbackSecondaryKey[]›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

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›
getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback
Parameters:
args: object
Name
Type
ticker
string
callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback

getTrustingTokens

getTrustingTokens(args: object): Promise‹SecurityToken[]›
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[]›
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
getVenues(callback: SubCallbackVenue[]›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallbackVenue[]›
Returns: Promise‹UnsubCallback

hasRole

hasRole(role: Role): Promise‹boolean›
Check whether this Identity possesses the specified Role
Parameters:
Name
Type
role
Role
Returns: Promise‹boolean›

hasRoles

hasRoles(roles: Role[]): Promise‹boolean›
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›

hasValidCdd

hasValidCdd(): Promise‹boolean›
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›

inviteAccount

inviteAccount(args: InviteAccountParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
opts?
Returns: Promise‹TransactionQueue‹void››

isCddProvider

isCddProvider(): Promise‹boolean›
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

isGcMember

isGcMember(): Promise‹boolean›
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›

modifyPermissions

modifyPermissions(args: ModifySignerPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
opts?
Returns: Promise‹TransactionQueue‹void››

removeSecondaryKeys

removeSecondaryKeys(args: RemoveSecondaryKeysParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
opts?
Returns: Promise‹TransactionQueue‹void››

revokePermissions

revokePermissions(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
Return the Identity's DID
Returns: string

unfreezeSecondaryKeys

unfreezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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?
Returns: Promise‹TransactionQueue‹void››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago