Identity
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents an Identity in the Polymesh blockchain
‹, string›
↳ Identity
↳
Overrides void
Create an Identity entity
Parameters:
Name
Type
identifiers
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
Create a Venue
Parameters:
Name
Type
args
opts?
Parameters:
Name
Type
args
void
opts?
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 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 Tokens this Identity has held
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
▸ 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›
Get the list of secondary keys related to the Identity
note can be subscribed to
Parameters:
Name
Type
callback
▸ 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›
Send an invitation to an Account to join this Identity
note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
Parameters:
Name
Type
args
opts?
▸ 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›
Modify all permissions of a list of secondary keys associated with the Identity
Parameters:
Name
Type
args
opts?
Remove a list of secondary keys associated with the Identity
Parameters:
Name
Type
args
opts?
Revoke all permissions of a list of secondary keys associated with the Identity
Parameters:
â–ª args: object
Name
Type
secondaryKeys
â–¸ toJson(): string
Return the Identity's DID
Returns: string
Unfreeze all the secondary keys in this Identity. This will restore their permissions as they were before being frozen
Parameters:
Name
Type
args
void
opts?
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
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
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
+ new Identity(identifiers: , context: ):
Defined in
Returns:
• authorizations:
Defined in
• context:
Inherited from .
Defined in
Defined in
• portfolios:
Defined in
• tokenPermissions:
Defined in
Inherited from .
Defined in
Defined in
▸ areSecondaryKeysFrozen(callback: ‹boolean›): Promise‹›
Defined in
‹boolean›
Returns: Promise‹›
▸ createVenue(args: , opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call createVenue.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ freezeSecondaryKeys(args: void, opts?: ): Promise‹‹void››
Defined in
Freeze all the secondary keys in this Identity. This means revoking their permission to perform any operation on the blockchain and freezing their funds until the keys are unfrozen via
note this method is of type , which means you can call freezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ getHeldTokens(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‹[]›
Defined in
▸ getPrimaryKey(callback: ‹string›): Promise‹›
Defined in
‹string›
Returns: Promise‹›
Defined in
note more on Investor Uniqueness:
| string
▸ getSecondaryKeys(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getSecondaryKeys(callback: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
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
▸ inviteAccount(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call inviteAccount.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
▸ modifyPermissions(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call modifyPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ removeSecondaryKeys(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call removeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ revokePermissions(args: object, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call revokePermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
[]
â–ªOptional opts:
Returns: Promise‹‹void››
Overrides .
Defined in
▸ unfreezeSecondaryKeys(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call unfreezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Inherited from .
Defined in
Inherited from .
Defined in