api_entities_Identity.Identity
@polymeshassociation/polymesh-sdk / Modules / api/entities/Identity / Identity
Class: Identity
api/entities/Identity.Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Identity(identifiers, context)
Create an Identity entity
Parameters
| Name | Type |
|---|---|
| |
|
|
Overrides
Entity<UniqueIdentifiers, string>.constructor
Defined in
api/entities/Identity/index.ts:104
Properties
assetPermissions
• assetPermissions: AssetPermissions
Defined in
api/entities/Identity/index.ts:99
authorizations
• authorizations: IdentityAuthorizations
Defined in
api/entities/Identity/index.ts:97
did
• did: string
Identity ID as stored in the blockchain
Defined in
api/entities/Identity/index.ts:94
portfolios
• portfolios: Portfolios
Defined in
api/entities/Identity/index.ts:98
uuid
• uuid: string
Inherited from
Defined in
Methods
areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(): Promise<boolean>
Check whether secondary Accounts are frozen
note can be subscribed to
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:594
▸ areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
|
|
Returns
Promise<UnsubCallback>
Defined in
api/entities/Identity/index.ts:595
checkRoles
▸ checkRoles(roles): Promise<CheckRolesResult>
Check whether this Identity possesses all specified roles
Parameters
| Name | Type |
|---|---|
|
|
Returns
Promise<CheckRolesResult>
Defined in
api/entities/Identity/index.ts:362
exists
▸ 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
api/entities/Identity/index.ts:751
getAssetBalance
▸ getAssetBalance(args): Promise<BigNumber>
Retrieve the balance of a particular Asset
note can be subscribed to
Parameters
| Name | Type |
|---|---|
|
|
|
|
Returns
Promise<BigNumber>
Defined in
api/entities/Identity/index.ts:166
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
|
|
|
|
|
|
Returns
Promise<UnsubCallback>
Defined in
api/entities/Identity/index.ts:167
getHeldAssets
▸ getHeldAssets(opts?): Promise<ResultSet<Asset>>
Retrieve a list of all Assets which were held at one point by this Identity
note uses the middleware
note supports pagination
Parameters
| Name | Type |
|---|---|
|
|
|
|
|
|
|
|
Returns
Defined in
api/entities/Identity/index.ts:320
getInstructions
▸ getInstructions(): Promise<GroupedInstructions>
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns
Promise<GroupedInstructions>
Defined in
api/entities/Identity/index.ts:472
getPendingDistributions
▸ getPendingDistributions(): Promise<DistributionWithDetails[]>
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
Promise<DistributionWithDetails[]>
Defined in
api/entities/Identity/index.ts:631
getPendingInstructions
▸ getPendingInstructions(): Promise<Instruction[]>
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns
Promise<Instruction[]>
Defined in
api/entities/Identity/index.ts:541
getPrimaryAccount
▸ getPrimaryAccount(): Promise<PermissionedAccount>
Retrieve the primary Account associated with the Identity
note can be subscribed to
Returns
Promise<PermissionedAccount>
Defined in
api/entities/Identity/index.ts:267
▸ getPrimaryAccount(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
|
Returns
Promise<UnsubCallback>
Defined in
api/entities/Identity/index.ts:268
getScopeId
▸ 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
note more on Investor Uniqueness here and here
Parameters
| Name | Type |
|---|---|
|
|
|
|
Returns
Promise<null | string>
Defined in
api/entities/Identity/index.ts:450
getSecondaryAccounts
▸ getSecondaryAccounts(): Promise<PermissionedAccount[]>
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
Promise<PermissionedAccount[]>
Defined in
api/entities/Identity/index.ts:686
▸ getSecondaryAccounts(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
|
Returns
Promise<UnsubCallback>
Defined in
api/entities/Identity/index.ts:687
getTrustingAssets
▸ getTrustingAssets(): Promise<Asset[]>
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middleware
Returns
Promise<Asset[]>
Defined in
api/entities/Identity/index.ts:397
getVenues
▸ getVenues(): Promise<Venue[]>
Retrieve all Venues created by this Identity
note can be subscribed to
Returns
Promise<Venue[]>
Defined in
api/entities/Identity/index.ts:414
▸ getVenues(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
|
|
Returns
Promise<UnsubCallback>
Defined in
api/entities/Identity/index.ts:415
hasRole
▸ hasRole(role): Promise<boolean>
Check whether this Identity possesses the specified Role
Parameters
| Name | Type |
|---|---|
|
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:118
hasRoles
▸ hasRoles(roles): Promise<boolean>
Check whether this Identity possesses all specified roles
deprecated in favor of checkRoles
Parameters
| Name | Type |
|---|---|
|
|
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:386
hasValidCdd
▸ hasValidCdd(): Promise<boolean>
Check whether this Identity has a valid CDD claim
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:215
isCddProvider
▸ isCddProvider(): Promise<boolean>
Check whether this Identity is a CDD provider
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:248
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
|
|
Returns
boolean
Inherited from
Defined in
isGcMember
▸ isGcMember(): Promise<boolean>
Check whether this Identity is Governance Committee member
Returns
Promise<boolean>
Defined in
api/entities/Identity/index.ts:231
toHuman
▸ toHuman(): string
Return the Identity's DID
Returns
string
Overrides
Defined in
api/entities/Identity/index.ts:774
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
|
Parameters
| Name | Type |
|---|---|
|
|
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
|
Parameters
| Name | Type | Description |
|---|---|---|
|
| UUID to unserialize |
Returns
Identifiers
Inherited from
Defined in
Last updated