> 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-v3/classes/identity.md).

# Identity

Represents an Identity in the Polymesh blockchain

## Hierarchy

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

  ↳ **Identity**

  ↳ [CurrentIdentity](/polymesh-sdk-api-reference/docs-v3/classes/currentidentity.md)

## Index

### Constructors

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

### Properties

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

### Methods

* [getHeldTokens](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#getheldtokens)
* [getPrimaryKey](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#getprimarykey)
* [getTokenBalance](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#gettokenbalance)
* [getTrustingTokens](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#gettrustingtokens)
* [getVenues](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#getvenues)
* [hasRole](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#hasrole)
* [hasRoles](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#hasroles)
* [hasValidCdd](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#hasvalidcdd)
* [isCddProvider](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#iscddprovider)
* [isGcMember](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#isgcmember)
* [generateUuid](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v3/classes/identity.md#static-unserialize)

## Constructors

### constructor

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

*Overrides void*

*Defined in* [*src/api/entities/Identity/index.ts:73*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L73)

Create an Identity entity

**Parameters:**

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

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

## Properties

### authorizations

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

*Defined in* [*src/api/entities/Identity/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L72)

### `Protected` context

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

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

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

### did

• **did**: *string*

*Defined in* [*src/api/entities/Identity/index.ts:69*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L69)

identity ID as stored in the blockchain

### portfolios

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

*Defined in* [*src/api/entities/Identity/index.ts:73*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L73)

### uuid

• **uuid**: *string*

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

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

## Methods

### getHeldTokens

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

*Defined in* [*src/api/entities/Identity/index.ts:287*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L287)

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

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

### getPrimaryKey

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

*Defined in* [*src/api/entities/Identity/index.ts:253*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L253)

Retrieve the primary key associated with the Identity

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/Identity/index.ts:254*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L254)

**Parameters:**

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

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

### getTokenBalance

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

*Defined in* [*src/api/entities/Identity/index.ts:152*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L152)

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

*Defined in* [*src/api/entities/Identity/index.ts:153*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L153)

**Parameters:**

▪ **args**: *object*

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

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

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

### getTrustingTokens

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

*Defined in* [*src/api/entities/Identity/index.ts:338*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L338)

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

### getVenues

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

*Defined in* [*src/api/entities/Identity/index.ts:359*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L359)

Retrieve all Venues created by this Identity

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/Identity/index.ts:360*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L360)

**Parameters:**

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

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

### hasRole

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

*Defined in* [*src/api/entities/Identity/index.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L91)

Check whether this Identity possesses the specified Role

**Parameters:**

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

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

### hasRoles

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

*Defined in* [*src/api/entities/Identity/index.ts:327*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L327)

Check whether this Identity possesses all specified roles

**Parameters:**

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

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

### hasValidCdd

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

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

Check whether this Identity has a valid CDD claim

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

### isCddProvider

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

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

Check whether this Identity is a CDD provider

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

### isGcMember

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

*Defined in* [*src/api/entities/Identity/index.ts:217*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/index.ts#L217)

Check whether this Identity is Governance Committee member

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

### `Static` generateUuid

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

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

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *string*

### `Static` unserialize

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

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

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *Identifiers*