# Requirements

Handles all Security Token Compliance Requirements related functionality

## Hierarchy

* Namespace‹[SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)›

  ↳ **Requirements**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)

### Methods

* [arePaused](#arepaused)
* [checkSettle](#checksettle)
* [get](#get)
* [pause](#pause)
* [reset](#reset)
* [set](#set)
* [unpause](#unpause)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/context)

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/compliance)*›*

*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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/identity) | sender Identity (optional, defaults to the current Identity) |
| `to`    | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/identity) | receiver Identity                                            |

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

### get

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

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/requirement)*\[]›*

▸ **get**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals#subcallback)‹[Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/requirement)\[]›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/globals#subcallback)‹[Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/requirement)\[]› |

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

### pause

▸ **pause**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

### reset

▸ **reset**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

### set

▸ **set**(`args`: [SetAssetRequirementsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/setassetrequirementsparams)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

*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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/interfaces/setassetrequirementsparams) |

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

### unpause

▸ **unpause**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/securitytoken)*››*