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

Name	Type
`args`	CreateVenueParams
`opts?`	ProcedureOpts

args

CreateVenueParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹Venue››

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

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

Determine whether this Identity exists on chain

Returns: Promise‹boolean›

freezeSecondaryKeys

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

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

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

Name	Type
`args`	void
`opts?`	ProcedureOpts

args

void

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

getHeldTokens

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

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

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

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

order?

Order

size?

undefined | number

start?

undefined | number

Returns: Promise‹ResultSet‹SecurityToken››

getInstructions

▸ getInstructions(): Promise‹GroupedInstructions›

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

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

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

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

getPrimaryKey

▸ getPrimaryKey(): Promise‹Account›

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

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹Account›

▸ getPrimaryKey(callback: SubCallback‹Account›): Promise‹UnsubCallback›

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

Parameters:

Name Type

Name	Type
`callback`	SubCallback‹Account›

callback

SubCallback‹Account›

Returns: Promise‹UnsubCallback›

getScopeId

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

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

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

Name	Type
`token`	SecurityToken \| string

token

SecurityToken | string

Returns: Promise‹string›

getSecondaryKeys

▸ getSecondaryKeys(): Promise‹SecondaryKey[]›

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

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

Parameters:

Name Type

Name	Type
`callback`	SubCallback‹SecondaryKey[]›

callback

SubCallback‹SecondaryKey[]›

Returns: Promise‹UnsubCallback›

getTokenBalance

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

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

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

▪ args: object

Name Type

Name	Type
`ticker`	string

ticker

string

Returns: Promise‹BigNumber›

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

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

Parameters:

▪ args: object

Name Type

Name	Type
`ticker`	string

ticker

string

▪ callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

getTrustingTokens

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

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

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

Name	Type
`order`	Order

order

Order

Returns: Promise‹SecurityToken[]›

getVenues

▸ getVenues(): Promise‹Venue[]›

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

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

Parameters:

Name Type

Name	Type
`callback`	SubCallback‹Venue[]›

callback

SubCallback‹Venue[]›

Returns: Promise‹UnsubCallback›

hasRole

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

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

Check whether this Identity possesses the specified Role

Parameters:

Name Type

Name	Type
`role`	Role

role

Role

Returns: Promise‹boolean›

hasRoles

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

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

Check whether this Identity possesses all specified roles

Parameters:

Name Type

Name	Type
`roles`	Role[]

roles

Role[]

Returns: Promise‹boolean›

hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

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

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

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

Name	Type
`args`	InviteAccountParams
`opts?`	ProcedureOpts

args

InviteAccountParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

isCddProvider

▸ isCddProvider(): Promise‹boolean›

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

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

Determine whether this Entity is the same as another one

Parameters:

Name Type

Name	Type
`entity`	Entity‹unknown, unknown›

entity

Entity‹unknown, unknown›

Returns: boolean

isGcMember

▸ isGcMember(): Promise‹boolean›

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

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

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

Name	Type
`args`	ModifySignerPermissionsParams
`opts?`	ProcedureOpts

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

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

Name	Type
`args`	RemoveSecondaryKeysParams
`opts?`	ProcedureOpts

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

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

Name	Type
`secondaryKeys`	Signer[]

secondaryKeys

Signer[]

▪Optional opts: ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

▸ toJson(): string

Overrides Entity.toJson

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

Return the Identity's DID

Returns: string

unfreezeSecondaryKeys

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

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

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

Name	Type
`args`	void
`opts?`	ProcedureOpts

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

Name	Type	Description
`identifiers`	Identifiers

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

Name	Type	Description
`serialized`	string	UUID to unserialize

serialized

string

UUID to unserialize

Returns: Identifiers

PreviousEntity NextIdentityAuthorizations

Last updated 2 years ago

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

`Protected` context

`Static` generateUuid

`Static` unserialize