@polymeshassociation/polymesh-sdk / api/entities/Identity

Defined in: api/entities/Identity/index.ts:103

Represents an Identity in the Polymesh blockchain

• Entity<UniqueIdentifiers, string>

• DefaultTrustedClaimIssuer

assetPermissions: AssetPermissions

Defined in: api/entities/Identity/index.ts:122

authorizations: IdentityAuthorizations

Defined in: api/entities/Identity/index.ts:120

did: string

Defined in: api/entities/Identity/index.ts:117

Identity ID as stored in the blockchain

portfolios: Portfolios

Defined in: api/entities/Identity/index.ts:121

uuid: string

Defined in: api/entities/Entity.ts:46

Entity.uuid

areSecondaryAccountsFrozen(): Promise<boolean>

Defined in: api/entities/Identity/index.ts:757

Check whether secondary Accounts are frozen

Promise<boolean>

Promise that resolves to true if secondary accounts are frozen, false otherwise

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:768

Check whether secondary Accounts are frozen (with subscription support)

Parameter	Type	Description
callback	SubCallback<boolean>	Callback function that receives frozen status updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

checkRoles(roles): Promise<CheckRolesResult>

Defined in: api/entities/Identity/index.ts:497

Check whether this Identity possesses all specified roles

Parameter	Type
roles	Role[]

Promise<CheckRolesResult>

exists(): Promise<boolean>

Defined in: api/entities/Identity/index.ts:968

Determine whether this Identity exists on chain

Promise<boolean>

asset Identities aren't considered to exist for this check

Entity.exists

getAssetBalance(args): Promise<BigNumber>

Defined in: api/entities/Identity/index.ts:199

Retrieve the balance of a particular Asset by ticker

Parameter	Type	Description
args	{ ticker: string; }	-
args.ticker	string	Asset ticker

Promise<BigNumber>

Promise that resolves to the Asset balance

getAssetBalance(args): Promise<BigNumber>

Defined in: api/entities/Identity/index.ts:208

Retrieve the balance of a particular Asset by Asset ID

Parameter	Type	Description
args	{ assetId: string; }	-
args.assetId	string	Asset identifier

Promise<BigNumber>

Promise that resolves to the Asset balance

