> 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-alpha/classes/api_entities_entity.entity.md).

# api\_entities\_Entity.Entity

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / [api/entities/Entity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_entity.md) / Entity

## Class: Entity\<UniqueIdentifiers, HumanReadable>

[api/entities/Entity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_entity.md).Entity

Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality

### Type parameters

| Name                |
| ------------------- |
| `UniqueIdentifiers` |
| `HumanReadable`     |

### Hierarchy

* **`Entity`**

  ↳ [`Account`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_account.account.md)

  ↳ [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)

  ↳ [`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md)

  ↳ [`Checkpoint`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpoint.checkpoint.md)

  ↳ [`CheckpointSchedule`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpointschedule.checkpointschedule.md)

  ↳ [`CorporateActionBase`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase.md)

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

  ↳ [`Instruction`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction.md)

  ↳ [`Offering`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_offering.offering.md)

  ↳ [`PermissionGroup`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_permissiongroup.permissiongroup.md)

  ↳ [`Portfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md)

  ↳ [`Subsidy`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_subsidy.subsidy.md)

  ↳ [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md)

  ↳ [`Venue`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue.md)

### Table of contents

#### Properties

* [uuid](#uuid)

#### Methods

* [exists](#exists)
* [isEqual](#isequal)
* [toHuman](#tohuman)
* [generateUuid](#generateuuid)
* [isUniqueIdentifiers](#isuniqueidentifiers)
* [unserialize](#unserialize)

### Properties

#### uuid

• **uuid**: `string`

**Defined in**

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

### Methods

#### exists

▸ `Abstract` **exists**(): `Promise`<`boolean`>

Determine whether this Entity exists on chain

**Returns**

`Promise`<`boolean`>

**Defined in**

[api/entities/Entity.ts:68](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L68)

***

#### isEqual

▸ **isEqual**(`entity`): `boolean`

Determine whether this Entity is the same as another one

**Parameters**

| Name     | Type                                                                                                           |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| `entity` | [`Entity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md)<`unknown`, `unknown`> |

**Returns**

`boolean`

**Defined in**

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

***

#### toHuman

▸ `Abstract` **toHuman**(): `HumanReadable`

Returns Entity data in a human readable (JSON) format

**Returns**

`HumanReadable`

**Defined in**

[api/entities/Entity.ts:73](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L73)

***

#### generateUuid

▸ `Static` **generateUuid**<`Identifiers`>(`identifiers`): `string`

Generate the Entity's UUID from its identifying properties

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`string`

**Defined in**

[api/entities/Entity.ts:14](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L14)

***

#### isUniqueIdentifiers

▸ `Static` **isUniqueIdentifiers**(`identifiers`): `boolean`

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

**Parameters**

| Name          | Type      | Description          |
| ------------- | --------- | -------------------- |
| `identifiers` | `unknown` | object to type check |

**Returns**

`boolean`

**Defined in**

[api/entities/Entity.ts:42](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L42)

***

#### unserialize

▸ `Static` **unserialize**<`Identifiers`>(`serialized`): `Identifiers`

Unserialize a UUID into its Unique Identifiers

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`Identifiers`

**Defined in**

[api/entities/Entity.ts:23](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L23)