> 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-v8/classes/agent.md).

# Agent

Represents an agent for a Security Token

## Hierarchy

↳ [Identity](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)

↳ **Agent**

## Index

### Properties

* [authorizations](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#authorizations)
* [context](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#protected-context)
* [did](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#did)
* [portfolios](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#portfolios)
* [ticker](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#ticker)
* [uuid](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#uuid)

### Methods

* [areSecondaryKeysFrozen](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#aresecondarykeysfrozen)
* [getHeldTokens](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getheldtokens)
* [getInstructions](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getinstructions)
* [getPendingDistributions](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getpendingdistributions)
* [getPendingInstructions](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getpendinginstructions)
* [getPermissionGroup](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getpermissiongroup)
* [getPrimaryKey](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getprimarykey)
* [getScopeId](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getscopeid)
* [getSecondaryKeys](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getsecondarykeys)
* [getTokenBalance](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#gettokenbalance)
* [getTrustingTokens](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#gettrustingtokens)
* [getVenues](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#getvenues)
* [hasRole](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#hasrole)
* [hasRoles](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#hasroles)
* [hasTokenPermissions](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#hastokenpermissions)
* [hasValidCdd](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#hasvalidcdd)
* [isCddProvider](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#iscddprovider)
* [isEqual](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#isequal)
* [isGcMember](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#isgcmember)
* [toJson](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v8/classes/agent.md#static-unserialize)

## Properties

### authorizations

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*authorizations*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#authorizations)

*Defined in* [*src/api/entities/Identity/index.ts:96*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L96)

### `Protected` context

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

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

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

### did

• **did**: *string*

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*did*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#did)

*Defined in* [*src/api/entities/Identity/index.ts:93*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L93)

identity ID as stored in the blockchain

### portfolios

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*portfolios*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#portfolios)

*Defined in* [*src/api/entities/Identity/index.ts:97*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L97)

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/Agent.ts:37*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Agent.ts#L37)

ticker of the Security Token

### uuid

• **uuid**: *string*

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

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

## Methods

### areSecondaryKeysFrozen

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*areSecondaryKeysFrozen*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#aresecondarykeysfrozen)

*Defined in* [*src/api/entities/Identity/index.ts:667*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L667)

Check whether secondary keys are frozen

**`note`** can be subscribed to

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

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*areSecondaryKeysFrozen*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#aresecondarykeysfrozen)

*Defined in* [*src/api/entities/Identity/index.ts:668*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L668)

**Parameters:**

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

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

### getHeldTokens

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getHeldTokens*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getheldtokens)

*Defined in* [*src/api/entities/Identity/index.ts:419*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L419)

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-v8/interfaces/resultset.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v8/classes/securitytoken.md)*››*

### getInstructions

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getInstructions*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getinstructions)

*Defined in* [*src/api/entities/Identity/index.ts:543*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L543)

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

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

### getPendingDistributions

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getPendingDistributions*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getpendingdistributions)

*Defined in* [*src/api/entities/Identity/index.ts:703*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L703)

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-v8/interfaces/distributionwithdetails.md)*\[]›*

### getPendingInstructions

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getPendingInstructions*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getpendinginstructions)

*Defined in* [*src/api/entities/Identity/index.ts:616*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L616)

Retrieve all pending Instructions involving this Identity

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

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

### getPermissionGroup

▸ **getPermissionGroup**(): *Promise‹*[*CustomPermissionGroup*](/polymesh-sdk-api-reference/docs-v8/classes/custompermissiongroup.md) *|* [*KnownPermissionGroup*](/polymesh-sdk-api-reference/docs-v8/classes/knownpermissiongroup.md)*›*

*Defined in* [*src/api/entities/Agent.ts:53*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Agent.ts#L53)

Retrieve the agent group associated with this Agent

**Returns:** *Promise‹*[*CustomPermissionGroup*](/polymesh-sdk-api-reference/docs-v8/classes/custompermissiongroup.md) *|* [*KnownPermissionGroup*](/polymesh-sdk-api-reference/docs-v8/classes/knownpermissiongroup.md)*›*

### getPrimaryKey

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getPrimaryKey*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getprimarykey)

*Defined in* [*src/api/entities/Identity/index.ts:384*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L384)

Retrieve the primary key associated with the Identity

**`note`** can be subscribed to

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

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getPrimaryKey*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getprimarykey)

*Defined in* [*src/api/entities/Identity/index.ts:385*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L385)

**Parameters:**

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

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

### getScopeId

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getScopeId*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getscopeid)

*Defined in* [*src/api/entities/Identity/index.ts:525*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L525)

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-v8/classes/securitytoken.md) \| string |

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

### getSecondaryKeys

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getSecondaryKeys*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getsecondarykeys)

*Defined in* [*src/api/entities/Identity/index.ts:755*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L755)

Get the list of secondary keys related to the Identity

**`note`** can be subscribed to

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

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getSecondaryKeys*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getsecondarykeys)

*Defined in* [*src/api/entities/Identity/index.ts:756*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L756)

**Parameters:**

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

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

### getTokenBalance

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getTokenBalance*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#gettokenbalance)

*Defined in* [*src/api/entities/Identity/index.ts:284*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L284)

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-v8/globals.md#subcallback)‹BigNumber›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v8/globals.md#unsubcallback)*›*

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getTokenBalance*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#gettokenbalance)

*Defined in* [*src/api/entities/Identity/index.ts:285*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L285)

**Parameters:**

▪ **args**: *object*

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

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

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

### getTrustingTokens

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getTrustingTokens*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#gettrustingtokens)

*Defined in* [*src/api/entities/Identity/index.ts:470*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L470)

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-v8/classes/securitytoken.md)*\[]›*

### getVenues

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getVenues*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getvenues)

*Defined in* [*src/api/entities/Identity/index.ts:491*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L491)

Retrieve all Venues created by this Identity

**`note`** can be subscribed to

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

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*getVenues*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#getvenues)

*Defined in* [*src/api/entities/Identity/index.ts:492*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L492)

**Parameters:**

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

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

### hasRole

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*hasRole*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#hasrole)

*Defined in* [*src/api/entities/Identity/index.ts:238*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L238)

Check whether this Identity possesses the specified Role

**Parameters:**

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

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

### hasRoles

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*hasRoles*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#hasroles)

*Defined in* [*src/api/entities/Identity/index.ts:459*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L459)

Check whether this Identity possesses all specified roles

**Parameters:**

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

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

### hasTokenPermissions

▸ **hasTokenPermissions**(`args`: object): *Promise‹boolean›*

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*hasTokenPermissions*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#hastokenpermissions)

*Defined in* [*src/api/entities/Identity/index.ts:115*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L115)

Check whether this Identity has specific transaction Permissions over a Security Token

**Parameters:**

▪ **args**: *object*

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

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

### hasValidCdd

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*hasValidCdd*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#hasvalidcdd)

*Defined in* [*src/api/entities/Identity/index.ts:332*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L332)

Check whether this Identity has a valid CDD claim

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

### isCddProvider

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*isCddProvider*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#iscddprovider)

*Defined in* [*src/api/entities/Identity/index.ts:365*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L365)

Check whether this Identity is a CDD provider

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

### isEqual

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

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

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/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-v8/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### isGcMember

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*isGcMember*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#isgcmember)

*Defined in* [*src/api/entities/Identity/index.ts:348*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L348)

Check whether this Identity is Governance Committee member

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

### toJson

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

*Inherited from* [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md#tojson)

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

*Defined in* [*src/api/entities/Identity/index.ts:790*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Identity/index.ts#L790)

Return the Identity's DID

**Returns:** *string*

### `Static` generateUuid

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

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

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/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-v8/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/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*