> For the complete documentation index, see [llms.txt](https://dev.ishare.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ishare.eu/participant-registry-role/claims-single-claim-patch.md).

# Claims (single claim) \[PATCH]

The `PATCH` request to the `/parties/{partyId}/claims/{claimId}` endpoint can be used to update a claim for a party in the Participant Registry.

{% hint style="info" %}
The `PATCH` request to the `/parties/{partyId}/claims/{claimId}` is an **OPTIONAL** endpoint.
{% endhint %}

## Update claim information

> Used to partially update a specific claim of an iSHARE participant in the Participant  Registry. This flexible update mechanism allows updating any claim property using a key-value structure in the request body.\
> The key represents the property path within the claim (using dot notation for  nested properties), and the value is the new value to set. Only the provided  fields will be updated, other fields remain unchanged.\
> Examples of property paths: - "status" - Update claim status - "startDate" - Update validity start time (ISO 8601 date-time) - "endDate" - Update validity end time (ISO 8601 date-time) - "roleId" - Update the role ID of a framework or dataspace role claim - "loa" - Update the level of assurance of a role claim - "agreementId" - Update the agreement ID of an agreement claim - "title" - Update the title of a role or agreement claim - "additionalInfo.companyEmail" - Update the company email in the additional info of a framework compliance or dataspace membership claim\
> The claim ID and type cannot be changed through this operation.\
> The request body carries the update as an iSHARE signed JSON Web Token in the attribute \`claimUpdateToken\`. Please refer to the iSHARE JWT header (see <https://dev.ishare.eu/reference/ishare-jwt>) and the model 'jwtPayloadClaimUpdateToken' which indicate what the decoded token must look like. Its \`aud\` is the party ID of this Participant Registry, and its \`iss\` and \`sub\` are the party ID of the client that sends the request. A request whose body is not such a token is rejected with 400.\
> Server response is an iSHARE signed JSON Web Token. Please refer to the iSHARE JWT header (see <https://dev.ishare.eu/reference/ishare-jwt>) and the model 'jwtPayloadClaimToken' which indicate what the decoded response will look like.

```json
{"openapi":"3.0.0","info":{"title":"iSHARE API specifications","version":"3.0.1"},"tags":[{"name":"Participant Registry (Optional)","description":"Optional endpoints for the iSHARE Participant Registry API."}],"servers":[{"description":"iSHARE UAT network base domain","url":"https://isharetest.net"},{"description":"iSHARE TEST network base domain","url":"https://test.ishareworks.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed."}},"schemas":{"claimUpdateRequest":{"title":"ClaimUpdateRequest","description":"Request body for partially updating a claim. The claimUpdateToken is an iSHARE signed JSON Web Token; its decoded payload is described by 'jwtPayloadClaimUpdateToken'.","required":["claimUpdateToken"],"type":"object","properties":{"claimUpdateToken":{"type":"string","format":"application/jwt","description":"Example token. Its signature does not validate."}}},"claimResponse":{"title":"ClaimResponse","type":"object","properties":{"claimToken":{"type":"string","format":"application/jwt","description":"Example token. Its payload was edited after signing, so the signature of this example does not validate."}}}}},"paths":{"/[v3.0]/parties/{partyId}/claims/{claimId}":{"patch":{"tags":["Participant Registry (Optional)"],"parameters":[{"style":"simple","name":"partyId","description":"The id of the party whose claim must be updated. Can be anyone of  the party id from id or alsoKnownAs attributes of that participant. Since all participants are automatically allocated the derived  ishare did, that id is always an option to search for a participant.\nWhen updating alsKnownAs all existing values must also be provided.  Implementations should raise an error if any of the existing values  are missing (meaning deletion) as Ids in this field cannot be  deleted once registered.","schema":{"type":"string"},"in":"path","required":true},{"style":"simple","name":"claimId","description":"The id of the claim that must be updated.","schema":{"type":"string"},"in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimResponse"}}},"description":"OK"},"400":{"description":"Bad Request - Invalid input data"},"404":{"description":"Not Found - Party or claim not found"},"500":{"description":"Internal Server Error"}},"deprecated":false,"operationId":"update-claim-information","summary":"Update claim information","description":"Used to partially update a specific claim of an iSHARE participant in the Participant  Registry. This flexible update mechanism allows updating any claim property using a key-value structure in the request body.\nThe key represents the property path within the claim (using dot notation for  nested properties), and the value is the new value to set. Only the provided  fields will be updated, other fields remain unchanged.\nExamples of property paths: - \"status\" - Update claim status - \"startDate\" - Update validity start time (ISO 8601 date-time) - \"endDate\" - Update validity end time (ISO 8601 date-time) - \"roleId\" - Update the role ID of a framework or dataspace role claim - \"loa\" - Update the level of assurance of a role claim - \"agreementId\" - Update the agreement ID of an agreement claim - \"title\" - Update the title of a role or agreement claim - \"additionalInfo.companyEmail\" - Update the company email in the additional info of a framework compliance or dataspace membership claim\nThe claim ID and type cannot be changed through this operation.\nThe request body carries the update as an iSHARE signed JSON Web Token in the attribute `claimUpdateToken`. Please refer to the iSHARE JWT header (see https://dev.ishare.eu/reference/ishare-jwt) and the model 'jwtPayloadClaimUpdateToken' which indicate what the decoded token must look like. Its `aud` is the party ID of this Participant Registry, and its `iss` and `sub` are the party ID of the client that sends the request. A request whose body is not such a token is rejected with 400.\nServer response is an iSHARE signed JSON Web Token. Please refer to the iSHARE JWT header (see https://dev.ishare.eu/reference/ishare-jwt) and the model 'jwtPayloadClaimToken' which indicate what the decoded response will look like."}}}}
```

### Request model

The following URL parameters must be used.

* `partyId` {url}/parties/{**partyId**} <mark style="color:red;">(Required)</mark>\
  **String**. The id of the party for who a claim must be updated. Can be anyone of the party id from id or alsoKnownAs attributes of that participant. Since all participants are automatically allocated the derived ishare did, that id is always an option to search for a participant.
* `claimId` {url}/parties/{partyId}/claims/{**claimId**} <mark style="color:red;">(Required)</mark>\
  **String**. The id of the claims that must be updated.

The body may contain any number of key/value pairs that define what properties must be updated **in the specified claimId only**.

* The **key** represents the property path within the claim (using dot notation for nested properties)
* The **value** is the new value to set.

Take into account the following:

* Only the provided fields will be updated, other fields remain unchanged.
* Note that claims cannot be deleted, but instead the status can be set to revoked or inactive.
* Because the {claimId} must be provided in the URL, only the properties of that\
  specific claim may be updated in one request. If you want to update multiple claims, you must make multiple requests.
* The claim ID and type cannot be changed through this operation.

Examples of property paths:

* "status" - Update claim status
* "startDate" - Update validity start time (ISO 8601 date-time)
* "endDate" - Update validity end time (ISO 8601 date-time)
* "roleId" - Update role ID in role claim
* "additionalInfo.companyEmail" - Update contact email in additional info

The request body is a JSON object with one attribute, `claimUpdateToken`: an iSHARE signed JSON Web Token, as specified in [iSHARE JWT](https://dev.ishare.eu/reference/ishare-jwt.md). Besides the iSHARE JWT claims, its payload contains the key/value pairs in the attribute `claimUpdate`. Refer to [Claim models](https://dev.ishare.eu/reference/claim-models.md) for the properties of each claim. The `aud` claim is the party ID of the Participant Registry; `iss` and `sub` are the party ID of the client that sends the request. A request whose body is not such a token is rejected with `400`.

### Example request

The following is an example request that extends the validity of a claim.

```json
PATCH /parties/did:ishare:EU.NL.NTRNL-12345678/claims/5ffb4bb9-2020-4045-a922-3bd84e78f709 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json

{
  "claimUpdateToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlHaURDQ0JIQ2dBd0lCQWdJ…"
}
```

The payload of `claimUpdateToken`, decoded:

```json
{
  "iss": "did:ishare:EU.NL.NTRNL-10000001",
  "sub": "did:ishare:EU.NL.NTRNL-10000001",
  "aud": "did:ishare:EU.NL.NTRNL-10000000",
  "jti": "0868904d8ed94c01a0a4d6dd5c65ce93",
  "exp": 1740675316,
  "iat": 1740675286,
  "claimUpdate": {
    "status": "active",
    "endDate": "2026-12-31T00:00:00.000Z"
  }
}
```

The token above is shortened; the full example token is in the OpenAPI specification. It carries the certificate chain of the Test Service Consumer, and its signature does not validate.

### Response model

The response will be equal to the response of the [GET request for retrieving a single claim](https://dev.ishare.eu/participant-registry-role/claims-single-claim-get.md). Refer to the response model as defined here.

### Example response

Refer to the example response under the [GET request](https://dev.ishare.eu/participant-registry-role/claims-single-claim-get.md) definition.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://dev.ishare.eu/participant-registry-role/claims-single-claim-patch.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
