# Claims

Handles all Claims related functionality

## Hierarchy

* **Claims**

## Index

### Methods

* [addClaims](#addclaims)
* [addInvestorUniquenessClaim](#addinvestoruniquenessclaim)
* [editClaims](#editclaims)
* [getCddClaims](#getcddclaims)
* [getClaimScopes](#getclaimscopes)
* [getIdentitiesWithClaims](#getidentitieswithclaims)
* [getInvestorUniquenessClaims](#getinvestoruniquenessclaims)
* [getIssuedClaims](#getissuedclaims)
* [getTargetingClaims](#gettargetingclaims)
* [revokeClaims](#revokeclaims)

## Methods

### addClaims

▸ **addClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:125*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L125)

Add claims to Identities

**`note`** required roles:

* Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `addClaims.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                    |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"› |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

***

### addInvestorUniquenessClaim

▸ **addInvestorUniquenessClaim**(`args`: [AddInvestorUniquenessClaimParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addinvestoruniquenessclaimparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:112*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L112)

Add an Investor Uniqueness Claim to the current Identity

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `addInvestorUniquenessClaim.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                                  |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [AddInvestorUniquenessClaimParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/addinvestoruniquenessclaimparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)                                       |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

***

### editClaims

▸ **editClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:138*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L138)

Edit claims associated to Identities (only the expiry date can be modified)

**`note`** required roles:

* Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `editClaims.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                    |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"› |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

***

### getCddClaims

▸ **getCddClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#cddclaim)*›\[]›*

*Defined in* [*src/Claims.ts:308*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L308)

Retrieve the list of CDD claims for a target Identity

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name              | Type                                                                                                          | Description                                                                         |
| ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `includeExpired?` | undefined \| false \| true                                                                                    | whether to include expired claims. Defaults to true                                 |
| `target?`         | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity) | identity for which to fetch CDD claims (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#cddclaim)*›\[]›*

***

### getClaimScopes

▸ **getClaimScopes**(`opts`: object): *Promise‹*[*ClaimScope*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimscope.md)*\[]›*

*Defined in* [*src/Claims.ts:258*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L258)

Retrieve all scopes in which claims have been made for the target Identity. If the scope is an asset DID, the corresponding ticker is returned as well

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name      | Type                                                                                                          | Description                                                                           |
| --------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `target?` | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity) | identity for which to fetch claim scopes (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ClaimScope*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimscope.md)*\[]›*

***

### getIdentitiesWithClaims

▸ **getIdentitiesWithClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitywithclaims.md)*››*

*Defined in* [*src/Claims.ts:199*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L199)

Retrieve a list of Identities with claims associated to them. Can be filtered using parameters

**`note`** supports pagination

**`note`** uses the middleware

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name                   | Type                                                                                                                                                                                                                                                                                                                                                      | Description                                                                               |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `claimTypes?`          | [Exclude](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/targettreatment.md#exclude)‹[ClaimType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/claimtype.md), [InvestorUniquenessV2](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/enums/claimtype.md#investoruniquenessv2)›\[] | types of the claims to fetch. Defaults to any type                                        |
| `includeExpired?`      | undefined \| false \| true                                                                                                                                                                                                                                                                                                                                | whether to include expired claims. Defaults to true                                       |
| `scope?`               | [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scope.md)                                                                                                                                                                                                                                                           | scope of the claims to fetch. Defaults to any scope                                       |
| `size?`                | undefined \| number                                                                                                                                                                                                                                                                                                                                       | page size                                                                                 |
| `start?`               | undefined \| number                                                                                                                                                                                                                                                                                                                                       | page offset                                                                               |
| `targets?`             | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity)‹›)\[]                                                                                                                                                                                                                                      | identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets |
| `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity)‹›)\[]                                                                                                                                                                                                                                      | identity IDs of claim issuers. Defaults to all claim issuers                              |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitywithclaims.md)*››*

***

### getInvestorUniquenessClaims

▸ **getInvestorUniquenessClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#investoruniquenessclaim)*›\[]›*

*Defined in* [*src/Claims.ts:332*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L332)

Retrieve the list of InvestorUniqueness claims for a target Identity

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name              | Type                                                                                                          | Description                                                                         |
| ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `includeExpired?` | undefined \| false \| true                                                                                    | whether to include expired claims. Defaults to true                                 |
| `target?`         | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity) | identity for which to fetch CDD claims (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#investoruniquenessclaim)*›\[]›*

***

### getIssuedClaims

▸ **getIssuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*››*

*Defined in* [*src/Claims.ts:164*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L164)

Retrieve all claims issued by an Identity

**`note`** supports pagination

**`note`** uses the middleware

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name              | Type                                                                                                          | Description                                           |
| ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `includeExpired?` | undefined \| false \| true                                                                                    | whether to include expired claims. Defaults to true   |
| `size?`           | undefined \| number                                                                                           | -                                                     |
| `start?`          | undefined \| number                                                                                           | -                                                     |
| `target?`         | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity) | identity (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/claimdata.md)*››*

***

### getTargetingClaims

▸ **getTargetingClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitywithclaims.md)*››*

*Defined in* [*src/Claims.ts:359*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L359)

Retrieve all claims issued about an Identity, grouped by claim issuer

**`note`** supports pagination

**`note`** uses the middleware (optional)

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name                   | Type                                                                                                                 | Description                                                                               |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `includeExpired?`      | undefined \| false \| true                                                                                           | whether to include expired claims. Defaults to true                                       |
| `scope?`               | [Scope](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/scope.md)                      | -                                                                                         |
| `size?`                | undefined \| number                                                                                                  | -                                                                                         |
| `start?`               | undefined \| number                                                                                                  | -                                                                                         |
| `target?`              | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity)        | identity for which to fetch targeting claims (optional, defaults to the current Identity) |
| `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/identity)‹›)\[] | -                                                                                         |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitywithclaims.md)*››*

***

### revokeClaims

▸ **revokeClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:151*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/Claims.ts#L151)

Revoke claims from Identities

**`note`** required roles:

* Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `revokeClaims.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                    |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#modifyclaimsparams), "claims"› |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*