Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity
Overrides void
Defined in src/api/entities/Identity/index.ts:99
Create an Identity entity
Parameters:
Name | Type |
| |
|
Returns: Identity
Properties
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:98
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
did
• did: string
Defined in src/api/entities/Identity/index.ts:95
identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:99
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
areSecondaryKeysFrozen
▸ areSecondaryKeysFrozen(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:693
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:694
Parameters:
Name | Type |
| SubCallback‹boolean› |
Returns: Promise‹UnsubCallback›
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
Defined in src/api/entities/Identity/index.ts:445
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 |
| undefined | number |
| undefined | number |
Returns: Promise‹ResultSet‹SecurityToken››
getInstructions
▸ getInstructions(): Promise‹GroupedInstructions›
Defined in src/api/entities/Identity/index.ts:569
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:729
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:642
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:410
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:411
Parameters:
Name | Type |
| SubCallback‹string› |
Returns: Promise‹UnsubCallback›
getScopeId
▸ getScopeId(args: object): Promise‹string›
Defined in src/api/entities/Identity/index.ts:551
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 |
| SecurityToken | string |
Returns: Promise‹string›
getSecondaryKeys
▸ getSecondaryKeys(): Promise‹SecondaryKey[]›
Defined in src/api/entities/Identity/index.ts:781
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:782
Parameters:
Name | Type |
|
Returns: Promise‹UnsubCallback›
getTokenBalance
▸ getTokenBalance(args: object): Promise‹BigNumber›
Defined in src/api/entities/Identity/index.ts:310
Retrieve the balance of a particular Security Token
note can be subscribed to
Parameters:
▪ args: object
Name | Type |
| string |
Returns: Promise‹BigNumber›
▸ getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:311
Parameters:
▪ args: object
Name | Type |
| string |
▪ callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback›
getTrustingTokens
▸ getTrustingTokens(args: object): Promise‹SecurityToken[]›
Defined in src/api/entities/Identity/index.ts:496
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 |
Returns: Promise‹SecurityToken[]›
getVenues
▸ getVenues(): Promise‹Venue[]›
Defined in src/api/entities/Identity/index.ts:517
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:518
Parameters:
Name | Type |
| SubCallback‹Venue[]› |
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:240
Check whether this Identity possesses the specified Role
Parameters:
Name | Type |
|
Returns: Promise‹boolean›
hasRoles
▸ hasRoles(roles: Role[]): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:485
Check whether this Identity possesses all specified roles
Parameters:
Name | Type |
| Role[] |
Returns: Promise‹boolean›
hasTokenPermissions
▸ hasTokenPermissions(args: object): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:117
Check whether this Identity has specific transaction Permissions over a Security Token
Parameters:
▪ args: object
Name | Type |
| SecurityToken | string |
| TxTag[] | null |
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:358
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:391
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Defined in src/api/entities/Entity.ts:61
Whether this Entity is the same as another one
Parameters:
Name | Type |
| Entity‹unknown, unknown› |
Returns: boolean
isGcMember
▸ isGcMember(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:374
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
toJson
▸ toJson(): string
Defined in src/api/entities/Identity/index.ts:816
Return the Identity's DID
Returns: string
Static generateUuid
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 |
Returns: string
Static unserialize
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 |
| string | UUID to unserialize |
Returns: Identifiers
Last updated