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

Defined in: api/entities/Identity/ChildIdentity.ts:13

Represents a child identity

child identities are no longer supported in chain v8

• Identity

assetPermissions: AssetPermissions

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

Identity.assetPermissions

authorizations: IdentityAuthorizations

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

Identity.authorizations

did: string

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

Identity ID as stored in the blockchain

Identity.did

portfolios: Portfolios

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

Identity.portfolios

uuid: string

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

Identity.uuid

areSecondaryAccountsFrozen(): Promise<boolean>

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

Check whether secondary Accounts are frozen

Promise<boolean>

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

Identity.areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

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

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

Identity.areSecondaryAccountsFrozen

checkRoles(roles): Promise<CheckRolesResult>

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

Check whether this Identity possesses all specified roles

Parameter	Type
roles	Role[]

Promise<CheckRolesResult>

Identity.checkRoles

exists(): Promise<boolean>

Defined in: api/entities/Identity/ChildIdentity.ts:80

Determine whether this child Identity exists

Promise<boolean>

asset Identities aren't considered to exist for this check

Identity.exists

getAssetBalance(args): Promise<BigNumber>

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

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

Identity.getAssetBalance

getAssetBalance(args): Promise<BigNumber>

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

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

Identity.getAssetBalance

getAssetBalance(args, callback): Promise<UnsubCallback>

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

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

Identity.getAssetBalance

getAssetBalance(args, callback): Promise<UnsubCallback>

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

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

Identity.getAssetBalance

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

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

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

Identity.getHeldAssets

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

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

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

Identity.getHeldNfts

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

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

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

Identity.getHistoricalInstructions

getInstructions(): Promise<GroupedInstructions>

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

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>

Identity.getInstructions

getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

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

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

Promise<GroupedInvolvedInstructions>

Identity.getInvolvedInstructions

getMultiSigSigners(): Promise<MultiSigSigners[]>

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

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

Identity.getMultiSigSigners

getOffChainAuthorizationNonce(): Promise<BigNumber>

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

Returns the off chain authorization nonce for this Identity

Promise<BigNumber>

Identity.getOffChainAuthorizationNonce

getParentDid(): Promise<Identity | null>

Defined in: api/entities/Identity/ChildIdentity.ts:34

Returns the parent of this Identity (if any)

Promise<Identity | null>

getPendingDistributions(): Promise<DistributionWithDetails[]>

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

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

Identity.getPendingDistributions

getPrimaryAccount(): Promise<PermissionedAccount>

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

Retrieve the primary Account associated with the Identity

Promise<PermissionedAccount>

Promise that resolves to the primary Account information

Identity.getPrimaryAccount

getPrimaryAccount(callback): Promise<UnsubCallback>

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

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

Identity.getPrimaryAccount

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

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

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

Identity.getSecondaryAccounts

getSecondaryAccounts(callback): Promise<UnsubCallback>

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

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

Identity.getSecondaryAccounts

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

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

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

Identity.getSecondaryAccounts

getTrustingAssets(): Promise<FungibleAsset[]>

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

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

Promise<FungibleAsset[]>

uses the middlewareV2

Identity.getTrustingAssets

getVenues(): Promise<Venue[]>

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

Retrieve all Venues created by this Identity

Promise<Venue[]>

Identity.getVenues

hasRole(role): Promise<boolean>

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

Check whether this Identity possesses the specified Role

Parameter	Type
role	Role

Promise<boolean>

Identity.hasRole

hasValidCdd(): Promise<boolean>

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

Check whether this Identity has a valid CDD claim

Promise<boolean>

CDD claims are discontinued from chain v8. If invoked with a v8 chain, this returns true if DID exists

Identity.hasValidCdd

isAssetPreApproved(asset): Promise<boolean>

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

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

Parameter	Type
asset	string | BaseAsset

Promise<boolean>

Identity.isAssetPreApproved

isCddProvider(): Promise<boolean>

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

Check whether this Identity is a CDD provider

Promise<boolean>

Identity.isCddProvider

isChild(): Promise<boolean>

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

Check whether this Identity is a child Identity

Promise<boolean>

Identity.isChild

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

Identity.isEqual

isGcMember(): Promise<boolean>

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

Check whether this Identity is Governance Committee member

Promise<boolean>

Identity.isGcMember

isMandatoryReceiverAffirmationEnabled(): Promise<boolean>

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

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>

Identity.isMandatoryReceiverAffirmationEnabled

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

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

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>>

Identity.preApprovedAssets

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

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

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

Identity.setMandatoryReceiverAffirmation

toHuman(): string

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

Return the Identity's DID

string

Identity.toHuman

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

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

Unlinks a child identity

Parameter	Type
args	UnlinkChildParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

if

• the child is not a child of this identity
• the transaction signer is not the primary key of the parent identity

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

Identity.unlinkChild

unlinkFromParent(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Identity/ChildIdentity.ts:95

Unlinks this child identity from its parent

Parameter	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

if

• this identity doesn't have a parent
• the transaction signer is not the primary key of the child identity

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

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

Identity.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

Identity.unserialize