> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/identity.md).

# Identity

Represents an Identity in the Polymesh blockchain

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹[UniqueIdentifiers](/polymesh-sdk-api-reference/docs-v9/interfaces/uniqueidentifiers.md), string›

  ↳ **Identity**

  ↳ [DefaultTrustedClaimIssuer](/polymesh-sdk-api-reference/docs-v9/classes/defaulttrustedclaimissuer.md)

## Index

### Constructors

* [constructor](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#constructor)

### Properties

* [authorizations](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#authorizations)
* [context](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#protected-context)
* [did](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#did)
* [portfolios](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#portfolios)
* [tokenPermissions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#tokenpermissions)
* [uuid](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#uuid)

### Methods

* [areSecondaryKeysFrozen](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#aresecondarykeysfrozen)
* [createVenue](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#createvenue)
* [freezeSecondaryKeys](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#freezesecondarykeys)
* [getHeldTokens](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getheldtokens)
* [getInstructions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getinstructions)
* [getPendingDistributions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getpendingdistributions)
* [getPendingInstructions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getpendinginstructions)
* [getPrimaryKey](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getprimarykey)
* [getScopeId](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getscopeid)
* [getSecondaryKeys](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getsecondarykeys)
* [getTokenBalance](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#gettokenbalance)
* [getTrustingTokens](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#gettrustingtokens)
* [getVenues](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#getvenues)
* [hasRole](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#hasrole)
* [hasRoles](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#hasroles)
* [hasValidCdd](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#hasvalidcdd)
* [inviteAccount](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#inviteaccount)
* [isCddProvider](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#iscddprovider)
* [isEqual](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#isequal)
* [isGcMember](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#isgcmember)
* [modifyPermissions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#modifypermissions)
* [removeSecondaryKeys](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#removesecondarykeys)
* [revokePermissions](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#revokepermissions)
* [toJson](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#tojson)
* [unfreezeSecondaryKeys](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#unfreezesecondarykeys)
* [generateUuid](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#static-unserialize)

## Constructors

### constructor

\+ **new Identity**(`identifiers`: [UniqueIdentifiers](/polymesh-sdk-api-reference/docs-v9/interfaces/uniqueidentifiers.md), `context`: [Context](/polymesh-sdk-api-reference/docs-v9/classes/context.md)): [*Identity*](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)

*Overrides void*

*Defined in* [*src/api/entities/Identity/index.ts:110*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L110)

Create an Identity entity

**Parameters:**

| Name          | Type                                                                                     |
| ------------- | ---------------------------------------------------------------------------------------- |
| `identifiers` | [UniqueIdentifiers](/polymesh-sdk-api-reference/docs-v9/interfaces/uniqueidentifiers.md) |
| `context`     | [Context](/polymesh-sdk-api-reference/docs-v9/classes/context.md)                        |

**Returns:** [*Identity*](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)

## Properties

### authorizations

• **authorizations**: [*IdentityAuthorizations*](/polymesh-sdk-api-reference/docs-v9/classes/identityauthorizations.md)

*Defined in* [*src/api/entities/Identity/index.ts:108*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L108)

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md)

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L48)

### did

• **did**: *string*

*Defined in* [*src/api/entities/Identity/index.ts:105*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L105)

identity ID as stored in the blockchain

### portfolios

• **portfolios**: [*Portfolios*](/polymesh-sdk-api-reference/docs-v9/classes/portfolios.md)

*Defined in* [*src/api/entities/Identity/index.ts:109*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L109)

### tokenPermissions

• **tokenPermissions**: [*TokenPermissions*](/polymesh-sdk-api-reference/docs-v9/classes/tokenpermissions.md)

*Defined in* [*src/api/entities/Identity/index.ts:110*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L110)

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L46)

## Methods

### areSecondaryKeysFrozen

▸ **areSecondaryKeysFrozen**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:682*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L682)

Check whether secondary keys are frozen

**`note`** can be subscribed to

**Returns:** *Promise‹boolean›*

▸ **areSecondaryKeysFrozen**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹boolean›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:683*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L683)

**Parameters:**

| Name       | Type                                                                               |
| ---------- | ---------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹boolean› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

### createVenue

▸ **createVenue**(`args`: [CreateVenueParams](/polymesh-sdk-api-reference/docs-v9/interfaces/createvenueparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*Venue*](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)*››*

*Defined in* [*src/api/entities/Identity/index.ts:224*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L224)

Create a Venue

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `createVenue.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                     |
| ------- | ---------------------------------------------------------------------------------------- |
| `args`  | [CreateVenueParams](/polymesh-sdk-api-reference/docs-v9/interfaces/createvenueparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)         |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*Venue*](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)*››*

### freezeSecondaryKeys

▸ **freezeSecondaryKeys**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:234*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L234)

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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md#unfreezesecondarykeys)

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `freezeSecondaryKeys.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                             |
| ------- | -------------------------------------------------------------------------------- |
| `args`  | void                                                                             |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### getHeldTokens

▸ **getHeldTokens**(`opts`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/Identity/index.ts:434*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L434)

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 |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*››*

### getInstructions

▸ **getInstructions**(): *Promise‹*[*GroupedInstructions*](/polymesh-sdk-api-reference/docs-v9/interfaces/groupedinstructions.md)*›*

*Defined in* [*src/api/entities/Identity/index.ts:558*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L558)

Retrieve all Instructions where this Identity is a participant, grouped by status

**Returns:** *Promise‹*[*GroupedInstructions*](/polymesh-sdk-api-reference/docs-v9/interfaces/groupedinstructions.md)*›*

### getPendingDistributions

▸ **getPendingDistributions**(): *Promise‹*[*DistributionWithDetails*](/polymesh-sdk-api-reference/docs-v9/interfaces/distributionwithdetails.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:718*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L718)

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*](/polymesh-sdk-api-reference/docs-v9/interfaces/distributionwithdetails.md)*\[]›*

### getPendingInstructions

▸ **getPendingInstructions**(): *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v9/classes/instruction.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:631*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L631)

Retrieve all pending Instructions involving this Identity

**`deprecated`** in favor of `getInstructions`

**Returns:** *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v9/classes/instruction.md)*\[]›*

### getPrimaryKey

▸ **getPrimaryKey**(): *Promise‹string›*

*Defined in* [*src/api/entities/Identity/index.ts:399*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L399)

Retrieve the primary key associated with the Identity

**`note`** can be subscribed to

**Returns:** *Promise‹string›*

▸ **getPrimaryKey**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹string›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:400*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L400)

**Parameters:**

| Name       | Type                                                                              |
| ---------- | --------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹string› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

### getScopeId

▸ **getScopeId**(`args`: object): *Promise‹string›*

*Defined in* [*src/api/entities/Identity/index.ts:540*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L540)

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*

| Name    | Type                                                                                    |
| ------- | --------------------------------------------------------------------------------------- |
| `token` | [SecurityToken](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md) \| string |

**Returns:** *Promise‹string›*

### getSecondaryKeys

▸ **getSecondaryKeys**(): *Promise‹*[*SecondaryKey*](/polymesh-sdk-api-reference/docs-v9/interfaces/secondarykey.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:770*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L770)

Get the list of secondary keys related to the Identity

**`note`** can be subscribed to

**Returns:** *Promise‹*[*SecondaryKey*](/polymesh-sdk-api-reference/docs-v9/interfaces/secondarykey.md)*\[]›*

▸ **getSecondaryKeys**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[SecondaryKey](/polymesh-sdk-api-reference/docs-v9/interfaces/secondarykey.md)\[]›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:771*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L771)

**Parameters:**

| Name       | Type                                                                                                                                                         |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[SecondaryKey](/polymesh-sdk-api-reference/docs-v9/interfaces/secondarykey.md)\[]› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

### getTokenBalance

▸ **getTokenBalance**(`args`: object): *Promise‹BigNumber›*

*Defined in* [*src/api/entities/Identity/index.ts:299*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L299)

Retrieve the balance of a particular Security Token

**`note`** can be subscribed to

**Parameters:**

▪ **args**: *object*

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

**Returns:** *Promise‹BigNumber›*

▸ **getTokenBalance**(`args`: object, `callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹BigNumber›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:300*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L300)

**Parameters:**

▪ **args**: *object*

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

▪ **callback**: [*SubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)*‹BigNumber›*

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

### getTrustingTokens

▸ **getTrustingTokens**(`args`: object): *Promise‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:485*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L485)

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 |

**Returns:** *Promise‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*\[]›*

### getVenues

▸ **getVenues**(): *Promise‹*[*Venue*](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:506*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L506)

Retrieve all Venues created by this Identity

**`note`** can be subscribed to

**Returns:** *Promise‹*[*Venue*](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)*\[]›*

▸ **getVenues**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[Venue](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)\[]›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:507*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L507)

**Parameters:**

| Name       | Type                                                                                                                                        |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[Venue](/polymesh-sdk-api-reference/docs-v9/classes/venue.md)\[]› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›*

### hasRole

▸ **hasRole**(`role`: [Role](/polymesh-sdk-api-reference/docs-v9/globals.md#role)): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:251*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L251)

Check whether this Identity possesses the specified Role

**Parameters:**

| Name   | Type                                                        |
| ------ | ----------------------------------------------------------- |
| `role` | [Role](/polymesh-sdk-api-reference/docs-v9/globals.md#role) |

**Returns:** *Promise‹boolean›*

### hasRoles

▸ **hasRoles**(`roles`: [Role](/polymesh-sdk-api-reference/docs-v9/globals.md#role)\[]): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:474*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L474)

Check whether this Identity possesses all specified roles

**Parameters:**

| Name    | Type                                                           |
| ------- | -------------------------------------------------------------- |
| `roles` | [Role](/polymesh-sdk-api-reference/docs-v9/globals.md#role)\[] |

**Returns:** *Promise‹boolean›*

### hasValidCdd

▸ **hasValidCdd**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:347*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L347)

Check whether this Identity has a valid CDD claim

**Returns:** *Promise‹boolean›*

### inviteAccount

▸ **inviteAccount**(`args`: [InviteAccountParams](/polymesh-sdk-api-reference/docs-v9/interfaces/inviteaccountparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L214)

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](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `inviteAccount.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                         |
| ------- | -------------------------------------------------------------------------------------------- |
| `args`  | [InviteAccountParams](/polymesh-sdk-api-reference/docs-v9/interfaces/inviteaccountparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)             |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### isCddProvider

▸ **isCddProvider**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:380*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L380)

Check whether this Identity is a CDD provider

**Returns:** *Promise‹boolean›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                              |
| -------- | --------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### isGcMember

▸ **isGcMember**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:363*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L363)

Check whether this Identity is Governance Committee member

**Returns:** *Promise‹boolean›*

### modifyPermissions

▸ **modifyPermissions**(`args`: [ModifySignerPermissionsParams](/polymesh-sdk-api-reference/docs-v9/interfaces/modifysignerpermissionsparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:200*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L200)

Modify all permissions of a list of secondary keys associated with the Identity

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `modifyPermissions.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                             |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| `args`  | [ModifySignerPermissionsParams](/polymesh-sdk-api-reference/docs-v9/interfaces/modifysignerpermissionsparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)                                 |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### removeSecondaryKeys

▸ **removeSecondaryKeys**(`args`: [RemoveSecondaryKeysParams](/polymesh-sdk-api-reference/docs-v9/interfaces/removesecondarykeysparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:180*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L180)

Remove a list of secondary keys associated with the Identity

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `removeSecondaryKeys.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                     |
| ------- | -------------------------------------------------------------------------------------------------------- |
| `args`  | [RemoveSecondaryKeysParams](/polymesh-sdk-api-reference/docs-v9/interfaces/removesecondarykeysparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### revokePermissions

▸ **revokePermissions**(`args`: object, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:190*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L190)

Revoke all permissions of a list of secondary keys associated with the Identity

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), 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*

| Name            | Type                                                               |
| --------------- | ------------------------------------------------------------------ |
| `secondaryKeys` | [Signer](/polymesh-sdk-api-reference/docs-v9/globals.md#signer)\[] |

▪`Optional` **opts**: [*ProcedureOpts*](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### toJson

▸ **toJson**(): *string*

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/Identity/index.ts:805*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L805)

Return the Identity's DID

**Returns:** *string*

### unfreezeSecondaryKeys

▸ **unfreezeSecondaryKeys**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/index.ts:244*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/index.ts#L244)

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](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `unfreezeSecondaryKeys.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                             |
| ------- | -------------------------------------------------------------------------------- |
| `args`  | void                                                                             |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*