# api\_entities\_Account.Account

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/entities/Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_account) / Account

## Class: Account

[api/entities/Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_account).Account

Represents an Account in the Polymesh blockchain. Accounts can hold POLYX, control Identities and vote on proposals (among other things)

### Hierarchy

* [`Entity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity)<[`UniqueIdentifiers`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_account.uniqueidentifiers), `string`>

  ↳ **`Account`**

### Table of contents

#### Properties

* [address](#address)
* [authorizations](#authorizations)
* [key](#key)
* [uuid](#uuid)

#### Methods

* [checkPermissions](#checkpermissions)
* [exists](#exists)
* [getBalance](#getbalance)
* [getIdentity](#getidentity)
* [getPermissions](#getpermissions)
* [getSubsidy](#getsubsidy)
* [getTransactionHistory](#gettransactionhistory)
* [hasPermissions](#haspermissions)
* [isEqual](#isequal)
* [isFrozen](#isfrozen)
* [toHuman](#tohuman)
* [generateUuid](#generateuuid)
* [unserialize](#unserialize)

### Properties

#### address

• **address**: `string`

Polymesh-specific address of the Account. Serves as an identifier

**Defined in**

[api/entities/Account.ts:251](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L251)

***

#### authorizations

• **authorizations**: [`Authorizations`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_common_namespaces_authorizations.authorizations)<[`Account`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_account.account)>

**Defined in**

[api/entities/Account.ts:260](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L260)

***

#### key

• **key**: `string`

A hex representation of the cryptographic public key of the Account. This is consistent across Substrate chains, while the address depends on the chain as well.

**Defined in**

[api/entities/Account.ts:257](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L257)

***

#### uuid

• **uuid**: `string`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[uuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#uuid)

**Defined in**

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

### Methods

#### checkPermissions

▸ **checkPermissions**(`permissions`): `Promise`<[`CheckPermissionsResult`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpermissionsresult)<[`Account`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.signertype#account)>>

Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity

**Parameters**

| Name          | Type                                                                                                                                |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `permissions` | [`SimplePermissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simplepermissions) |

**Returns**

`Promise`<[`CheckPermissionsResult`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpermissionsresult)<[`Account`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.signertype#account)>>

which permissions the Account is missing (if any) and the final result

**Defined in**

[api/entities/Account.ts:531](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L531)

***

#### exists

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

Determine whether this Account exists on chain

**Returns**

`Promise`<`boolean`>

**Overrides**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[exists](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#exists)

**Defined in**

[api/entities/Account.ts:597](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L597)

***

#### getBalance

▸ **getBalance**(): `Promise`<[`Balance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance)>

Get the free/locked POLYX balance of the Account

**`note`** can be subscribed to

**Returns**

`Promise`<[`Balance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance)>

**Defined in**

[api/entities/Account.ts:282](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L282)

▸ **getBalance**(`callback`): `Promise`<[`UnsubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#unsubcallback)>

**Parameters**

| Name       | Type                                                                                                                                                                                                                                    |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [`SubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#subcallback)<[`Balance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance)> |

**Returns**

`Promise`<[`UnsubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#unsubcallback)>

**Defined in**

[api/entities/Account.ts:283](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L283)

***

#### getIdentity

▸ **getIdentity**(): `Promise`<`null` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity)>

Retrieve the Identity associated to this Account (null if there is none)

**Returns**

`Promise`<`null` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity)>

**Defined in**

[api/entities/Account.ts:323](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L323)

***

#### getPermissions

▸ **getPermissions**(): `Promise`<[`Permissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions)>

Retrieve the Permissions this Account has as a Permissioned Account for its corresponding Identity

**`throws`** if there is no Identity associated with the Account

**Returns**

`Promise`<[`Permissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions)>

**Defined in**

[api/entities/Account.ts:490](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L490)

***

#### getSubsidy

▸ **getSubsidy**(): `Promise`<`null` | [`SubsidyWithAllowance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidywithallowance)>

Get the subsidized balance of this Account and the subsidizer Account. If this Account isn't being subsidized, return null

**`note`** can be subscribed to

**Returns**

`Promise`<`null` | [`SubsidyWithAllowance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidywithallowance)>

**Defined in**

[api/entities/Account.ts:304](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L304)

▸ **getSubsidy**(`callback`): `Promise`<[`UnsubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#unsubcallback)>

**Parameters**

| Name       | Type                                                                                                                                                                                                                                                                                             |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `callback` | [`SubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#subcallback)<`null` \| [`SubsidyWithAllowance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidywithallowance)> |

**Returns**

`Promise`<[`UnsubCallback`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#unsubcallback)>

**Defined in**

[api/entities/Account.ts:305](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L305)

***

#### getTransactionHistory

▸ **getTransactionHistory**(`filters?`): `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`ExtrinsicData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdata)>>

Retrieve a list of transactions signed by this Account. Can be filtered using parameters

**`note`** if both `blockNumber` and `blockHash` are passed, only `blockNumber` is taken into account

**`note`** uses the middleware

**Parameters**

| Name                   | Type                      | Description                                   |
| ---------------------- | ------------------------- | --------------------------------------------- |
| `filters`              | `Object`                  | -                                             |
| `filters.blockHash?`   | `string`                  | -                                             |
| `filters.blockNumber?` | `BigNumber`               | -                                             |
| `filters.orderBy?`     | `TransactionOrderByInput` | -                                             |
| `filters.size?`        | `BigNumber`               | page size                                     |
| `filters.start?`       | `BigNumber`               | page offset                                   |
| `filters.success?`     | `boolean`                 | whether the transaction was successful or not |
| `filters.tag?`         | `TxTag`                   | tag associated with the transaction           |

**Returns**

`Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`ExtrinsicData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdata)>>

**Defined in**

[api/entities/Account.ts:368](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L368)

***

#### hasPermissions

▸ **hasPermissions**(`permissions`): `Promise`<`boolean`>

Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity

**`deprecated`** in favor of `checkPermissions`

**Parameters**

| Name          | Type                                                                                                                                |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `permissions` | [`SimplePermissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simplepermissions) |

**Returns**

`Promise`<`boolean`>

**Defined in**

[api/entities/Account.ts:588](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L588)

***

#### isEqual

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

Determine whether this Entity is the same as another one

**Parameters**

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

**Returns**

`boolean`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[isEqual](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#isequal)

**Defined in**

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

***

#### isFrozen

▸ **isFrozen**(): `Promise`<`boolean`>

Check whether this Account is frozen. If frozen, it cannot perform any Identity related action until the primary Account of the Identity unfreezes all secondary Accounts

**`note`** returns false if the Account isn't associated to any Identity

**Returns**

`Promise`<`boolean`>

**Defined in**

[api/entities/Account.ts:469](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L469)

***

#### toHuman

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

Return the Account's address

**Returns**

`string`

**Overrides**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[toHuman](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#tohuman)

**Defined in**

[api/entities/Account.ts:604](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Account.ts#L604)

***

#### 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`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[generateUuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#generateuuid)

**Defined in**

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

***

#### 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`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[unserialize](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#unserialize)

**Defined in**

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