Last updated
Was this helpful?
Last updated
Was this helpful?
Represents an Identity in the Polymesh blockchain
‹UniqueIdentifiers, string›
↳ Identity
↳
Overrides void
Create an Identity entity
Parameters:
Protected context• context: Context
• did: string
Identity ID as stored in the blockchain
• uuid: string
▸ areSecondaryAccountsFrozen(): Promise‹boolean›
Check whether secondary Accounts are frozen
note can be subscribed to
Returns: Promise‹boolean›
Parameters:
Check whether this Identity possesses all specified roles
Parameters:
▸ exists(): Promise‹boolean›
Determine whether this Identity exists on chain
Returns: Promise‹boolean›
▸ getAssetBalance(args: object): Promise‹BigNumber›
Retrieve the balance of a particular Asset
note can be subscribed to
Parameters:
▪ args: object
Returns: Promise‹BigNumber›
Parameters:
▪ args: object
Retrieve a list of all Assets which were held at one point by this Identity
note uses the middleware
note supports pagination
Parameters:
▪Default value opts: object= { order: Order.Asc }
Retrieve all Instructions where this Identity is a participant, grouped by status
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 Assets this Identity has held
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Retrieve the primary Account associated with the Identity
note can be subscribed to
Parameters:
▸ getScopeId(args: object): Promise‹string | null›
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none
Parameters:
▪ args: object
Returns: Promise‹string | null›
Get the list of secondary Accounts related to the Identity
note can be subscribed to
Parameters:
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middleware
Retrieve all Venues created by this Identity
note can be subscribed to
Parameters:
Check whether this Identity possesses the specified Role
Parameters:
Returns: Promise‹boolean›
Check whether this Identity possesses all specified roles
deprecated in favor of checkRoles
Parameters:
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›
Determine whether this Entity is the same as another one
Parameters:
Returns: boolean
▸ isGcMember(): Promise‹boolean›
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
▸ toJson(): string
Return the Identity's DID
Returns: string
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
Returns: Identifiers
+ new Identity(identifiers: UniqueIdentifiers, context: Context):
Defined in
Returns:
• assetPermissions:
Defined in
• authorizations:
Defined in
Inherited from .
Defined in
Defined in
• portfolios:
Defined in
Inherited from .
Defined in
Defined in
▸ areSecondaryAccountsFrozen(callback: ‹boolean›): Promise‹›
Defined in
Returns: Promise‹›
▸ checkRoles(roles: []): Promise‹›
Defined in
Returns: Promise‹›
Overrides .
Defined in
Defined in
▸ getAssetBalance(args: object, callback: ‹BigNumber›): Promise‹›
Defined in
▪ callback: ‹BigNumber›
Returns: Promise‹›
▸ getHeldAssets(opts: object): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getInstructions(): Promise‹›
Defined in
Returns: Promise‹›
▸ getPendingDistributions(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getPendingInstructions(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getPrimaryAccount(): Promise‹›
Defined in
Returns: Promise‹›
▸ getPrimaryAccount(callback: ‹›): Promise‹›
Defined in
Returns: Promise‹›
Defined in
note more on Investor Uniqueness and
▸ getSecondaryAccounts(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getSecondaryAccounts(callback: ‹[]›): Promise‹›
Defined in
Returns: Promise‹›
▸ getTrustingAssets(): 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: ‹unknown, unknown›): boolean
Inherited from .
Defined in
Defined in
Overrides .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
identifiers
UniqueIdentifiers
context
Context
callback
SubCallback‹boolean›
roles
Role[]
ticker
string
ticker
string
order?
Order
size?
BigNumber
start?
BigNumber
callback
asset
Asset | string
callback
callback
SubCallback‹Venue[]›
role
roles
Role[]
entity
Entity‹unknown, unknown›
identifiers
Identifiers
serialized
string
UUID to unserialize