# Requirements

Handles all Security Token Compliance Requirements related functionality

## Hierarchy

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

  ↳ **Requirements**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)
* [pause](#pause)
* [reset](#reset)
* [set](#set)
* [unpause](#unpause)

### Methods

* [arePaused](#arepaused)
* [checkSettle](#checksettle)
* [get](#get)

## Properties

### `Protected` context

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

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

*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)

### pause

• **pause**: *ProcedureMethod‹void,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:160*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L160)

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

**`note`** required role:

* Security Token Owner

### reset

• **reset**: *ProcedureMethod‹void,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:152*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L152)

Detele all the current requirements for the Security Token.

**`note`** required role:

* Security Token Owner

### set

• **set**: *ProcedureMethod‹*[*SetAssetRequirementsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/setassetrequirementsparams)*,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:68*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L68)

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

This requires two transactions

**`param`** array of array of conditions. For a transfer to be successful, it must comply with all the conditions of at least one of the arrays. In other words, higher level arrays are *OR* between them, while conditions inside each array are *AND* between them

**`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.

**`note`** required role:

* Security Token Owner

### unpause

• **unpause**: *ProcedureMethod‹void,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:165*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L165)

Un-pause all the Security Token's current requirements

## Methods

### arePaused

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

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:204*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L204)

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-v4/classes/compliance)*›*

*Defined in* [*src/api/entities/SecurityToken/Compliance/Requirements.ts:175*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Compliance/Requirements.ts#L175)

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

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

### get

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

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

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-v4/interfaces/requirement)*\[]›*

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

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

**Parameters:**

| Name       | Type                                                                                                                                                                                                                       |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/globals#subcallback)‹[Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/requirement)\[]› |

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