# Requirements

Handles all Security Token Compliance Requirements related functionality

## Hierarchy

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

  ↳ **Requirements**

## Index

### Properties

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

### Methods

* [arePaused](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#arepaused)
* [checkSettle](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#checksettle)
* [get](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#get)
* [pause](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#pause)
* [reset](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#reset)
* [set](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#set)
* [unpause](/polymesh-sdk-api-reference/docs-v2/classes/requirements.md#unpause)

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

## Methods

### arePaused

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

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:183*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L183)

Check whether asset compliance requirements are paused or not

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

### checkSettle

▸ **checkSettle**(`args`: object): *Promise‹*[*Compliance*](/polymesh-sdk-api-reference/docs-v2/classes/compliance.md)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:149*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L149)

Check whether the sender and receiver Identities in a transfer comply with all the requirements of this asset

**`note`** this does not take balances into account

**Parameters:**

▪ **args**: *object*

| Name    | Type                                                                          | Description                                                  |
| ------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `from?` | string \| [Identity](/polymesh-sdk-api-reference/docs-v2/classes/identity.md) | sender Identity (optional, defaults to the current Identity) |
| `to`    | string \| [Identity](/polymesh-sdk-api-reference/docs-v2/classes/identity.md) | receiver Identity                                            |

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

### get

▸ **get**(): *Promise‹*[*Requirement*](/polymesh-sdk-api-reference/docs-v2/interfaces/requirement.md)*\[]›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:51*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L51)

Retrieve all of the Security Token's requirements

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:52*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L52)

**Parameters:**

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

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

### pause

▸ **pause**(): *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/Compliance/Requirements.ts:122*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L122)

Pause all the Security Token's requirements. This means that all transfers will be allowed until requirements are unpaused

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

### reset

▸ **reset**(): *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/Compliance/Requirements.ts:111*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L111)

Detele all the current requirements for 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)*››*

### set

▸ **set**(`args`: [SetAssetRequirementsParams](/polymesh-sdk-api-reference/docs-v2/interfaces/setassetrequirementsparams.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/Compliance/Requirements.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L38)

Configure asset compliance requirements for the Security Token. This operation will replace all existing requirements with a new requirement set

This requires two transactions

**`example`** Say A, B, C, D and E are requirements and we arrange them as `[[A, B], [C, D], [E]]`. For a transfer to succeed, it must either comply with A AND B, C AND D, OR E.

**Parameters:**

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

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

### unpause

▸ **unpause**(): *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/Compliance/Requirements.ts:133*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Compliance/Requirements.ts#L133)

Un-pause all the Security Token's current requirements

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


---

# Agent Instructions: 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-v2/classes/requirements.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.