Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity
Overrides void
Defined in src/api/entities/Identity/index.ts:111
Create an Identity entity
Parameters:
identifiers
context
Returns: Identity
Properties
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:109
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
did
• did: string
Defined in src/api/entities/Identity/index.ts:106
identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:110
tokenPermissions
• tokenPermissions: TokenPermissions
Defined in src/api/entities/Identity/index.ts:111
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
areSecondaryKeysFrozen
▸ areSecondaryKeysFrozen(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:681
Check whether secondary keys are frozen
note can be subscribed to
Returns: Promise‹boolean›
▸ areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:682
Parameters:
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback›
createVenue
▸ createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Venue››
Defined in src/api/entities/Identity/index.ts:225
Create a Venue
note this method is of type ProcedureMethod, which means you can call createVenue.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
opts?
Returns: Promise‹TransactionQueue‹Venue››
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:804
Determine whether this Identity exists on chain
Returns: Promise‹boolean›
freezeSecondaryKeys
▸ freezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:235
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 unfreezeSecondaryKeys
note this method is of type ProcedureMethod, which means you can call freezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
args
void
opts?
Returns: Promise‹TransactionQueue‹void››
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
Defined in src/api/entities/Identity/index.ts:435
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 }
order?
Order
size?
undefined | number
start?
undefined | number
Returns: Promise‹ResultSet‹SecurityToken››
getInstructions
▸ getInstructions(): Promise‹GroupedInstructions›
Defined in src/api/entities/Identity/index.ts:559
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns: Promise‹GroupedInstructions›
getPendingDistributions
▸ getPendingDistributions(): Promise‹DistributionWithDetails[]›
Defined in src/api/entities/Identity/index.ts:717
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
Returns: Promise‹DistributionWithDetails[]›
getPendingInstructions
▸ getPendingInstructions(): Promise‹Instruction[]›
Defined in src/api/entities/Identity/index.ts:628
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›
getPrimaryKey
▸ getPrimaryKey(): Promise‹Account›
Defined in src/api/entities/Identity/index.ts:400
Retrieve the primary key associated with the Identity
note can be subscribed to
Returns: Promise‹Account›
▸ getPrimaryKey(callback: SubCallback‹Account›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:401
Parameters:
callback
Returns: Promise‹UnsubCallback›
getScopeId
▸ getScopeId(args: object): Promise‹string›
Defined in src/api/entities/Identity/index.ts:541
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token
note more on Investor Uniqueness: https://developers.polymesh.live/confidential_identity
Parameters:
▪ args: object
token
SecurityToken | string
Returns: Promise‹string›
getSecondaryKeys
▸ getSecondaryKeys(): Promise‹SecondaryKey[]›
Defined in src/api/entities/Identity/index.ts:769
Get the list of secondary keys related to the Identity
note can be subscribed to
Returns: Promise‹SecondaryKey[]›
▸ getSecondaryKeys(callback: SubCallback‹SecondaryKey[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:770
Parameters:
callback
Returns: Promise‹UnsubCallback›
getTokenBalance
▸ getTokenBalance(args: object): Promise‹BigNumber›
Defined in src/api/entities/Identity/index.ts:300
Retrieve the balance of a particular Security Token
note can be subscribed to
Parameters:
▪ args: object
ticker
string
Returns: Promise‹BigNumber›
▸ getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:301
Parameters:
▪ args: object
ticker
string
▪ callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback›
getTrustingTokens
▸ getTrustingTokens(args: object): Promise‹SecurityToken[]›
Defined in src/api/entities/Identity/index.ts:486
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 }
order
Order
Returns: Promise‹SecurityToken[]›
getVenues
▸ getVenues(): Promise‹Venue[]›
Defined in src/api/entities/Identity/index.ts:507
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:508
Parameters:
callback
SubCallback‹Venue[]›
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:252
Check whether this Identity possesses the specified Role
Parameters:
role
Returns: Promise‹boolean›
hasRoles
▸ hasRoles(roles: Role[]): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:475
Check whether this Identity possesses all specified roles
Parameters:
roles
Role[]
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:348
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
inviteAccount
▸ inviteAccount(args: InviteAccountParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:215
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
note this method is of type ProcedureMethod, which means you can call inviteAccount.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
opts?
Returns: Promise‹TransactionQueue‹void››
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:381
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
entity
Entity‹unknown, unknown›
Returns: boolean
isGcMember
▸ isGcMember(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:364
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
modifyPermissions
▸ modifyPermissions(args: ModifySignerPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:201
Modify all permissions of a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call modifyPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››
removeSecondaryKeys
▸ removeSecondaryKeys(args: RemoveSecondaryKeysParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:181
Remove a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call removeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››
revokePermissions
▸ revokePermissions(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:191
Revoke all permissions of a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call revokePermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
▪ args: object
secondaryKeys
Signer[]
▪Optional opts: ProcedureOpts
Returns: Promise‹TransactionQueue‹void››
toJson
▸ toJson(): string
Defined in src/api/entities/Identity/index.ts:817
Return the Identity's DID
Returns: string
unfreezeSecondaryKeys
▸ unfreezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/index.ts:245
Unfreeze all the secondary keys in this Identity. This will restore their permissions as they were before being frozen
note this method is of type ProcedureMethod, which means you can call unfreezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
args
void
opts?
Returns: Promise‹TransactionQueue‹void››
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated