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

# Entity

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

## Type parameters

▪ **UniqueIdentifiers**

▪ **HumanReadable**

## Hierarchy

* **Entity**

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

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

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

  ↳ [SecurityToken](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)

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

  ↳ [Sto](/polymesh-sdk-api-reference/docs-v9/classes/sto.md)

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

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

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

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

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

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

  ↳ [CorporateAction](/polymesh-sdk-api-reference/docs-v9/classes/corporateaction.md)

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context)
* [uuid](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid)

### Methods

* [isEqual](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal)
* [toJson](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid)
* [isUniqueIdentifiers](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-isuniqueidentifiers)
* [unserialize](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-unserialize)

## Properties

### `Protected` context

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

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

### uuid

• **uuid**: *string*

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

## Methods

### isEqual

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

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

**Returns:** *boolean*

### `Abstract` toJson

▸ **toJson**(): *HumanReadable*

*Defined in* [*src/api/entities/Entity.ts:68*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L68)

Returns Entity data in a human readable (JSON) format

**Returns:** *HumanReadable*

### `Static` generateUuid

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

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

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

*Defined in* [*src/api/entities/Entity.ts:42*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L42)

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*

### `Static` unserialize

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

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