Claims (single claim) [GET]

This page must be considered part of the iSHARE Framework

This page is considered normative and is therefore compliant with RFC 2119.

The GET request to /parties/{partyId}/claims/{claimId} endpoint will return a single claim.

Request model

The following URL parameters must be used.

  • partyId {url}/parties/{partyId} (Required) String. The id of the party whose claims must be fetched. 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} (Required) String. The id of the claims that must be fetched.

Example request

Response model

Decoded claimsToken parameters:

The model of the claimToken JWT response is available on the iSHARE OpenAPI documentation. The model contains the following attributes:

  • Standard iSHARE JWT attributes: aud, iss, sub, exp, iat, jti

  • The claimInfo object containing:

    • claim Objects. Contained in claimInfo. Registered claim. Refer to Claim models for an overview of available claims.

Example response

The response contains an encoded JWT, which looks like this:

After decoding, the example content of the JWT looks like this:

Last updated