Ctrlk
Other resources
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Parties (single party) [GET]

This page must be considered part of the iSHARE Framework

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

The endpoint /parties can also be used to retrieve just one party.

Request model

The following URL parameter 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.

Example request

Response model

Decoded partyToken parameters:

The model of the partyToken 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 partyInfo object containing:

    • id String. Contained in partyInfo. (Required) Primary identifier (iSHARE-ID) of the party.

    • name String. Contained in partyInfo. (Required) Name of the party.

    • alsoKnownAs Array of strings. Contained in partyInfo. Array of registered party ids of the party with which the party is also identified. Optional, because a party could be identified with only its iSHARE-ID (in the 'id' property).

    • claims Array of objects. Contained in partyInfo. (Required) Array of registered claims for the party. 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:

PreviousParties [POST]
NextParties (single party) [OPTIONS]

Last updated