> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/claims.md). # Claims Handles all Claims related functionality ## Hierarchy * **Claims** ## Index ### Methods * [addClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#addclaims) * [addInvestorUniquenessClaim](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#addinvestoruniquenessclaim) * [editClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#editclaims) * [getCddClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#getcddclaims) * [getClaimScopes](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#getclaimscopes) * [getIdentitiesWithClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#getidentitieswithclaims) * [getInvestorUniquenessClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#getinvestoruniquenessclaims) * [getIssuedClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#getissuedclaims) * [getTargetingClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#gettargetingclaims) * [revokeClaims](/polymesh-sdk-api-reference/docs-v9/classes/claims.md#revokeclaims) ## Methods ### addClaims ▸ **addClaims**(`args`: Pick‹[ModifyClaimsParams](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* *Defined in* [*src/Claims.ts:127*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L127) 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](/polymesh-sdk-api-reference/docs-v9/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](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* ### addInvestorUniquenessClaim ▸ **addInvestorUniquenessClaim**(`args`: [AddInvestorUniquenessClaimParams](/polymesh-sdk-api-reference/docs-v9/interfaces/addinvestoruniquenessclaimparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* *Defined in* [*src/Claims.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L114) Add an Investor Uniqueness Claim to the current Identity **`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/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 | Description | | ------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- | | `args` | [AddInvestorUniquenessClaimParams](/polymesh-sdk-api-reference/docs-v9/interfaces/addinvestoruniquenessclaimparams.md) | | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | - | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* ### editClaims ▸ **editClaims**(`args`: Pick‹[ModifyClaimsParams](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* *Defined in* [*src/Claims.ts:140*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L140) 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](/polymesh-sdk-api-reference/docs-v9/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](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* ### getCddClaims ▸ **getCddClaims**(`opts`: object): *Promise‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*‹*[*CddClaim*](/polymesh-sdk-api-reference/docs-v9/globals.md#cddclaim)*›\[]›* *Defined in* [*src/Claims.ts:310*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md) | identity for which to fetch CDD claims (optional, defaults to the current Identity) | **Returns:** *Promise‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*‹*[*CddClaim*](/polymesh-sdk-api-reference/docs-v9/globals.md#cddclaim)*›\[]›* ### getClaimScopes ▸ **getClaimScopes**(`opts`: object): *Promise‹*[*ClaimScope*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimscope.md)*\[]›* *Defined in* [*src/Claims.ts:260*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md) | identity for which to fetch claim scopes (optional, defaults to the current Identity) | **Returns:** *Promise‹*[*ClaimScope*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimscope.md)*\[]›* ### getIdentitiesWithClaims ▸ **getIdentitiesWithClaims**(`opts`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*IdentityWithClaims*](/polymesh-sdk-api-reference/docs-v9/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:201*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L201) 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](/polymesh-sdk-api-reference/docs-v9/enums/targettreatment.md#exclude)‹[ClaimType](/polymesh-sdk-api-reference/docs-v9/enums/claimtype.md), [InvestorUniquenessV2](/polymesh-sdk-api-reference/docs-v9/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](/polymesh-sdk-api-reference/docs-v9/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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets | | `trustedClaimIssuers?` | (string \| [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*IdentityWithClaims*](/polymesh-sdk-api-reference/docs-v9/interfaces/identitywithclaims.md)*››* ### getInvestorUniquenessClaims ▸ **getInvestorUniquenessClaims**(`opts`: object): *Promise‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](/polymesh-sdk-api-reference/docs-v9/globals.md#investoruniquenessclaim)*›\[]›* *Defined in* [*src/Claims.ts:334*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md) | identity for which to fetch CDD claims (optional, defaults to the current Identity) | **Returns:** *Promise‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*‹*[*InvestorUniquenessClaim*](/polymesh-sdk-api-reference/docs-v9/globals.md#investoruniquenessclaim)*›\[]›* ### getIssuedClaims ▸ **getIssuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*››* *Defined in* [*src/Claims.ts:166*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L166) 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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md) | identity (optional, defaults to the current Identity) | **Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*››* ### getTargetingClaims ▸ **getTargetingClaims**(`opts`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*IdentityWithClaims*](/polymesh-sdk-api-reference/docs-v9/interfaces/identitywithclaims.md)*››* *Defined in* [*src/Claims.ts:361*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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](/polymesh-sdk-api-reference/docs-v9/interfaces/scope.md) | - | | `size?` | undefined \| number | - | | `start?` | undefined \| number | - | | `target?` | string \| [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md) | identity for which to fetch targeting claims (optional, defaults to the current Identity) | | `trustedClaimIssuers?` | (string \| [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | - | **Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*IdentityWithClaims*](/polymesh-sdk-api-reference/docs-v9/interfaces/identitywithclaims.md)*››* ### revokeClaims ▸ **revokeClaims**(`args`: Pick‹[ModifyClaimsParams](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"›, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››* *Defined in* [*src/Claims.ts:153*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/Claims.ts#L153) 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](/polymesh-sdk-api-reference/docs-v9/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](/polymesh-sdk-api-reference/docs-v9/globals.md#modifyclaimsparams), "claims"› | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*