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 the /parties endpoint returns a paginated list of parties, optionally filtered by provided query parameters.
Lists and searches parties
get
Search for participant information from your Participant Registry. Various search parameters are supported as shown below. Results are paginated to improve performance and usability. Pagination: - Use page parameter to specify which page to retrieve (starts at 1) - Use pageSize parameter to control number of items per page (max 100, default 10) - Response includes pagination metadata (currentPage, pageSize, totalPages, etc.) - Example: /parties?page=2&size=20&name=*Corporation Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwtHeader' and 'jwtPayloadPartiesToken' 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.
Query parameters
idstringOptional
Optional parameter used to search by a party's ID. Endpoint /parties/{partyId} may be used instead.
Example: did:ishare:EU.NL.NLNTR-12345678
alsoKnownAsstringOptional
Optional parameter used to search by a party's alsoKnownAs identifier.
Example: did:ebsi:LEIXG-724500AZSGBRY55MNS59
namestringOptional
Optional parameter used to search by party's name. Can contain a single * as wildcard.
Example: *Corporation
pageinteger · min: 1Optional
Page number to retrieve (starts at 1). Used for pagination when results exceed the page size.
Default: 1Example: 1
pageSizeinteger · min: 1 · max: 100Optional
Number of items per page (maximum 100). Used for pagination to control the number of results returned.
Default: 10Example: 10
Responses
200Success
application/json
get
/parties
200Success
Request model
URL query parameters may be used to filter the parties that are returned.
idString. Search by a party's ID. The endpoint Parties (single party) [GET] may be used instead.
Example: {url}/parties?id=did:ishare:EU.NL.NLNTR-12345678
alsoKnownAsString. Search for an identifier in a parties alsoKnownAs array.
Example: {url}/parties?alsoKnownAs=did:elsi:LEIXG-724500AZSGBRY55MNS59
nameString. Search for a party name. May contain a single * as wildcard.
Example: {url}/parties?name=*corporation
claimFilterObject. One or more key/value pairs used to filter parties based on claim attributes. The key represents the property name, the value the search criterion. The filters will be processed with AND logic, which means that all filters must result in true for a party to be returned. To filter on a property inside a claim, construct the key as <claimType>.<propertyName>. Boolean values must be true or false. Refer to Claim models for a list of available claimTypes and propertyNames.
Example: {url}/parties?claimFilter[frameworkRole.roleId]=ServiceConsumer&claimFilter[frameworkRole.status]=active&claimFilter[dataspaceMembership.dataspaceId]=EU.DSP.EXAMPLE&claimFilter[dataspaceMembership.status]=active will return all active Service Consumers in data space EU.DSP.EXAMPLE
pageInteger. Page number to retrieve (starts at 1). Used for pagination when results exceed the page size.
pageSizeInteger. Number of items per page (maximum 100). Used for pagination to control the number of results returned.
Pagination attributescurrentPage, pageSize, totalPages, totalCount and count.Contained inpartiesInfo.
The data object, containing an array of objects with the following attributes:
idString. Contained in data. (Required)
Primary identifier (iSHARE-ID) of the party.
nameString. Contained in data. (Required)
Name of the party.
alsoKnownAsArray of strings. Contained in data.
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).
claimsArray of objects. Contained in data. (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: