# Identity

Represents an Identity in the Polymesh blockchain

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹UniqueIdentifiers›

  ↳ **Identity**

  ↳ [CurrentIdentity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/currentidentity)

## Index

### Constructors

* [constructor](#constructor)

### Properties

* [authorizations](#authorizations)
* [context](#protected-context)
* [did](#did)
* [portfolios](#portfolios)
* [uuid](#uuid)

### Methods

* [areSecondaryKeysFrozen](#aresecondarykeysfrozen)
* [getHeldTokens](#getheldtokens)
* [getPendingInstructions](#getpendinginstructions)
* [getPrimaryKey](#getprimarykey)
* [getScopeId](#getscopeid)
* [getTokenBalance](#gettokenbalance)
* [getTrustingTokens](#gettrustingtokens)
* [getVenues](#getvenues)
* [hasRole](#hasrole)
* [hasRoles](#hasroles)
* [hasValidCdd](#hasvalidcdd)
* [isCddProvider](#iscddprovider)
* [isEqual](#isequal)
* [isGcMember](#isgcmember)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Constructors

### constructor

\+ **new Identity**(`identifiers`: UniqueIdentifiers, `context`: [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/context)): [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)

*Overrides void*

*Defined in* [*src/api/entities/Identity/index.ts:83*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L83)

Create an Identity entity

**Parameters:**

| Name          | Type                                                                                              |
| ------------- | ------------------------------------------------------------------------------------------------- |
| `identifiers` | UniqueIdentifiers                                                                                 |
| `context`     | [Context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/context) |

**Returns:** [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)

## Properties

### authorizations

• **authorizations**: [*IdentityAuthorizations*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identityauthorizations)

*Defined in* [*src/api/entities/Identity/index.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L82)

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/context)

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#protected-context)

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

### did

• **did**: *string*

*Defined in* [*src/api/entities/Identity/index.ts:79*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L79)

identity ID as stored in the blockchain

### portfolios

• **portfolios**: [*Portfolios*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/portfolios)

*Defined in* [*src/api/entities/Identity/index.ts:83*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L83)

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#uuid)

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

## Methods

### areSecondaryKeysFrozen

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

*Defined in* [*src/api/entities/Identity/index.ts:480*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L480)

Check whether secondary keys are frozen

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/Identity/index.ts:481*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L481)

**Parameters:**

| Name       | Type                                                                                                               |
| ---------- | ------------------------------------------------------------------------------------------------------------------ |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹boolean› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

### getHeldTokens

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

*Defined in* [*src/api/entities/Identity/index.ts:306*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L306)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/resultset)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*››*

### getPendingInstructions

▸ **getPendingInstructions**(): *Promise‹*[*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/instruction)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:429*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L429)

Retrieve all pending Instructions involving this Identity

**Returns:** *Promise‹*[*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/instruction)*\[]›*

### getPrimaryKey

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

*Defined in* [*src/api/entities/Identity/index.ts:271*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L271)

Retrieve the primary key associated with the Identity

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/Identity/index.ts:272*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L272)

**Parameters:**

| Name       | Type                                                                                                              |
| ---------- | ----------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹string› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

### getScopeId

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

*Defined in* [*src/api/entities/Identity/index.ts:412*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L412)

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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken) \| string |

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

### getTokenBalance

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

*Defined in* [*src/api/entities/Identity/index.ts:171*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L171)

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

*Defined in* [*src/api/entities/Identity/index.ts:172*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L172)

**Parameters:**

▪ **args**: *object*

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

▪ **callback**: [*SubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)*‹BigNumber›*

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

### getTrustingTokens

▸ **getTrustingTokens**(`args`: object): *Promise‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:357*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L357)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*\[]›*

### getVenues

▸ **getVenues**(): *Promise‹*[*Venue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/venue)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:378*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L378)

Retrieve all Venues created by this Identity

**`note`** can be subscribed to

**Returns:** *Promise‹*[*Venue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/venue)*\[]›*

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

*Defined in* [*src/api/entities/Identity/index.ts:379*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L379)

**Parameters:**

| Name       | Type                                                                                                                                                                                                        |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/venue)\[]› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

### hasRole

▸ **hasRole**(`role`: [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#role)): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:101*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L101)

Check whether this Identity possesses the specified Role

**Parameters:**

| Name   | Type                                                                                        |
| ------ | ------------------------------------------------------------------------------------------- |
| `role` | [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#role) |

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

### hasRoles

▸ **hasRoles**(`roles`: [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#role)\[]): *Promise‹boolean›*

*Defined in* [*src/api/entities/Identity/index.ts:346*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L346)

Check whether this Identity possesses all specified roles

**Parameters:**

| Name    | Type                                                                                           |
| ------- | ---------------------------------------------------------------------------------------------- |
| `roles` | [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#role)\[] |

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

### hasValidCdd

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

*Defined in* [*src/api/entities/Identity/index.ts:219*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L219)

Check whether this Identity has a valid CDD claim

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

### isCddProvider

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

*Defined in* [*src/api/entities/Identity/index.ts:252*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L252)

Check whether this Identity is a CDD provider

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

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object›): *boolean*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#isequal)

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

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                    |
| -------- | ------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object› |

**Returns:** *boolean*

### isGcMember

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

*Defined in* [*src/api/entities/Identity/index.ts:235*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/index.ts#L235)

Check whether this Identity is Governance Committee member

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

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/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* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-unserialize)

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