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:97
Create an Identity entity
Parameters:
Returns: Identity
Properties
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:96
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:93
identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:97
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
areSecondaryKeysFrozen
▸ areSecondaryKeysFrozen(): Promise‹boolean›
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›
Defined in src/api/entities/Identity/index.ts:668
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback›
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
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‹ResultSet‹SecurityToken››
getInstructions
▸ getInstructions(): Promise‹GroupedInstructions›
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[]›
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[]›
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›
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›
Defined in src/api/entities/Identity/index.ts:385
Parameters:
Name
Type
callback
SubCallback‹string›
Returns: Promise‹UnsubCallback›
getScopeId
▸ getScopeId(args: object): Promise‹string›
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[]›
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: SubCallback‹SecondaryKey[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:756
Parameters:
Name
Type
callback
SubCallback‹SecondaryKey[]›
Returns: Promise‹UnsubCallback›
getTokenBalance
▸ getTokenBalance(args: object): Promise‹BigNumber›
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›
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[]›
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[]›
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: SubCallback‹Venue[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:492
Parameters:
Name
Type
callback
SubCallback‹Venue[]›
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
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›
Defined in src/api/entities/Identity/index.ts:459
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›
hasTokenPermissions
▸ hasTokenPermissions(args: object): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:115
Check whether this Identity has specific transaction Permissions over a Security Token
Parameters:
â–ª args: object
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:332
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
isCddProvider
▸ isCddProvider(): Promise‹boolean›
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
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›
Defined in src/api/entities/Identity/index.ts:348
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
toJson
â–¸ toJson(): string
Defined in src/api/entities/Identity/index.ts:790
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
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
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated
Was this helpful?