getAssetBalance(args, callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:220

Retrieve the balance of a particular Asset by ticker (with subscription support)

Parameter	Type	Description
args	{ ticker: string; }	-
args.ticker	string	Asset ticker
callback	SubCallback<BigNumber>	Callback function that receives balance updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

getAssetBalance(args, callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:235

Retrieve the balance of a particular Asset by Asset ID (with subscription support)

Parameter	Type	Description
args	{ assetId: string; }	-
args.assetId	string	Asset identifier
callback	SubCallback<BigNumber>	Callback function that receives balance updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

getHeldAssets(opts?): Promise<ResultSet<FungibleAsset>>

Defined in: api/entities/Identity/index.ts:394

Retrieve a list of all Assets which were held at one point by this Identity

Parameter	Type
opts	{ order?: AssetHoldersOrderBy; size?: BigNumber; start?: BigNumber; }
opts.order?	AssetHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Promise<ResultSet<FungibleAsset>>

uses the middlewareV2

supports pagination

getHeldNfts(opts?): Promise<ResultSet<HeldNfts>>

Defined in: api/entities/Identity/index.ts:440

Retrieve a list of all NftCollections which were held at one point by this Identity

Parameter	Type
opts	{ order?: NftHoldersOrderBy; size?: BigNumber; start?: BigNumber; }
opts.order?	NftHoldersOrderBy
opts.size?	BigNumber
opts.start?	BigNumber

Promise<ResultSet<HeldNfts>>

uses the middlewareV2

supports pagination

getHistoricalInstructions(filter?): Promise<ResultSet<HistoricInstruction>>

Defined in: api/entities/Identity/index.ts:1002

Retrieve all Instructions that have been associated with this Identity's DID

Parameter	Type
filter?	Omit<HistoricalInstructionFilters, "identity">

Promise<ResultSet<HistoricInstruction>>

uses the middleware V2

supports pagination

getInstructions(): Promise<GroupedInstructions>

Defined in: api/entities/Identity/index.ts:570

Retrieve all Instructions where this Identity is either the custodian of one or more portfolios in the legs or owns one or more accounts in the legs, grouped by status

Promise<GroupedInstructions>

getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

Defined in: api/entities/Identity/index.ts:683

Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status

Promise<GroupedInvolvedInstructions>

getMultiSigSigners(): Promise<MultiSigSigners[]>

Defined in: api/entities/Identity/index.ts:1125

Returns the list of MultiSig accounts along with their signatories this identity has responsibility for. The roles possible are:

• Admin: The identity is able to unilaterally modify the MultiSig properties, such as the signers and signatures required for a proposal
• Payer: The identity's primary key will be deducted any POLYX fees the MultiSig may incur

Promise<MultiSigSigners[]>

this query can be potentially SLOW depending on the number of MultiSigs present on the chain

getOffChainAuthorizationNonce(): Promise<BigNumber>

Defined in: api/entities/Identity/index.ts:1203

Returns the off chain authorization nonce for this Identity

Promise<BigNumber>

getPendingDistributions(): Promise<DistributionWithDetails[]>

Defined in: api/entities/Identity/index.ts:806

Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid

Promise<DistributionWithDetails[]>

uses the middleware

this query can be potentially SLOW depending on which Assets this Identity has held

getPrimaryAccount(): Promise<PermissionedAccount>

Defined in: api/entities/Identity/index.ts:320

Retrieve the primary Account associated with the Identity

Promise<PermissionedAccount>

Promise that resolves to the primary Account information

getPrimaryAccount(callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:331

Retrieve the primary Account associated with the Identity (with subscription support)

Parameter	Type	Description
callback	SubCallback<PermissionedAccount>	Callback function that receives primary Account updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>

Defined in: api/entities/Identity/index.ts:865

Get the list of secondary Accounts related to the Identity

Parameter	Type	Description
paginationOpts?	PaginationOptions	Options for pagination

Promise<ResultSet<PermissionedAccount>>

Promise that resolves to a paginated result of secondary accounts

supports pagination

getSecondaryAccounts(callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:878

Get the list of secondary Accounts related to the Identity (with subscription support)

Parameter	Type	Description
callback	SubCallback<PermissionedAccount[]>	Callback function that receives secondary account updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Defined in: api/entities/Identity/index.ts:893

Get the list of secondary Accounts related to the Identity (with pagination and subscription support)

Parameter	Type	Description
paginationOpts	PaginationOptions	Options for pagination
callback	SubCallback<PermissionedAccount[]>	Callback function that receives secondary account updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

supports pagination

can be subscribed to, if connected to node using a web socket

getTrustingAssets(): Promise<FungibleAsset[]>

Defined in: api/entities/Identity/index.ts:523

Get the list of Assets for which this Identity is a trusted claim issuer

Promise<FungibleAsset[]>

uses the middlewareV2

getVenues(): Promise<Venue[]>

Defined in: api/entities/Identity/index.ts:542

Retrieve all Venues created by this Identity

Promise<Venue[]>

hasRole(role): Promise<boolean>

Defined in: api/entities/Identity/index.ts:150

Check whether this Identity possesses the specified Role

Parameter	Type
role	Role

Promise<boolean>

isAssetPreApproved(asset): Promise<boolean>

Defined in: api/entities/Identity/index.ts:1064

Returns whether or not this Identity has pre-approved a particular asset

Parameter	Type
asset	string | BaseAsset

Promise<boolean>

isDidRegistrar(): Promise<boolean>

Defined in: api/entities/Identity/index.ts:303

Check whether this Identity is a DID Registrar

Promise<boolean>

isEqual(entity): boolean

Defined in: api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

isGcMember(): Promise<boolean>

Defined in: api/entities/Identity/index.ts:286

Check whether this Identity is Governance Committee member

Promise<boolean>

isMandatoryReceiverAffirmationEnabled(): Promise<boolean>

Defined in: api/entities/Identity/index.ts:1089

Returns whether or not this Identity has opted in to mandatory receiver affirmation. When true, the identity must explicitly affirm incoming asset transfer in settlements unless an asset level or portfolio level exemption applies.

Promise<boolean>

preApprovedAssets(paginationOpts?): Promise<ResultSet<Asset>>

Defined in: api/entities/Identity/index.ts:1030

Returns a list of all assets this Identity has pre-approved. These assets will not require affirmation when being received in settlements

Parameter	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<Asset>>

setMandatoryReceiverAffirmation(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Identity/index.ts:1112

Enable or disable mandatory receiver affirmation for incoming settlement transfers. When enabled (ReceiverAffirmationRequirement.Required), the signing identity must explicitly affirm any incoming asset transfer unless an asset level or portfolio level exemption applies. When disabled (ReceiverAffirmationRequirement.Automatic), all incoming transfers are auto-affirmed.

Parameter	Type
args	{ requirement: ReceiverAffirmationRequirement; }
args.requirement	ReceiverAffirmationRequirement
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type ProcedureMethod, which means you can call setMandatoryReceiverAffirmation.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

toHuman(): string

Defined in: api/entities/Identity/index.ts:991

Return the Identity's DID

string

Entity.toHuman

static generateUuid<Identifiers>(identifiers): string

Defined in: api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

Entity.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

Defined in: api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

Defined in: api/entities/Identity/index.ts:96

Properties that uniquely identify an Identity

did: string

Defined in: api/entities/Identity/index.ts:97