CurrentIdentity
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents the Identity associated to the current
↳
↳ CurrentIdentity
Create a CurrentIdentity entity
Parameters:
Name
Type
identifiers
context
Protected contextCreate a Venue
• did: string
identity ID as stored in the blockchain
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
param list of allowed permissions (optional, defaults to no permissions)
param array of Security Tokens (or tickers) for which to allow permission. Set null to allow all (optional, no permissions if not passed)
param array of tags associated with the transaction that will be executed for which to allow permission. Set null to allow all (optional, no permissions if not passed)
param array of portfolios for which to allow permission. Set null to allow all (optional, no permissions if not passed)
Modify all permissions of a list of secondary keys associated with the Identity
param list of permissions
param array of Security Tokens on which to grant permissions. A null value represents full permissions
param array of transaction tags that the Secondary Key has permission to execute. A null value represents full permissions
param array of Portfolios for which to grant permissions. A null value represents full permissions
Remove a list of secondary keys associated with the Identity
• revokePermissions: ProcedureMethod‹object, void›
Revoke all permissions of a list of secondary keys associated with the Identity
• uuid: string
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 the Current 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›
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›
▸ isCddProvider(): Promise‹boolean›
Check whether this Identity is a CDD provider
Returns: Promise‹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 CurrentIdentity(identifiers: , context: ):
Overrides .
Defined in
Returns:
• authorizations:
Inherited from .
Defined in
• context:
Inherited from .
Defined in
• createVenue: ProcedureMethod‹, ›
Defined in
Inherited from .
Defined in
• inviteAccount: ProcedureMethod‹, void›
Defined in
• modifyPermissions: ProcedureMethod‹, void›
Defined in
• portfolios:
Inherited from .
Defined in
• removeSecondaryKeys: ProcedureMethod‹, void›
Defined in
Defined in
Inherited from .
Defined in
▸ getHeldTokens(opts: object): Promise‹‹››
Inherited from .
Defined in
Returns: Promise‹‹››
▸ getPendingInstructions(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Inherited from .
Defined in
▸ getPrimaryKey(callback: ‹string›): Promise‹›
Inherited from .
Defined in
‹string›
Returns: Promise‹›
Inherited from .
Defined in
note more on Investor Uniqueness:
| string
▸ getSecondaryKeys(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getSecondaryKeys(callback: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
Inherited from .
Defined in
▸ getTokenBalance(args: object, callback: ‹BigNumber›): Promise‹›
Inherited from .
Defined in
▪ callback: ‹BigNumber›
Returns: Promise‹›
▸ getTrustingTokens(args: object): Promise‹[]›
Inherited from .
Defined in
Returns: Promise‹[]›
▸ getVenues(): Promise‹[]›
Inherited from .
Defined in
Returns: Promise‹[]›
▸ getVenues(callback: ‹[]›): Promise‹›
Inherited from .
Defined in
‹[]›
Returns: Promise‹›
▸ hasRole(role: ): Promise‹boolean›
Inherited from .
Defined in
▸ hasRoles(roles: []): Promise‹boolean›
Inherited from .
Defined in
[]
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in