# Identity

Represents an Identity in the Polymesh blockchain

## Hierarchy

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

  ↳ **Identity**

  ↳ [DefaultTrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/defaulttrustedclaimissuer)

## Index

### Constructors

* [constructor](#constructor)

### Properties

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

### Methods

* [areSecondaryAccountsFrozen](#aresecondaryaccountsfrozen)
* [checkRoles](#checkroles)
* [exists](#exists)
* [getAssetBalance](#getassetbalance)
* [getHeldAssets](#getheldassets)
* [getHeldAssetsV2](#getheldassetsv2)
* [getInstructions](#getinstructions)
* [getPendingDistributions](#getpendingdistributions)
* [getPendingInstructions](#getpendinginstructions)
* [getPrimaryAccount](#getprimaryaccount)
* [getScopeId](#getscopeid)
* [getSecondaryAccounts](#getsecondaryaccounts)
* [getTrustingAssets](#gettrustingassets)
* [getTrustingAssetsV2](#gettrustingassetsv2)
* [getVenues](#getvenues)
* [hasRole](#hasrole)
* [hasRoles](#hasroles)
* [hasValidCdd](#hasvalidcdd)
* [isCddProvider](#iscddprovider)
* [isEqual](#isequal)
* [isGcMember](#isgcmember)
* [toHuman](#tohuman)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Constructors

### constructor

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

*Overrides void*

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

Create an Identity entity

**Parameters:**

| Name          | Type              |
| ------------- | ----------------- |
| `identifiers` | UniqueIdentifiers |
| `context`     | Context           |

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

## Properties

### assetPermissions

• **assetPermissions**: [*AssetPermissions*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/assetpermissions)

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

***

### authorizations

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

*Defined in* [*src/api/entities/Identity/index.ts:94*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L94)

***

### `Protected` context

• **context**: *Context*

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

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

***

### did

• **did**: *string*

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

Identity ID as stored in the blockchain

***

### portfolios

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

*Defined in* [*src/api/entities/Identity/index.ts:95*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L95)

***

### uuid

• **uuid**: *string*

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

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

## Methods

### areSecondaryAccountsFrozen

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

*Defined in* [*src/api/entities/Identity/index.ts:649*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L649)

Check whether secondary Accounts are frozen

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/Identity/index.ts:650*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L650)

**Parameters:**

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

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

***

### checkRoles

▸ **checkRoles**(`roles`: [Role](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#role)\[]): *Promise‹*[*CheckRolesResult*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/checkrolesresult.md)*›*

*Defined in* [*src/api/entities/Identity/index.ts:398*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L398)

Check whether this Identity possesses all specified roles

**Parameters:**

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

**Returns:** *Promise‹*[*CheckRolesResult*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/checkrolesresult.md)*›*

***

### exists

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

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/entity)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/entity#abstract-exists)

*Defined in* [*src/api/entities/Identity/index.ts:779*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L779)

Determine whether this Identity exists on chain

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

***

### getAssetBalance

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

*Defined in* [*src/api/entities/Identity/index.ts:163*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L163)

Retrieve the balance of a particular Asset

**`note`** can be subscribed to

**Parameters:**

▪ **args**: *object*

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

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

▸ **getAssetBalance**(`args`: object, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#subcallback)‹BigNumber›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:164*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L164)

**Parameters:**

▪ **args**: *object*

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

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

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

***

### getHeldAssets

▸ **getHeldAssets**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*››*

*Defined in* [*src/api/entities/Identity/index.ts:311*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L311)

Retrieve a list of all Assets 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?`  | BigNumber |
| `start?` | BigNumber |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*››*

***

### getHeldAssetsV2

▸ **getHeldAssetsV2**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*››*

*Defined in* [*src/api/entities/Identity/index.ts:356*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L356)

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

**`note`** uses the middlewareV2

**`note`** supports pagination

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name     | Type                |
| -------- | ------------------- |
| `order?` | AssetHoldersOrderBy |
| `size?`  | BigNumber           |
| `start?` | BigNumber           |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*››*

***

### getInstructions

▸ **getInstructions**(): *Promise‹*[*GroupedInstructions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/groupedinstructions.md)*›*

*Defined in* [*src/api/entities/Identity/index.ts:527*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L527)

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

**Returns:** *Promise‹*[*GroupedInstructions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/groupedinstructions.md)*›*

***

### getPendingDistributions

▸ **getPendingDistributions**(): *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionwithdetails.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:686*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L686)

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 Assets this Identity has held

**Returns:** *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionwithdetails.md)*\[]›*

***

### getPendingInstructions

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

*Defined in* [*src/api/entities/Identity/index.ts:596*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L596)

Retrieve all pending Instructions involving this Identity

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

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

***

### getPrimaryAccount

▸ **getPrimaryAccount**(): *Promise‹*[*PermissionedAccount*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)*›*

*Defined in* [*src/api/entities/Identity/index.ts:264*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L264)

Retrieve the primary Account associated with the Identity

**`note`** can be subscribed to

**Returns:** *Promise‹*[*PermissionedAccount*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)*›*

▸ **getPrimaryAccount**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#subcallback)‹[PermissionedAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:265*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L265)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                                      |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#subcallback)‹[PermissionedAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)› |

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

***

### getScopeId

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

*Defined in* [*src/api/entities/Identity/index.ts:505*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L505)

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none

**`note`** more on Investor Uniqueness [here](https://developers.polymesh.network/introduction/identity#polymesh-unique-identity-system-puis) and [here](https://developers.polymesh.network/polymesh-docs/primitives/confidential-identity)

**Parameters:**

▪ **args**: *object*

| Name    | Type                                                                                                      |
| ------- | --------------------------------------------------------------------------------------------------------- |
| `asset` | [Asset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset) \| string |

**Returns:** *Promise‹string | null›*

***

### getSecondaryAccounts

▸ **getSecondaryAccounts**(): *Promise‹*[*PermissionedAccount*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:740*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L740)

Get the list of secondary Accounts related to the Identity

**`note`** can be subscribed to

**Returns:** *Promise‹*[*PermissionedAccount*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)*\[]›*

▸ **getSecondaryAccounts**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#subcallback)‹[PermissionedAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)\[]›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#unsubcallback)*›*

*Defined in* [*src/api/entities/Identity/index.ts:741*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L741)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                                         |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#subcallback)‹[PermissionedAccount](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/permissionedaccount.md)\[]› |

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

***

### getTrustingAssets

▸ **getTrustingAssets**(): *Promise‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:433*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L433)

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

**`note`** uses the middleware

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

***

### getTrustingAssetsV2

▸ **getTrustingAssetsV2**(): *Promise‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/asset)*\[]›*

*Defined in* [*src/api/entities/Identity/index.ts:450*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L450)

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

**`note`** uses the middlewareV2

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

***

### getVenues

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

*Defined in* [*src/api/entities/Identity/index.ts:469*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L469)

Retrieve all Venues created by this Identity

**`note`** can be subscribed to

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

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

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

**Parameters:**

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

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

***

### hasRole

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

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

Check whether this Identity possesses the specified Role

**Parameters:**

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

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

***

### hasRoles

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

*Defined in* [*src/api/entities/Identity/index.ts:422*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L422)

Check whether this Identity possesses all specified roles

**`deprecated`** in favor of `checkRoles`

**Parameters:**

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

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

***

### hasValidCdd

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

*Defined in* [*src/api/entities/Identity/index.ts:212*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L212)

Check whether this Identity has a valid CDD claim

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

***

### isCddProvider

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

*Defined in* [*src/api/entities/Identity/index.ts:245*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L245)

Check whether this Identity is a CDD provider

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

***

### isEqual

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

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

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

Determine whether this Entity is the same as another one

**Parameters:**

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

**Returns:** *boolean*

***

### isGcMember

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

*Defined in* [*src/api/entities/Identity/index.ts:228*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L228)

Check whether this Identity is Governance Committee member

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

***

### toHuman

▸ **toHuman**(): *string*

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/entity)*.*[*toHuman*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/entity#abstract-tohuman)

*Defined in* [*src/api/entities/Identity/index.ts:792*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/index.ts#L792)

Return the Identity's DID

**Returns:** *string*

***

### `Static` generateUuid

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

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

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

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