> 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/documents.md).

# Documents

Handles all Security Token Document related functionality

## Hierarchy

* Namespace‹[SecurityToken](/polymesh-sdk-api-reference/docs-v6/classes/securitytoken.md)›

  ↳ **Documents**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v6/classes/documents.md#protected-context)
* [parent](/polymesh-sdk-api-reference/docs-v6/classes/documents.md#protected-parent)

### Methods

* [get](/polymesh-sdk-api-reference/docs-v6/classes/documents.md#get)
* [set](/polymesh-sdk-api-reference/docs-v6/classes/documents.md#set)

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

• **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/docs-v6/classes/securitytoken.md)

*Inherited from void*

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

## Methods

### get

▸ **get**(`paginationOpts?`: [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*TokenDocument*](/polymesh-sdk-api-reference/docs-v6/interfaces/tokendocument.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Documents.ts:51*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/Documents.ts#L51)

Retrieve all documents linked to the Security Token

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md) |

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

### set

▸ **set**(`args`: [SetTokenDocumentsParams](/polymesh-sdk-api-reference/docs-v6/interfaces/settokendocumentsparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v6/classes/securitytoken.md)*››*

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

Assign a new list of documents to the Security Token by replacing the existing list of documents with the one passed in the parameters

This requires two transactions

**`note`** required role:

* Security Token Owner

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

**Parameters:**

| Name   | Type                                                                                                 |
| ------ | ---------------------------------------------------------------------------------------------------- |
| `args` | [SetTokenDocumentsParams](/polymesh-sdk-api-reference/docs-v6/interfaces/settokendocumentsparams.md) |

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