> 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-post.md).

# Claims \[POST]

The `POST` request to the `/parties/{partyId}/claims` endpoint can be used to create a new claim for a party in the Participant Registry.

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

## Create new claim for a party

> Used to create a new claim for a participant.\
> The request body carries the claim as an iSHARE signed JSON Web Token in the attribute \`claimCreationToken\`. Please refer to the iSHARE JWT header (see <https://dev.ishare.eu/reference/ishare-jwt>) and the model 'jwtPayloadClaimCreationToken' 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.

```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":{"claimCreationRequest":{"title":"ClaimCreationRequest","description":"Request body for creating a claim. The claimCreationToken is an iSHARE signed JSON Web Token; its decoded payload is described by 'jwtPayloadClaimCreationToken'.","required":["claimCreationToken"],"type":"object","properties":{"claimCreationToken":{"type":"string","format":"application/jwt","description":"Example token. Its signature does not validate."}}},"claimsResponse":{"title":"ClaimsResponse","type":"object","properties":{"claimsToken":{"type":"string","format":"application/jwt","description":"Example token. Its payload was edited after signing, so the signature of this example does not validate."}}},"problemDetails":{"title":"Problem details","description":"Machine-readable details of an HTTP API error, conforming to RFC 9457.","type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri-reference","description":"URI reference identifying the problem type.","default":"about:blank"},"title":{"type":"string","description":"Short, human-readable summary of the problem type."},"status":{"type":"integer","format":"int32","minimum":400,"maximum":599,"description":"HTTP status code generated by the server."},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","format":"uri-reference","description":"URI reference identifying this occurrence of the problem."}}}},"responses":{"badRequest":{"description":"The request is malformed or fails validation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/problemDetails"}}}}}},"paths":{"/[v3.0]/parties/{partyId}/claims":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimCreationRequest"}}},"required":true},"tags":["Participant Registry (Optional)"],"parameters":[{"style":"simple","name":"partyId","description":"The id of the party for who a claim must be added. 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.","schema":{"type":"string"},"in":"path","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimsResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/badRequest"},"401":{"description":"authentication is required and has failed or has not yet been provided."}},"deprecated":false,"operationId":"register-new-claim","summary":"Create new claim for a party","description":"Used to create a new claim for a participant.\nThe request body carries the claim as an iSHARE signed JSON Web Token in the attribute `claimCreationToken`. Please refer to the iSHARE JWT header (see https://dev.ishare.eu/reference/ishare-jwt) and the model 'jwtPayloadClaimCreationToken' 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."}}}}
```

### Request model

The following URL parameter must be used.

* `partyId` {url}/parties/{**partyId**} <mark style="color:red;">(Required)</mark>\
  **String**. The id of the party for who a new claim must be registered. 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.

The request body is a JSON object with one attribute, `claimCreationToken`: 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 claim in the attribute `claim`. Refer to [Claim models](https://dev.ishare.eu/reference/claim-models.md) for an overview of available claims. 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`.

In the `POST` request the `id` and `registrarId` fields may be omitted, as they will be provided by the Participant Registry.

### Example request

```json
POST /parties/did:ishare:EU.NL.NTRNL-12345678/claims HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json

{
  "claimCreationToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlHaURDQ0JIQ2dBd0lCQWdJ…"
}
```

The payload of `claimCreationToken`, decoded:

```json
{
  "iss": "did:ishare:EU.NL.NTRNL-10000001",
  "sub": "did:ishare:EU.NL.NTRNL-10000001",
  "aud": "did:ishare:EU.NL.NTRNL-10000000",
  "jti": "0868904d8ed94c01a0a4d6dd5c65ce92",
  "exp": 1740675316,
  "iat": 1740675286,
  "claim": {
    "registrarId": "did:ishare:EU.NL.NTRNL-10000000",
    "type": "frameworkCompliance",
    "frameworkId": "iSHARE",
    "status": "active",
    "startDate": "2025-01-01T00:00:00.000Z",
    "endDate": "2026-12-31T00:00:00.000Z",
    "additionalInfo": {
      "description": "Example description",
      "publiclyPublishable": true,
      "website": "https://www.example.com"
    }
  }
}
```

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-post.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.
