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

# Documents

Handles all Security Token Document related functionality

## Hierarchy

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

  ↳ **Documents**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

### set

• **set**: *ProcedureMethod‹*[*SetTokenDocumentsParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/settokendocumentsparams.md)*,* [*SecurityToken*](/polymesh-sdk-api-reference/docs-v4/classes/securitytoken.md)*›*

*Defined in* [*src/api/entities/SecurityToken/Documents.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Documents.ts#L38)

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

**`param`** new list of documents

**`note`** required role:

* Security Token Owner

## Methods

### get

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

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

Retrieve all documents linked to the Security Token

**`note`** supports pagination

**Parameters:**

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

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/documents.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
