search

Claims (single claim) [GET]

circle-info

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.

hashtag
Retrieves one claim of a party

get

Used to obtain a specific claim using its id about an iSHARE participant from the Participant Registry. It returns the exact claim for the exact participant matched using its ID.

Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwtHeader' and 'jwtPayloadClaimToken' which indicate what the decoded response will look like.

Authorizations
AuthorizationstringRequired

OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed.

Path parameters
partyIdstringRequired

The id of the party whose claim 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.

Example: did:ishare:EU.NL.NTRNL-12345678
claimIdstringRequired

The id of the claim that must be fetched.

Example: 5ffb4bb9-2020-4045-a922-3bd84e78f709
Responses
chevron-right
200

OK

application/json
get
/parties/{partyId}/claims/{claimId}
200

OK

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

hashtag
Example request

hashtag
Response model

Decoded claimsToken parameters:

The model of the claimToken JWT response is available on the iSHARE OpenAPI documentationarrow-up-right. 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.

hashtag
Example response

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

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

PreviousClaims [POST]NextClaims (single claim) [OPTIONS]

Last updated