# 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/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

*Defined in* [*src/Claims.ts:126*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L126)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [addClaims.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

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

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

***

### addInvestorUniquenessClaim

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

*Defined in* [*src/Claims.ts:113*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L113)

Add an Investor Uniqueness Claim to the signing Identity

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [addInvestorUniquenessClaim.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

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

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

***

### editClaims

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

*Defined in* [*src/Claims.ts:139*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L139)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [editClaims.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

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

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

***

### getCddClaims

▸ **getCddClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/cddclaim.md)*›\[]›*

*Defined in* [*src/Claims.ts:310*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L310)

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/classes/identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) |

**Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/cddclaim.md)*›\[]›*

***

### getClaimScopes

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

*Defined in* [*src/Claims.ts:260*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L260)

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/classes/identity) | Identity for which to fetch claim scopes (optional, defaults to the signing Identity) |

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

***

### getIdentitiesWithClaims

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

*Defined in* [*src/Claims.ts:200*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L200)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/enums/targettreatment.md#exclude)‹[ClaimType](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/enums/claimtype.md), [InvestorUniquenessV2](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/scope.md)                                                                                                                                                                                                                                                                   | scope of the claims to fetch. Defaults to any scope                                       |
| `size?`                | BigNumber                                                                                                                                                                                                                                                                                                                                                             | page size                                                                                 |
| `start?`               | BigNumber                                                                                                                                                                                                                                                                                                                                                             | page offset                                                                               |
| `targets?`             | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/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/classes/identity)‹›)\[]                                                                                                                                                                                                                                                          | Identity IDs of claim issuers. Defaults to all claim issuers                              |

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

***

### getInvestorUniquenessClaims

▸ **getInvestorUniquenessClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/investoruniquenessclaim.md)*›\[]›*

*Defined in* [*src/Claims.ts:334*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L334)

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/classes/identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) |

**Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/investoruniquenessclaim.md)*›\[]›*

***

### getIssuedClaims

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

*Defined in* [*src/Claims.ts:165*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L165)

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?`           | BigNumber                                                                                             | -                                                     |
| `start?`          | BigNumber                                                                                             | -                                                     |
| `target?`         | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/classes/identity) | Identity (optional, defaults to the signing Identity) |

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

***

### getTargetingClaims

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

*Defined in* [*src/Claims.ts:361*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L361)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/scope.md)          | -                                                                                         |
| `size?`                | BigNumber                                                                                                    | -                                                                                         |
| `start?`               | BigNumber                                                                                                    | -                                                                                         |
| `target?`              | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/classes/identity)        | Identity for which to fetch targeting claims (optional, defaults to the signing Identity) |
| `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/classes/identity)‹›)\[] | -                                                                                         |

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

***

### revokeClaims

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

*Defined in* [*src/Claims.ts:152*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Claims.ts#L152)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [revokeClaims.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

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

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