api_entities_Identity.Identity
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Identity
.Identity
Represents an Identity in the Polymesh blockchain
<, string>
↳ Identity
↳↳
• new Identity(identifiers, context)
Create an Identity entity
Parameters
identifiers
context
Context
Overrides
Entity<UniqueIdentifiers, string>.constructor
Defined in
Defined in
Defined in
• did: string
Identity ID as stored in the blockchain
Defined in
Defined in
• uuid: string
Inherited from
Defined in
â–¸ areSecondaryAccountsFrozen(): Promise<boolean>
Check whether secondary Accounts are frozen
note can be subscribed to
Returns
Promise<boolean>
Defined in
Parameters
callback
Returns
Defined in
Check whether this Identity possesses all specified roles
Parameters
roles
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Identity exists on chain
note asset Identities aren't considered to exist for the
Returns
Promise<boolean>
Overrides
Defined in
â–¸ getAssetBalance(args): Promise<BigNumber>
Retrieve the balance of a particular Asset
note can be subscribed to
Parameters
args
Object
args.ticker
string
Returns
Promise<BigNumber>
Defined in
Parameters
args
Object
args.ticker
string
callback
Returns
Defined in
Retrieve a list of all Assets which were held at one point by this Identity
note uses the middleware
note supports pagination
Parameters
opts
Object
opts.order?
Order
opts.size?
BigNumber
opts.start?
BigNumber
Returns
Defined in
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns
Defined in
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
Returns
Defined in
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns
Defined in
Retrieve the primary Account associated with the Identity
note can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
â–¸ getScopeId(args): Promise<null | string>
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
args.asset
Returns
Promise<null | string>
Defined in
Get the list of secondary Accounts related to the Identity
note can be subscribed to
note This method currently lacks pagination and may be slow for identities with many thousands of keys
Returns
Defined in
Parameters
callback
Returns
Defined in
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middleware
Returns
Defined in
Retrieve all Venues created by this Identity
note can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
â–¸ hasRole(role): Promise<boolean>
Check whether this Identity possesses the specified Role
Parameters
role
Returns
Promise<boolean>
Defined in
â–¸ hasRoles(roles): Promise<boolean>
Check whether this Identity possesses all specified roles
deprecated in favor of checkRoles
Parameters
roles
Returns
Promise<boolean>
Defined in
â–¸ hasValidCdd(): Promise<boolean>
Check whether this Identity has a valid CDD claim
Returns
Promise<boolean>
Defined in
â–¸ isCddProvider(): Promise<boolean>
Check whether this Identity is a CDD provider
Returns
Promise<boolean>
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ isGcMember(): Promise<boolean>
Check whether this Identity is Governance Committee member
Returns
Promise<boolean>
Defined in
â–¸ toHuman(): string
Return the Identity's DID
Returns
string
Overrides
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• assetPermissions:
• authorizations:
• portfolios:
.
â–¸ areSecondaryAccountsFrozen(callback): Promise<>
<boolean>
Promise<>
â–¸ checkRoles(roles): Promise<>
[]
Promise<>
.
â–¸ getAssetBalance(args, callback): Promise<>
<BigNumber>
Promise<>
â–¸ getHeldAssets(opts?): Promise<<>>
Promise<<>>
â–¸ getInstructions(): Promise<>
Promise<>
â–¸ getPendingDistributions(): Promise<[]>
Promise<[]>
â–¸ getPendingInstructions(): Promise<[]>
Promise<[]>
â–¸ getPrimaryAccount(): Promise<>
Promise<>
â–¸ getPrimaryAccount(callback): Promise<>
<>
Promise<>
note more on Investor Uniqueness and
string |
â–¸ getSecondaryAccounts(): Promise<[]>
Promise<[]>
â–¸ getSecondaryAccounts(callback): Promise<>
<[]>
Promise<>
â–¸ getTrustingAssets(): Promise<[]>
Promise<[]>
â–¸ getVenues(): Promise<[]>
Promise<[]>
â–¸ getVenues(callback): Promise<>
<[]>
Promise<>
[]
<unknown, unknown>
.
.
.
.