# Claims Handles all Claims related functionality ## Hierarchy * **Claims** ## Index ### Methods * [addClaims](#addclaims) * [addInvestorUniquenessClaim](#addinvestoruniquenessclaim) * [editClaims](#editclaims) * [getCddClaims](#getcddclaims) * [getClaimScopes](#getclaimscopes) * [getIdentitiesWithClaims](#getidentitieswithclaims) * [getIdentitiesWithClaimsV2](#getidentitieswithclaimsv2) * [getInvestorUniquenessClaims](#getinvestoruniquenessclaims) * [getIssuedClaims](#getissuedclaims) * [getIssuedClaimsV2](#getissuedclaimsv2) * [getTargetingClaims](#gettargetingclaims) * [getTargetingClaimsV2](#gettargetingclaimsv2) * [revokeClaims](#revokeclaims) ## Methods ### addClaims ▸ **addClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *Defined in* [*src/Claims.ts:130*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L130) 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/beta/docs/interfaces/proceduremethod.md), which means you can call [addClaims.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/docs-beta/globals#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *** ### addInvestorUniquenessClaim ▸ **addInvestorUniquenessClaim**(`args`: [AddInvestorUniquenessClaimParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinvestoruniquenessclaimparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *Defined in* [*src/Claims.ts:117*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L117) Add an Investor Uniqueness Claim to the signing Identity **`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [addInvestorUniquenessClaim.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinvestoruniquenessclaimparams.md) | | `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *** ### editClaims ▸ **editClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *Defined in* [*src/Claims.ts:143*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L143) 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/beta/docs/interfaces/proceduremethod.md), which means you can call [editClaims.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/docs-beta/globals#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *** ### getCddClaims ▸ **getCddClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddclaim.md)*›\[]›* *Defined in* [*src/Claims.ts:437*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L437) 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/docs-beta/classes/identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*‹*[*CddClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/cddclaim.md)*›\[]›* *** ### getClaimScopes ▸ **getClaimScopes**(`opts`: object): *Promise‹*[*ClaimScope*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimscope.md)*\[]›* *Defined in* [*src/Claims.ts:387*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L387) 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/docs-beta/classes/identity) | Identity for which to fetch claim scopes (optional, defaults to the signing Identity) | **Returns:** *Promise‹*[*ClaimScope*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimscope.md)*\[]›* *** ### getIdentitiesWithClaims ▸ **getIdentitiesWithClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:234*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L234) 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/beta/docs/enums/targettreatment.md#exclude)‹[ClaimType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/claimtype.md), [InvestorUniquenessV2](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/beta/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/docs-beta/classes/identity)‹›)\[] | Identities (or Identity IDs) for which to fetch targeting claims. Defaults to all targets | | `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identity)‹›)\[] | Identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *** ### getIdentitiesWithClaimsV2 ▸ **getIdentitiesWithClaimsV2**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:302*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L302) Retrieve a list of Identities with claims associated to them. Can be filtered using parameters **`note`** supports pagination **`note`** uses the middleware V2 **Parameters:** ▪`Default value` **opts**: *object*= {} | Name | Type | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | | `claimTypes?` | [Exclude](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/targettreatment.md#exclude)‹[ClaimType](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/claimtype.md), [InvestorUniquenessV2](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/beta/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/docs-beta/classes/identity)‹›)\[] | Identities (or Identity IDs) for which to fetch targeting claims. Defaults to all targets | | `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/identity)‹›)\[] | Identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *** ### getInvestorUniquenessClaims ▸ **getInvestorUniquenessClaims**(`opts`: object): *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessclaim.md)*›\[]›* *Defined in* [*src/Claims.ts:461*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L461) 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/docs-beta/classes/identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns:** *Promise‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/investoruniquenessclaim.md)*›\[]›* *** ### getIssuedClaims ▸ **getIssuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*››* *Defined in* [*src/Claims.ts:169*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L169) 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/docs-beta/classes/identity) | Identity (optional, defaults to the signing Identity) | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*››* *** ### getIssuedClaimsV2 ▸ **getIssuedClaimsV2**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*››* *Defined in* [*src/Claims.ts:199*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L199) Retrieve all claims issued by an Identity **`note`** supports pagination **`note`** uses the middlewareV2 **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/docs-beta/classes/identity) | Identity (optional, defaults to the signing Identity) | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*ClaimData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/claimdata.md)*››* *** ### getTargetingClaims ▸ **getTargetingClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:488*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L488) 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/beta/docs/interfaces/scope.md) | - | | `size?` | BigNumber | - | | `start?` | BigNumber | - | | `target?` | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/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/docs-beta/classes/identity)‹›)\[] | - | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *** ### getTargetingClaimsV2 ▸ **getTargetingClaimsV2**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:581*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L581) Retrieve all claims issued about an Identity, grouped by claim issuer **`note`** supports pagination **`note`** uses the middlewareV2 (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/beta/docs/interfaces/scope.md) | - | | `size?` | BigNumber | - | | `start?` | BigNumber | - | | `target?` | string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/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/docs-beta/classes/identity)‹›)\[] | - | **Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*IdentityWithClaims*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/identitywithclaims.md)*››* *** ### revokeClaims ▸ **revokeClaims**(`args`: Pick‹[ModifyClaimsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/globals#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››* *Defined in* [*src/Claims.ts:156*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/Claims.ts#L156) 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/beta/docs/interfaces/proceduremethod.md), which means you can call [revokeClaims.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/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/docs-beta/globals#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue)*‹void››*