# api\_client\_Claims.Claims [@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/client/Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims) / Claims ## Class: Claims [api/client/Claims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims).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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [addClaims.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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-alpha/modules-1/api_procedures_modifyclaims#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) | **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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [addInvestorUniquenessClaim.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_addinvestoruniquenessclaim.addinvestoruniquenessclaimparams) | | `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) | **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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [editClaims.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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-alpha/modules-1/api_procedures_modifyclaims#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) | **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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`CddClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim)>\[]> 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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`CddClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim)>\[]> **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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope)\[]> 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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | Identity for which to fetch claim scopes (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimScope`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope)\[]> **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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`IdentityWithClaims`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims)>> 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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#accredited) \| [`Affiliate`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#affiliate) \| [`BuyLockup`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#buylockup) \| [`SellLockup`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#selllockup) \| [`CustomerDueDiligence`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#customerduediligence) \| [`KnowYourCustomer`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#knowyourcustomer) \| [`Jurisdiction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#jurisdiction) \| [`Exempted`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#exempted) \| [`Blocked`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#blocked) \| [`InvestorUniqueness`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#investoruniqueness) \| [`NoType`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#notype) \| [`NoData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype#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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope) | scope of the claims to fetch. Defaults to any scope | | `opts.size?` | `BigNumber` | page size | | `opts.start?` | `BigNumber` | page offset | | `opts.targets?` | (`string` \| [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity))\[] | Identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets | | `opts.trustedClaimIssuers?` | (`string` \| [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity))\[] | Identity IDs of claim issuers. Defaults to all claim issuers | **Returns** `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`IdentityWithClaims`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims)>> **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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`InvestorUniquenessClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim)>\[]> 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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | Identity for which to fetch CDD claims (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ClaimData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`InvestorUniquenessClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim)>\[]> **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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`ClaimData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`Claim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | Identity (optional, defaults to the signing Identity) | **Returns** `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`ClaimData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata)<[`Claim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/types#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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`IdentityWithClaims`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims)>> 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`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope) | - | | `opts.size?` | `BigNumber` | - | | `opts.start?` | `BigNumber` | - | | `opts.target?` | `string` \| [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | Identity for which to fetch targeting claims (optional, defaults to the signing Identity) | | `opts.trustedClaimIssuers?` | (`string` \| [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity))\[] | - | **Returns** `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`IdentityWithClaims`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims)>> **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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [revokeClaims.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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-alpha/modules-1/api_procedures_modifyclaims#modifyclaimsparams), `"claims"`> | | `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) | **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)