> 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-alpha/classes/api_client_claims.claims.md). # api\_client\_Claims.Claims [@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / [api/client/Claims](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims.md) / Claims ## Class: Claims [api/client/Claims](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims.md).Claims Handles all Claims related functionality ### Table of contents #### 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`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> 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-alpha/interfaces/types.proceduremethod.md), which means you can call [addClaims.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyclaims.md#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md) | **Returns** `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> **Defined in** [api/client/Claims.ts:126](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L126) *** #### addInvestorUniquenessClaim ▸ **addInvestorUniquenessClaim**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> Add an Investor Uniqueness Claim to the signing Identity **`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [addInvestorUniquenessClaim.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_addinvestoruniquenessclaim.addinvestoruniquenessclaimparams.md) | | `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md) | **Returns** `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> **Defined in** [api/client/Claims.ts:113](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L113) *** #### editClaims ▸ **editClaims**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> 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-alpha/interfaces/types.proceduremethod.md), which means you can call [editClaims.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyclaims.md#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md) | **Returns** `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> **Defined in** [api/client/Claims.ts:139](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L139) *** #### getCddClaims ▸ **getCddClaims**(`opts?`): `Promise`<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`CddClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim.md)>\[]> Retrieve the list of CDD claims for a target Identity **Parameters** | Name | Type | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `opts` | `Object` | - | | `opts.includeExpired?` | `boolean` | whether to include expired claims. Defaults to true | | `opts.target?` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`CddClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim.md)>\[]> **Defined in** [api/client/Claims.ts:310](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L310) *** #### getClaimScopes ▸ **getClaimScopes**(`opts?`): `Promise`<[`ClaimScope`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope.md)\[]> 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** | Name | Type | Description | | -------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `opts` | `Object` | - | | `opts.target?` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity for which to fetch claim scopes (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimScope`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope.md)\[]> **Defined in** [api/client/Claims.ts:260](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L260) *** #### getIdentitiesWithClaims ▸ **getIdentitiesWithClaims**(`opts?`): `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`IdentityWithClaims`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims.md)>> Retrieve a list of Identities with claims associated to them. Can be filtered using parameters **`note`** supports pagination **`note`** uses the middleware **Parameters** | Name | Type | Description | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `opts` | `Object` | - | | `opts.claimTypes?` | ([`Accredited`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#accredited) \| [`Affiliate`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#affiliate) \| [`BuyLockup`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#buylockup) \| [`SellLockup`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#selllockup) \| [`CustomerDueDiligence`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#customerduediligence) \| [`KnowYourCustomer`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#knowyourcustomer) \| [`Jurisdiction`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#jurisdiction) \| [`Exempted`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#exempted) \| [`Blocked`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#blocked) \| [`InvestorUniqueness`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#investoruniqueness) \| [`NoType`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#notype) \| [`NoData`](/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype.md#nodata))\[] | types of the claims to fetch. Defaults to any type | | `opts.includeExpired?` | `boolean` | whether to include expired claims. Defaults to true | | `opts.scope?` | [`Scope`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope.md) | scope of the claims to fetch. Defaults to any scope | | `opts.size?` | `BigNumber` | page size | | `opts.start?` | `BigNumber` | page offset | | `opts.targets?` | (`string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md))\[] | Identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets | | `opts.trustedClaimIssuers?` | (`string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md))\[] | Identity IDs of claim issuers. Defaults to all claim issuers | **Returns** `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`IdentityWithClaims`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims.md)>> **Defined in** [api/client/Claims.ts:200](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L200) *** #### getInvestorUniquenessClaims ▸ **getInvestorUniquenessClaims**(`opts?`): `Promise`<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`InvestorUniquenessClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim.md)>\[]> Retrieve the list of InvestorUniqueness claims for a target Identity **Parameters** | Name | Type | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `opts` | `Object` | - | | `opts.includeExpired?` | `boolean` | whether to include expired claims. Defaults to true | | `opts.target?` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`InvestorUniquenessClaim`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim.md)>\[]> **Defined in** [api/client/Claims.ts:334](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L334) *** #### getIssuedClaims ▸ **getIssuedClaims**(`opts?`): `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`Claim`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#claim)>>> Retrieve all claims issued by an Identity **`note`** supports pagination **`note`** uses the middleware **Parameters** | Name | Type | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | | `opts` | `Object` | - | | `opts.includeExpired?` | `boolean` | whether to include expired claims. Defaults to true | | `opts.size?` | `BigNumber` | - | | `opts.start?` | `BigNumber` | - | | `opts.target?` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`ClaimData`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata.md)<[`Claim`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#claim)>>> **Defined in** [api/client/Claims.ts:165](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L165) *** #### getTargetingClaims ▸ **getTargetingClaims**(`opts?`): `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`IdentityWithClaims`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims.md)>> Retrieve all claims issued about an Identity, grouped by claim issuer **`note`** supports pagination **`note`** uses the middleware (optional) **Parameters** | Name | Type | Description | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `opts` | `Object` | - | | `opts.includeExpired?` | `boolean` | whether to include expired claims. Defaults to true | | `opts.scope?` | [`Scope`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope.md) | - | | `opts.size?` | `BigNumber` | - | | `opts.start?` | `BigNumber` | - | | `opts.target?` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity for which to fetch targeting claims (optional, defaults to the signing Identity) | | `opts.trustedClaimIssuers?` | (`string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md))\[] | - | **Returns** `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`IdentityWithClaims`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims.md)>> **Defined in** [api/client/Claims.ts:361](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L361) *** #### revokeClaims ▸ **revokeClaims**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> 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-alpha/interfaces/types.proceduremethod.md), which means you can call [revokeClaims.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyclaims.md#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md) | **Returns** `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>> **Defined in** [api/client/Claims.ts:152](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Claims.ts#L152)