Identity
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents an Identity in the Polymesh blockchain
‹UniqueIdentifiers›
↳ Identity
↳
Overrides void
Create an Identity entity
Parameters:
Name
Type
identifiers
UniqueIdentifiers
context
Protected context• did: string
identity ID as stored in the blockchain
• uuid: string
▸ areSecondaryKeysFrozen(): Promise‹boolean›
Check whether secondary keys are frozen
note can be subscribed to
Returns: Promise‹boolean›
Parameters:
Name
Type
callback
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
Retrieve all pending Instructions involving this Identity
▸ getPrimaryKey(): Promise‹string›
Retrieve the primary key associated with the Identity
note can be subscribed to
Returns: Promise‹string›
Parameters:
Name
Type
callback
▸ getScopeId(args: object): Promise‹string›
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token
Parameters:
â–ª args: object
Name
Type
token
Returns: Promise‹string›
▸ 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›
Parameters:
â–ª args: object
Name
Type
ticker
string
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
Retrieve all Venues created by this Identity
note can be subscribed to
Parameters:
Name
Type
callback
Check whether this Identity possesses the specified Role
Parameters:
Name
Type
role
Returns: Promise‹boolean›
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Returns: Promise‹boolean›
▸ hasValidCdd(): Promise‹boolean›
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
▸ isCddProvider(): Promise‹boolean›
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
▸ isGcMember(): Promise‹boolean›
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
+ new Identity(identifiers: UniqueIdentifiers, context: ):
Defined in
Returns:
• authorizations:
Defined in
• context:
Inherited from .
Defined in
Defined in
• portfolios:
Defined in
Inherited from .
Defined in
Defined in
▸ areSecondaryKeysFrozen(callback: ‹boolean›): Promise‹›
Defined in
‹boolean›
Returns: Promise‹›
▸ getHeldTokens(opts: object): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getPendingInstructions(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ getPrimaryKey(callback: ‹string›): Promise‹›
Defined in
‹string›
Returns: Promise‹›
Defined in
note more on Investor Uniqueness:
| string
Defined in
▸ getTokenBalance(args: object, callback: ‹BigNumber›): Promise‹›
Defined in
▪ callback: ‹BigNumber›
Returns: Promise‹›
▸ getTrustingTokens(args: object): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getVenues(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getVenues(callback: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
▸ hasRole(role: ): Promise‹boolean›
Defined in
▸ hasRoles(roles: []): Promise‹boolean›
Defined in
[]
Defined in
Defined in
▸ isEqual(entity: ‹object›): boolean
Inherited from .
Defined in
‹object›
Defined in
Inherited from .
Defined in
Inherited from .
Defined in