# Claims

Handles all Claims related functionality

## Hierarchy

* **Claims**

## Index

### Methods

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

## Methods

### addClaims

▸ **addClaims**(`args`: Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"›): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:59*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L59)

Add claims to Identities

**Parameters:**

| Name   | Type                                                                                                                                       |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `args` | Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"› |

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

### addInvestorUniquenessClaim

▸ **addInvestorUniquenessClaim**(`args`: AddInvestorUniquenessClaimParams): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L48)

Add an Investor Uniqueness Claim to the current Identity

**Parameters:**

| Name   | Type                             | Description |
| ------ | -------------------------------- | ----------- |
| `args` | AddInvestorUniquenessClaimParams |             |

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

### editClaims

▸ **editClaims**(`args`: Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"›): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:68*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L68)

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

* @param args.claims - array of claims to be edited

**Parameters:**

| Name   | Type                                                                                                                                       |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `args` | Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"› |

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

### getCddClaims

▸ **getCddClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimdata)*››*

*Defined in* [*src/Claims.ts:230*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L230)

Retrieve the list of CDD claims for a target 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                                                                                           | page size                                                                           |
| `start?`          | undefined \| number                                                                                           | page offset                                                                         |
| `target?`         | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/identity) | identity for which to fetch CDD claims (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimdata)*››*

### getClaimScopes

▸ **getClaimScopes**(`opts`: object): *Promise‹*[*ClaimScope*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimscope)*\[]›*

*Defined in* [*src/Claims.ts:192*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L192)

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

**`note`** a null scope means the Identity has scopeless claims (like CDD for example)

**`note`** uses the middleware

**Parameters:**

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

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

**Returns:** *Promise‹*[*ClaimScope*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimscope)*\[]›*

### getIdentitiesWithClaims

▸ **getIdentitiesWithClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*IdentityWithClaims*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/identitywithclaims)*››*

*Defined in* [*src/Claims.ts:129*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L129)

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?`          | [ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/enums/claimtype)\[]               | 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://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/scope)                     | 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/docs-v3/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/docs-v3/classes/identity)‹›)\[] | identity IDs of claim issuers. Defaults to all claim issuers                              |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*IdentityWithClaims*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/identitywithclaims)*››*

### getIssuedClaims

▸ **getIssuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimdata)*››*

*Defined in* [*src/Claims.ts:92*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L92)

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/docs-v3/classes/identity) | identity (optional, defaults to the current Identity) |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/claimdata)*››*

### getTargetingClaims

▸ **getTargetingClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*IdentityWithClaims*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/identitywithclaims)*››*

*Defined in* [*src/Claims.ts:263*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L263)

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

**`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                                       |
| `scope?`               | [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/scope)                     | -                                                                                         |
| `size?`                | undefined \| number                                                                                                  | -                                                                                         |
| `start?`               | undefined \| number                                                                                                  | -                                                                                         |
| `target?`              | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/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/docs-v3/classes/identity)‹›)\[] | -                                                                                         |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/resultset)*‹*[*IdentityWithClaims*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/identitywithclaims)*››*

### revokeClaims

▸ **revokeClaims**(`args`: Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"›): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/Claims.ts#L77)

Revoke claims from Identities

**Parameters:**

| Name   | Type                                                                                                                                       |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `args` | Omit‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/globals#modifyclaimsparams), "operation"› |

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