> 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-v2/classes/securitytoken.md).

# SecurityToken

Class used to manage all the Security Token functionality

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v2/classes/entity.md)‹UniqueIdentifiers›

  ↳ **SecurityToken**

## Index

### Properties

* [compliance](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#compliance)
* [context](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#protected-context)
* [did](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#did)
* [documents](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#documents)
* [issuance](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#issuance)
* [settlements](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#settlements)
* [ticker](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#ticker)
* [tokenHolders](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#tokenholders)
* [uuid](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#uuid)

### Methods

* [createdAt](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#createdat)
* [currentFundingRound](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#currentfundinground)
* [details](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#details)
* [freeze](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#freeze)
* [getIdentifiers](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#getidentifiers)
* [isFrozen](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#isfrozen)
* [modify](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#modify)
* [modifyPrimaryIssuanceAgent](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#modifyprimaryissuanceagent)
* [removePrimaryIssuanceAgent](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#removeprimaryissuanceagent)
* [transferOwnership](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#transferownership)
* [unfreeze](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#unfreeze)
* [generateUuid](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md#static-unserialize)

## Properties

### compliance

• **compliance**: *Compliance*

*Defined in* [*src/api/entities/SecurityToken/index.ts:79*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L79)

### `Protected` context

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md#protected-context)

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

### did

• **did**: *string*

*Defined in* [*src/api/entities/SecurityToken/index.ts:67*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L67)

identity id of the Security Token

### documents

• **documents**: [*Documents*](/polymesh-sdk-api-reference/docs-v2/classes/documents.md)

*Defined in* [*src/api/entities/SecurityToken/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L75)

### issuance

• **issuance**: [*Issuance*](/polymesh-sdk-api-reference/docs-v2/classes/issuance.md)

*Defined in* [*src/api/entities/SecurityToken/index.ts:78*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L78)

### settlements

• **settlements**: [*Settlements*](/polymesh-sdk-api-reference/docs-v2/classes/settlements.md)

*Defined in* [*src/api/entities/SecurityToken/index.ts:76*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L76)

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/SecurityToken/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L72)

ticker of the Security Token

### tokenHolders

• **tokenHolders**: [*TokenHolders*](/polymesh-sdk-api-reference/docs-v2/classes/tokenholders.md)

*Defined in* [*src/api/entities/SecurityToken/index.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L77)

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md#uuid)

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

## Methods

### createdAt

▸ **createdAt**(): *Promise‹*[*EventIdentifier*](/polymesh-sdk-api-reference/docs-v2/interfaces/eventidentifier.md) *| null›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:257*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L257)

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created

**`note`** uses the middleware

**`note`** there is a possibility that the data is not ready by the time it is requested. In that case, `null` is returned

**Returns:** *Promise‹*[*EventIdentifier*](/polymesh-sdk-api-reference/docs-v2/interfaces/eventidentifier.md) *| null›*

### currentFundingRound

▸ **currentFundingRound**(): *Promise‹string›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:187*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L187)

Retrieve the Security Token's funding round

**`note`** can be subscribed to

**Returns:** *Promise‹string›*

▸ **currentFundingRound**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹string›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:188*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L188)

**Parameters:**

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

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

### details

▸ **details**(): *Promise‹*[*SecurityTokenDetails*](/polymesh-sdk-api-reference/docs-v2/interfaces/securitytokendetails.md)*›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:132*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L132)

Retrieve the Security Token's name, total supply, whether it is divisible or not and the Identity of the owner

**`note`** can be subscribed to

**Returns:** *Promise‹*[*SecurityTokenDetails*](/polymesh-sdk-api-reference/docs-v2/interfaces/securitytokendetails.md)*›*

▸ **details**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[SecurityTokenDetails](/polymesh-sdk-api-reference/docs-v2/interfaces/securitytokendetails.md)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:133*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L133)

**Parameters:**

| Name       | Type                                                                                                                                                                      |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[SecurityTokenDetails](/polymesh-sdk-api-reference/docs-v2/interfaces/securitytokendetails.md)› |

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

### freeze

▸ **freeze**(): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/SecurityToken/index.ts:284*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L284)

Freezes transfers and minting of the Security Token

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

### getIdentifiers

▸ **getIdentifiers**(): *Promise‹*[*TokenIdentifier*](/polymesh-sdk-api-reference/docs-v2/interfaces/tokenidentifier.md)*\[]›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:221*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L221)

Retrive the Security Token's asset identifiers list

**`note`** can be subscribed to

**Returns:** *Promise‹*[*TokenIdentifier*](/polymesh-sdk-api-reference/docs-v2/interfaces/tokenidentifier.md)*\[]›*

▸ **getIdentifiers**(`callback?`: [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[TokenIdentifier](/polymesh-sdk-api-reference/docs-v2/interfaces/tokenidentifier.md)\[]›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:222*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L222)

**Parameters:**

| Name        | Type                                                                                                                                                               |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `callback?` | [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[TokenIdentifier](/polymesh-sdk-api-reference/docs-v2/interfaces/tokenidentifier.md)\[]› |

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

### isFrozen

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

*Defined in* [*src/api/entities/SecurityToken/index.ts:302*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L302)

Check whether transfers are frozen for the Security Token

**`note`** can be subscribed to

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

▸ **isFrozen**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹boolean›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/SecurityToken/index.ts:303*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L303)

**Parameters:**

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

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

### modify

▸ **modify**(`args`: [ModifyTokenParams](/polymesh-sdk-api-reference/docs-v2/globals.md#modifytokenparams)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/SecurityToken/index.ts:122*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L122)

Modify some properties of the Security Token

**`throws`** if the passed values result in no changes being made to the token

**Parameters:**

| Name   | Type                                                                                  |
| ------ | ------------------------------------------------------------------------------------- |
| `args` | [ModifyTokenParams](/polymesh-sdk-api-reference/docs-v2/globals.md#modifytokenparams) |

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

### modifyPrimaryIssuanceAgent

▸ **modifyPrimaryIssuanceAgent**(`args`: [ModifyPrimaryIssuanceAgentParams](/polymesh-sdk-api-reference/docs-v2/interfaces/modifyprimaryissuanceagentparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/SecurityToken/index.ts:340*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L340)

Assign a new primary issuance agent for the Security Token

**`note`** this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived`

**Parameters:**

| Name   | Type                                                                                                                   |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| `args` | [ModifyPrimaryIssuanceAgentParams](/polymesh-sdk-api-reference/docs-v2/interfaces/modifyprimaryissuanceagentparams.md) |

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

### removePrimaryIssuanceAgent

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

*Defined in* [*src/api/entities/SecurityToken/index.ts:352*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L352)

Remove the primary issuance agent of the Security Token

**`note`** if primary issuance agent is not set, Security Token owner would be used by default

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

### transferOwnership

▸ **transferOwnership**(`args`: [TransferTokenOwnershipParams](/polymesh-sdk-api-reference/docs-v2/interfaces/transfertokenownershipparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/SecurityToken/index.ts:109*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L109)

Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary

**`note`** this will create [Authorization Requests](/polymesh-sdk-api-reference/docs-v2/classes/authorizationrequest.md) which have to be accepted by the corresponding [Accounts](/polymesh-sdk-api-reference/docs-v2/classes/account.md) and/or [Identities](/polymesh-sdk-api-reference/docs-v2/enums/scopetype.md#identity). An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived`

**Parameters:**

| Name   | Type                                                                                                           |
| ------ | -------------------------------------------------------------------------------------------------------------- |
| `args` | [TransferTokenOwnershipParams](/polymesh-sdk-api-reference/docs-v2/interfaces/transfertokenownershipparams.md) |

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

### unfreeze

▸ **unfreeze**(): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/SecurityToken/index.ts:292*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/index.ts#L292)

Unfreeze transfers and minting of the Security Token

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

### `Static` generateUuid

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *string*

### `Static` unserialize

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v2/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *Identifiers*