CurrentIdentity

Represents the Identity associated to the current Account

Hierarchy

Identity

CurrentIdentity

Index

Constructors

Properties

Methods

Constructors

constructor

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

Overrides Identity.constructor

Defined in src/api/entities/CurrentIdentity.ts:24

Create a CurrentIdentity entity

Parameters:

Name

Type

identifiers

context

Returns: CurrentIdentity

Properties

authorizations

authorizations: IdentityAuthorizations

Inherited from Identity.authorizations

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

Protected context

context: Context

Inherited from Entity.context

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

did

did: string

Inherited from Identity.did

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

identity ID as stored in the blockchain

portfolios

portfolios: Portfolios

Inherited from Identity.portfolios

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

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

areSecondaryKeysFrozen

areSecondaryKeysFrozen(): Promise‹boolean›

Inherited from Identity.areSecondaryKeysFrozen

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

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

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

Inherited from Identity.areSecondaryKeysFrozen

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

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

createVenue

createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueueVenue››

Defined in src/api/entities/CurrentIdentity.ts:130

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:

Returns: Promise‹TransactionQueueVenue››

freezeSecondaryKeys

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

Defined in src/api/entities/CurrentIdentity.ts:140

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

Inherited from Identity.getHeldTokens

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

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

Inherited from Identity.getInstructions

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

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

Returns: Promise‹GroupedInstructions

getPendingDistributions

getPendingDistributions(): Promise‹DistributionWithDetails[]›

Inherited from Identity.getPendingDistributions

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

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

Inherited from Identity.getPendingInstructions

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

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

getPrimaryKey

getPrimaryKey(): Promise‹string›

Inherited from Identity.getPrimaryKey

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

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹string›

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

Inherited from Identity.getPrimaryKey

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

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

getScopeId

getScopeId(args: object): Promise‹string›

Inherited from Identity.getScopeId

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

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

Inherited from Identity.getSecondaryKeys

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

Get the list of secondary keys related to the Identity

note can be subscribed to

Returns: Promise‹SecondaryKey[]›

getSecondaryKeys(callback: SubCallbackSecondaryKey[]›): Promise‹UnsubCallback

Inherited from Identity.getSecondaryKeys

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

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

getTokenBalance

getTokenBalance(args: object): Promise‹BigNumber›

Inherited from Identity.getTokenBalance

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

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

Inherited from Identity.getTokenBalance

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

Parameters:

args: object

Name

Type

ticker

string

callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback

getTrustingTokens

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

Inherited from Identity.getTrustingTokens

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

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

Inherited from Identity.getVenues

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

Retrieve all Venues created by this Identity

note can be subscribed to

Returns: Promise‹Venue[]›

getVenues(callback: SubCallbackVenue[]›): Promise‹UnsubCallback

Inherited from Identity.getVenues

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

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

hasRole

hasRole(role: Role): Promise‹boolean›

Inherited from Identity.hasRole

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

Check whether this Identity possesses the specified Role

Parameters:

Name

Type

role

Returns: Promise‹boolean›

hasRoles

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

Inherited from Identity.hasRoles

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

Check whether this Identity possesses all specified roles

Parameters:

Name

Type

roles

Returns: Promise‹boolean›

hasTokenPermissions

hasTokenPermissions(args: object): Promise‹boolean›

Inherited from Identity.hasTokenPermissions

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

Check whether this Identity has specific transaction Permissions over a Security Token

Parameters:

args: object

Name

Type

token

SecurityToken | string

transactions

TxTag[] | null

Returns: Promise‹boolean›

hasValidCdd

hasValidCdd(): Promise‹boolean›

Inherited from Identity.hasValidCdd

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

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/CurrentIdentity.ts:120

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:

Returns: Promise‹TransactionQueue‹void››

isCddProvider

isCddProvider(): Promise‹boolean›

Inherited from Identity.isCddProvider

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

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›

Inherited from Identity.isGcMember

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

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/CurrentIdentity.ts:106

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:

Returns: Promise‹TransactionQueue‹void››

removeSecondaryKeys

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

Defined in src/api/entities/CurrentIdentity.ts:86

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:

Returns: Promise‹TransactionQueue‹void››

revokePermissions

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

Defined in src/api/entities/CurrentIdentity.ts:96

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

Optional opts: ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): string

Inherited from Identity.toJson

Overrides Entity.toJson

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

Return the Identity's DID

Returns: string

unfreezeSecondaryKeys

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

Defined in src/api/entities/CurrentIdentity.ts:150

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

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

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

Last updated