> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/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/classic-sdk/beta/external-modules/_entities_tokenholder_.tokenholder.md).

# Tokenholder

Used to manage a Tokenholder

## Hierarchy

* [Entity](broken://pages/-M-tw-_WeBJcuS0_s0nR)‹[Params](broken://pages/-M2_0qxMGernqk2dqjut)›

  ↳ **Tokenholder**

## Index

### Constructors

* [constructor](broken://pages/-M2_0qv9BDLjVrSwBk0n#constructor)

### Properties

* [address](broken://pages/-M2_0qv9BDLjVrSwBk0n#address)
* [balance](broken://pages/-M2_0qv9BDLjVrSwBk0n#balance)
* [canBuyFromSto](broken://pages/-M2_0qv9BDLjVrSwBk0n#canbuyfromsto)
* [canReceiveAfter](broken://pages/-M2_0qv9BDLjVrSwBk0n#canreceiveafter)
* [canSendAfter](broken://pages/-M2_0qv9BDLjVrSwBk0n#cansendafter)
* [isAccredited](broken://pages/-M2_0qv9BDLjVrSwBk0n#isaccredited)
* [kycExpiry](broken://pages/-M2_0qv9BDLjVrSwBk0n#kycexpiry)
* [securityTokenId](broken://pages/-M2_0qv9BDLjVrSwBk0n#securitytokenid)
* [securityTokenSymbol](broken://pages/-M2_0qv9BDLjVrSwBk0n#securitytokensymbol)
* [uid](broken://pages/-M2_0qv9BDLjVrSwBk0n#uid)

### Methods

* [\_refresh](broken://pages/-M2_0qv9BDLjVrSwBk0n#_refresh)
* [isRevoked](broken://pages/-M2_0qv9BDLjVrSwBk0n#isrevoked)
* [toPojo](broken://pages/-M2_0qv9BDLjVrSwBk0n#topojo)
* [generateId](broken://pages/-M2_0qv9BDLjVrSwBk0n#static-generateid)
* [unserialize](broken://pages/-M2_0qv9BDLjVrSwBk0n#static-unserialize)

## Constructors

### constructor

\+ **new Tokenholder**(`params`: [Params](broken://pages/-M2_0qxMGernqk2dqjut) & [UniqueIdentifiers](broken://pages/-M2_0qxNlwSJ56VhGxqW)): [*Tokenholder*](broken://pages/-M2_0qv9BDLjVrSwBk0n)

Defined in src/entities/Tokenholder.ts:112

Create a new Tokenholder instance

**Parameters:**

| Name     | Type                                                                                                     |
| -------- | -------------------------------------------------------------------------------------------------------- |
| `params` | [Params](broken://pages/-M2_0qxMGernqk2dqjut) & [UniqueIdentifiers](broken://pages/-M2_0qxNlwSJ56VhGxqW) |

**Returns:** [*Tokenholder*](broken://pages/-M2_0qv9BDLjVrSwBk0n)

## Properties

### address

• **address**: *string*

Defined in src/entities/Tokenholder.ts:112

wallet address

### balance

• **balance**: *BigNumber*

Defined in src/entities/Tokenholder.ts:107

total Security Token balance of the Tokenholder

### canBuyFromSto

• **canBuyFromSto**: *boolean*

Defined in src/entities/Tokenholder.ts:102

whether the Tokenholder can purchase from an STO or not

### canReceiveAfter

• **canReceiveAfter**: *Date*

Defined in src/entities/Tokenholder.ts:87

date after which a Tokenholder can transfer tokens to their address

### canSendAfter

• **canSendAfter**: *Date*

Defined in src/entities/Tokenholder.ts:82

date after which a Tokenholder can transfer tokens from their address

### isAccredited

• **isAccredited**: *boolean*

Defined in src/entities/Tokenholder.ts:97

whether the Tokenholder is accredited or not

### kycExpiry

• **kycExpiry**: *Date*

Defined in src/entities/Tokenholder.ts:92

date when the Tokenholder's KYC will expire

### securityTokenId

• **securityTokenId**: *string*

Defined in src/entities/Tokenholder.ts:77

### securityTokenSymbol

• **securityTokenSymbol**: *string*

Defined in src/entities/Tokenholder.ts:75

### uid

• **uid**: *string*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*uid*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-uid)

Defined in src/entities/Tokenholder.ts:73

unique generated id for a Tokenholder

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](broken://pages/-M2_0qxMGernqk2dqjut)›): *void*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*\_refresh*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-_refresh)

Defined in src/entities/Tokenholder.ts:195

Hydrate the entity

**Parameters:**

| Name     | Type                                                   |
| -------- | ------------------------------------------------------ |
| `params` | Partial‹[Params](broken://pages/-M2_0qxMGernqk2dqjut)› |

**Returns:** *void*

### isRevoked

▸ **isRevoked**(): *boolean*

Defined in src/entities/Tokenholder.ts:150

Checks if this Tokenholder's KYC has been manually revoked

**Returns:** *boolean*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*toPojo*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-topojo)

Defined in src/entities/Tokenholder.ts:164

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **address**: *string*
* **balance**: *BigNumber*
* **canBuyFromSto**: *boolean*
* **canReceiveAfter**: *Date*
* **canSendAfter**: *Date*
* **isAccredited**: *boolean*
* **kycExpiry**: *Date*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **uid**: *string*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

Defined in src/entities/Tokenholder.ts:45

Generate the Tokenholder's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name              | Type   |
| ----------------- | ------ |
| `address`         | string |
| `securityTokenId` | string |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](broken://pages/-M2_0qxNlwSJ56VhGxqW)

Defined in src/entities/Tokenholder.ts:57

Unserialize a serialized Tokenholder entity

**Parameters:**

| Name         | Type   | Description                                |
| ------------ | ------ | ------------------------------------------ |
| `serialized` | string | string with Tokenholder entity information |

**Returns:** [*UniqueIdentifiers*](broken://pages/-M2_0qxNlwSJ56VhGxqW)