> 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-v6/classes/currentaccount.md).

# CurrentAccount

Represents the current account that is bound to the SDK instance

## Hierarchy

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

↳ **CurrentAccount**

## Index

### Properties

* [address](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#address)
* [authorizations](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#authorizations)
* [context](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#protected-context)
* [key](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#key)
* [uuid](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#uuid)

### Methods

* [getBalance](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#getbalance)
* [getIdentity](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#getidentity)
* [getPermissions](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#getpermissions)
* [getTransactionHistory](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#gettransactionhistory)
* [hasPermissions](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#haspermissions)
* [isEqual](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#isequal)
* [isFrozen](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#isfrozen)
* [leaveIdentity](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#leaveidentity)
* [generateUuid](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v6/classes/currentaccount.md#static-unserialize)

## Properties

### address

• **address**: *string*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*address*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#address)

*Defined in* [*src/api/entities/Account.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L45)

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

### authorizations

• **authorizations**: [*Authorizations*](/polymesh-sdk-api-reference/docs-v6/classes/authorizations.md)*‹*[*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*›*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*authorizations*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#authorizations)

*Defined in* [*src/api/entities/Account.ts:53*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L53)

### `Protected` context

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#protected-context)

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

### key

• **key**: *string*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*key*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#key)

*Defined in* [*src/api/entities/Account.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L50)

public key of the account. This is a hex representation of the address that is transversal to any Substrate chain

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#uuid)

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

## Methods

### getBalance

▸ **getBalance**(): *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v6/globals.md#accountbalance)*›*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*getBalance*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#getbalance)

*Defined in* [*src/api/entities/Account.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L75)

Get the free/locked POLYX balance of the account

**`note`** can be subscribed to

**Returns:** *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v6/globals.md#accountbalance)*›*

▸ **getBalance**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v6/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v6/globals.md#accountbalance)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v6/globals.md#unsubcallback)*›*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*getBalance*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#getbalance)

*Defined in* [*src/api/entities/Account.ts:76*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L76)

**Parameters:**

| Name       | Type                                                                                                                                                       |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v6/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v6/globals.md#accountbalance)› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v6/globals.md#unsubcallback)*›*

### getIdentity

▸ **getIdentity**(): *Promise‹*[*CurrentIdentity*](/polymesh-sdk-api-reference/docs-v6/classes/currentidentity.md) *| null›*

*Overrides* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*getIdentity*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#getidentity)

*Defined in* [*src/api/entities/CurrentAccount.ts:43*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CurrentAccount.ts#L43)

Retrieve the current Identity (null if there is none)

**Returns:** *Promise‹*[*CurrentIdentity*](/polymesh-sdk-api-reference/docs-v6/classes/currentidentity.md) *| null›*

### getPermissions

▸ **getPermissions**(): *Promise‹*[*Permissions*](/polymesh-sdk-api-reference/docs-v6/interfaces/permissions.md)*›*

*Defined in* [*src/api/entities/CurrentAccount.ts:52*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CurrentAccount.ts#L52)

Retrieve the Permissions this Signer has as a Signing Key for its corresponding Identity

**Returns:** *Promise‹*[*Permissions*](/polymesh-sdk-api-reference/docs-v6/interfaces/permissions.md)*›*

### getTransactionHistory

▸ **getTransactionHistory**(`filters`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*ExtrinsicData*](/polymesh-sdk-api-reference/docs-v6/interfaces/extrinsicdata.md)*››*

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*getTransactionHistory*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#gettransactionhistory)

*Defined in* [*src/api/entities/Account.ts:126*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L126)

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

**`note`** uses the middleware

**Parameters:**

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

| Name           | Type                       | Description                                   |
| -------------- | -------------------------- | --------------------------------------------- |
| `blockNumber?` | BigNumber                  | -                                             |
| `orderBy?`     | TransactionOrderByInput    | -                                             |
| `size?`        | undefined \| number        | page size                                     |
| `start?`       | undefined \| number        | page offset                                   |
| `success?`     | undefined \| false \| true | whether the transaction was successful or not |
| `tag?`         | TxTag                      | tag associated with the transaction           |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*ExtrinsicData*](/polymesh-sdk-api-reference/docs-v6/interfaces/extrinsicdata.md)*››*

### hasPermissions

▸ **hasPermissions**(`permissions`: [PermissionsLike](/polymesh-sdk-api-reference/docs-v6/interfaces/permissionslike.md)): *Promise‹boolean›*

*Defined in* [*src/api/entities/CurrentAccount.ts:80*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CurrentAccount.ts#L80)

Check if this Account possesses certain Permissions for its corresponding Identity

**Parameters:**

| Name          | Type                                                                                 |
| ------------- | ------------------------------------------------------------------------------------ |
| `permissions` | [PermissionsLike](/polymesh-sdk-api-reference/docs-v6/interfaces/permissionslike.md) |

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

### isEqual

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#isequal)

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

**Returns:** *boolean*

### isFrozen

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

*Inherited from* [*Account*](/polymesh-sdk-api-reference/docs-v6/classes/account.md)*.*[*isFrozen*](/polymesh-sdk-api-reference/docs-v6/classes/account.md#isfrozen)

*Defined in* [*src/api/entities/Account.ts:211*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Account.ts#L211)

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

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

### leaveIdentity

▸ **leaveIdentity**(`args`: void): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/CurrentAccount.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CurrentAccount.ts#L36)

Leave the current Identity. This operation can only be done if this Account is a secondary key for the Identity

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md), which means you can call `leaveIdentity.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name   | Type |
| ------ | ---- |
| `args` | void |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹void››*

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-unserialize)

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