API docs by Redocly

DSGO API definitions (2.0)

Download OpenAPI specification:

E-mail: dsgo@digigo.nu

This contains an overview of all the API endpoints as defined by the DSGO For specific information on API endpoints and data object see the documentation on API endpoints in the DSGO

Central Participant Registry

Endpoints for the DSGO Central Participant Registry. The /subscription and /token/revoke endpoint are optional for this role.

Find out more on the DSGO developer portal

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

GET /capabilities

Used to verify the technical capabilities of a party. Returns a capabilitiesInfo object as signed JWT (capabilitiesToken) or as plain JSON

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "capabilitiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /parties

Used to retrieve information about participants from the DSGO participant registry. Returns a partiesInfo object, either as a standard JSON object or as a signed JWT.

Authorizations:
bearerAuth
query Parameters
name
string
Example: name=Digigo

Used to search by a party name. MUST be the party name or contain a single * as wildcard instead

partyId
string
Example: partyId=did:ishare:EU.NL.NTRNL-12345678

Used to search by a party identifier. MUST contain a valid organisationID.

activeOnly
boolean
Default: false

When true, only active parties are returned. When false, both active and inactive parties are returned.

page
integer
Default: 1
Example: page=1

Page number for paginated results.

size
integer
Default: 10
Example: size=10

Number of items per page for paginated results.

format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "partiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

POST /parties

with post /parties, a ParticipantRegistry can add a new party in the DSGO participant registry. The response contains a partyToken, with the newly created partyInfo object

Authorizations:
bearerAuth
Request Body schema: application/json
required

basic party info

id
required
string

organisation ID (iSHARE DID) of the party to be created.

alsoKnownAs
Array of strings

Array with other identifiers of the party. Each identifier includes a prefix and must be a unique organisation ID

name
required
string

Organisation name, MUST be equal to the name registered at the Chamber of Commerce.

Responses

Request samples

Content type
application/json
{
  • "id": "did:ishare:EU.NL.NTRNL-98765432",
  • "alsoKnownAs": [
    ],
  • "name": "Tech Solutions B.V."
}

Response samples

Content type
application/json
{
  • "partyToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /parties/{partyId}

Used to retrieve information about a specific participant from the DSGO participant registry. Returns a partyInfo object, either as a standard JSON object or as a signed JWT.

Authorizations:
bearerAuth
path Parameters
partyId
required
string
Example: did:ishare:EU.NL.NTRNL-12345678

OrganisationID of the party

query Parameters
type
string
Enum: "frameworkCompliance" "dataspaceMembership" "frameworkRole" "dataspaceRole"
Example: type=frameworkCompliance

Used to filter by claim type.

dataspaceId
string
Value: "EU.DS.NL.DSGO"
Example: dataspaceId=EU.DS.NL.DSGO

Used to filter by dataspaceId, when type is dataspaceMembership or dataspaceRole.

frameworkId
string
Value: "iSHARE"
Example: frameworkId=iSHARE

Used to filter by frameworkId, when type is frameworkCompliance or frameworkRole

roleId
string
Enum: "ServiceConsumer" "ServiceProvider" "ServiceRightsHolder" "EntitledParty" "AuthorisationRegistry" "IdentityProvider" "ParticipantRegistry" "IdentityBroker" "GovernanceBody"
Example: roleId=ServiceProvider

Used to filter by roleId, when type is frameworkRole or dataspaceRole

format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "partyToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

PATCH /parties/{partyId}

with patch /parties/{partyId}, a ParticipantRegistry can update a party the created/manage in the DSGO participant registry

Authorizations:
bearerAuth
path Parameters
partyId
required
string
Example: did:ishare:EU.NL.NTRNL-12345678

OrganisationID of the party

Request Body schema: application/json

party info to be updated

id
required
string

Primary Identifier of the party within the DSGO. MUST be an iSHARE DID

alsoKnownAs
Array of strings

Other identifiers of the party. Each identifier must include a prefix and represent a unique organisation ID allowed by DSGO

name
string

Organisation name as registered at the Chamber of Commerce.

Responses

Request samples

Content type
application/json
{
  • "id": "did:ishare:EU.NL.NTRNL-12345678",
  • "alsoKnownAs": [
    ]
}

Response samples

Content type
application/json
{
  • "partyToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /parties/{partyId}/claims/{claimId}

Used to obtain a single claim of a participant from the DSGO participant registry. Returns a claim object, either as a standard JSON object or as a signed JWT.

Authorizations:
bearerAuth
path Parameters
partyId
required
string
Example: did:ishare:EU.NL.NTRNL-12345678

Organisation ID of the party

claimId
required
string
Example: 60d4239e-6e5d-4fb1-b37f-18ab19cd90c6

Unique identifier of the claim

query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "claimToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

PATCH /parties/{partyId}/claims/{claimId}

Parties with role ParticipantRegistry can update the status of a dataspaceRoleClaim for parties they create and manage in the central participant registry with a PATCH

Authorizations:
bearerAuth
path Parameters
partyId
required
string
Example: did:ishare:EU.NL.NTRNL-12345678

Organisation ID of the party

claimId
required
string
Example: 60d4239e-6e5d-4fb1-b37f-18ab19cd90c6

Unique identifier of the claim

Request Body schema: application/json

status info to be updated

status
required
string
Enum: "Active" "NotAactive" "Revoked"

New status of the dataspaceRole claim.

endDate
string <date-time>

New endDate of the adherence status. Must be in the future. Only applicable for a status change to Active.

Responses

Request samples

Content type
application/json
{
  • "status": "Revoked"
}

Response samples

Content type
application/json
{
  • "claimToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

POST /parties/{partyId}/claims

A ParticipantRegistry can add a dataspaceRole claim to parties they create and manage in the DSGO central participant registry. This dataspaceRole can only be a legal Service Consumer or a Service Rights Holder.

Authorizations:
bearerAuth
path Parameters
partyId
required
string
Example: did:ishare:EU.NL.NTRNL-12345678

Organisation ID of the party

Request Body schema: application/json

dataspaceRole claim info to be added

type
required
string
Value: "dataspaceRole"
dataspaceId
required
string
Value: "EU.DS.NL.DSGO"
roleId
required
string
Enum: "ServiceConsumer" "ServiceRightsHolder"
title
required
string
Enum: "Service Consumer" "Service Rights Holder"
registrarId
required
string

Primary Identifier (iSHARE DID) of the ParticipantRegistry that manages the claim.

loa
required
string
Value: "not-applicable"
compliancyVerified
required
string
Value: "not-applicable"
legalAdherence
required
string
Value: "no"
status
required
string
Value: "Pending"
startDate
required
string
endDate
required
string

Date and time which states when the adherence status ends. May be null

Responses

Request samples

Content type
application/json
{
  • "type": "dataspaceRole",
  • "dataspaceId": "EU.DS.NL.DSGO",
  • "roleId": "ServiceRightsHolder",
  • "title": "Service Rights Holder",
  • "registrarId": "did:ishare:EU.NL.NTRNL-00000001",
  • "loa": "not-applicable",
  • "compliancyVerified": "not-applicable",
  • "legalAdherence": "no",
  • "status": "Pending",
  • "startDate": null,
  • "endDate": null
}

Response samples

Content type
application/json
{
  • "claimToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /dataspaces

Used to obtain information about dataspaces that are connected to the central participant registry.

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "dataspacesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /frameworks

Used to obtain information about Trust Frameworks that are connected to the central participant registry.

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "frameworksToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /dataServices

Used to obtain information about data services provided by this data service provider.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "dataServicesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /trustedList

Used to obtain a list of all eIDAS-qualified trusted certificate authorities in DSGO from the participant registry. Returns a trustedList object, either as a standard JSON object or as a signed JWT.

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "trustedListToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /subscriptions

This is an example of a HTTP GET to get a list of the available subscriptions within the collection

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "count": 4,
  • "subscriptions": [
    ]
}

POST /subscription

This is an example of a HTTP POST to create a subscription

Authorizations:
bearerAuth
Request Body schema: application/json
required

HTTP body must contain a subscription object, in accordance to the subscription as defined by the data service provider

resource_type
required
string

String representing the object type

start_date
string

contains the date when the subscription becomes valid as a UNIX timestamp

end_date
string

contains the end date and time of the subscription as a UNIX timestamp

event_type
required
Array of strings

Label of the event that is subscribed to as defined by the data service provider.

webhook_url
required
string

url that notifications shall be sent to

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "id": "sub_123",
  • "resource_type": "subscription",
  • "href": "/subscriptions/sub_123",
  • "created_date": "1709293404",
  • "start_date": "1711922400",
  • "end_date": "1774994400",
  • "consumer_id": "EU.EORI.NL000123456",
  • "provider_id": "EU.EORI.NL000345678",
  • "description": "detailed description of the subscription",
  • "event_type": [
    ],
  • "status": "active",
  • "webhook_url": "https://example.com/notifications"
}

GET /subscriptions/{id}

This is an example of a HTTP GET to request a specific subscription

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: sub_123

subscription URI

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DELETE /subscriptions/{id}

This is an example of a HTTP DELETE to remove a specific subscription

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: sub_123

subscription URI

Responses

POST /subscriptions/{id}/test

This is an example of Triggering the sending of a notification to test a /notifications endpoint

Authorizations:
bearerAuth
path Parameters
id
required
string

subscription URI

Responses

Response samples

Content type
application/json
{
  • "id": "eve_123",
  • "class": "event",
  • "event_type": "Modified",
  • "dateTime": "1663801217",
  • "description": "Detailed description of the event",
  • "eventData": "data record xyz has been modified by zyx"
}

Data Service Provider

Endpoints for the Data Service Provider. The /subscription and /token/revoke endpoint are optional for this role.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

GET /capabilities

Used to verify the technical capabilities of a party. Returns a capabilitiesInfo object as signed JWT (capabilitiesToken) or as plain JSON

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "capabilitiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /dataServices

Used to obtain information about data services provided by this data service provider.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "dataServicesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /resources (example)

This is an example of a HTTP GET to get a list of the available resources within the collection

Authorizations:
bearerAuth
header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Responses

Response samples

Content type
application/json
{
  • "count": 4,
  • "resources": [
    ]
}

POST /resources (example)

This is an example of a HTTP POST to create data at a resource

Authorizations:
bearerAuth
header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Request Body schema: application/json
required

HTTP body must contain data that should be created, formatted in accordance to the data service

object (resource)

resource should be according to the data format specified in the specific data service

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "005",
  • "href": "/resources/005",
  • "description": "Hex value of the colour magenta"
}

GET /resources/{id} (example)

This is an example of a HTTP GET to request a specific resource

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 005

resource URI

header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

PUT /resources/{id} (example)

This is an example of a HTTP PUT to replace data at a resource

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 005

resource URI

header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Request Body schema: application/json
required

HTTP body must contain data that the resource should be replaced with, formatted in accordance to the data service

object (resource)

resource should be according to the data format specified in the specific data service

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

PATCH /resources/{id} (example)

This is an example of a HTTP PATCH to edit data at a resource

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 005

Resource URI

header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Request Body schema: application/json
required

HTTP body must contain data that should be edited, formatted in accordance to the data service

operation
string

Operation to be performed on the resource

path
string

JSON pointer to the resource the operation should work on

value
string

Data to be edited at the resource

Responses

Request samples

Content type
application/json
[
  • {
    }
]

DELETE /resources/{id} (example)

This is an example of a HTTP DELETE to remove data at a resource

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 005

Resource URI

header Parameters
client_assertion
string

Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

digest
string

digest

LicensePurpose
string

License purpose

LicenseSubLicense
string

License purpose

LicenseEndDate
string

License purpose

service_header_generic
string

optional service specific headers

Responses

GET /subscriptions

This is an example of a HTTP GET to get a list of the available subscriptions within the collection

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "count": 4,
  • "subscriptions": [
    ]
}

POST /subscription

This is an example of a HTTP POST to create a subscription

Authorizations:
bearerAuth
Request Body schema: application/json
required

HTTP body must contain a subscription object, in accordance to the subscription as defined by the data service provider

resource_type
required
string

String representing the object type

start_date
string

contains the date when the subscription becomes valid as a UNIX timestamp

end_date
string

contains the end date and time of the subscription as a UNIX timestamp

event_type
required
Array of strings

Label of the event that is subscribed to as defined by the data service provider.

webhook_url
required
string

url that notifications shall be sent to

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "id": "sub_123",
  • "resource_type": "subscription",
  • "href": "/subscriptions/sub_123",
  • "created_date": "1709293404",
  • "start_date": "1711922400",
  • "end_date": "1774994400",
  • "consumer_id": "EU.EORI.NL000123456",
  • "provider_id": "EU.EORI.NL000345678",
  • "description": "detailed description of the subscription",
  • "event_type": [
    ],
  • "status": "active",
  • "webhook_url": "https://example.com/notifications"
}

GET /subscriptions/{id}

This is an example of a HTTP GET to request a specific subscription

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: sub_123

subscription URI

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DELETE /subscriptions/{id}

This is an example of a HTTP DELETE to remove a specific subscription

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: sub_123

subscription URI

Responses

POST /subscriptions/{id}/test

This is an example of Triggering the sending of a notification to test a /notifications endpoint

Authorizations:
bearerAuth
path Parameters
id
required
string

subscription URI

Responses

Response samples

Content type
application/json
{
  • "id": "eve_123",
  • "class": "event",
  • "event_type": "Modified",
  • "dateTime": "1663801217",
  • "description": "Detailed description of the event",
  • "eventData": "data record xyz has been modified by zyx"
}

Data Service Consumer

Endpoints for the Data Service Consumer. All endpoints are optional for this role.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

POST /webhook URL

This is an example of a Webhook URL for receiving notifications

Authorizations:
bearerAuth
Request Body schema: application/json
required

HTTP body contains a notification object

id
required
string

Unique identifier of the notification

class
required
string

String representing the object type

dateTime
required
string

Date and time that the notification was sent

consumer_id
required
string

Unique identifier of the data service consumer

provider_id
required
string

Unique identifier of the data service provider

subscriptionId
required
string

Unique identifier of the subscription under which the notification is sent

description
required
string

Description of the notification

required
object (event)

the event object contains all relevant neccesary information about possible events

Responses

Request samples

Content type
application/json
{
  • "id": "not_123",
  • "object": "notification",
  • "dateTime": "1663752217",
  • "consumer_id": "EU.EORI.NL000123456",
  • "provider_id": "EU.EORI.NL000345678",
  • "description": "",
  • "event": [
    ],
  • "subscriptionId": "sub_123"
}

Authorisation Registry

Endpoints that form the Authorisation Registry API specification.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

GET /capabilities

Used to verify the technical capabilities of a party. Returns a capabilitiesInfo object as signed JWT (capabilitiesToken) or as plain JSON

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "capabilitiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

POST /delegation

Used to obtain delegation evidence from an Entitled Party.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body contains object with information about the requested delegation

required
object
previous_steps
required
Array of strings
delegation_path
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "delegationRequest": {
    },
  • "previous_steps": [
    ],
  • "delegation_path": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "delegationToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

Identity Provider

Endpoints that form the Identity Provider API specification.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

GET /capabilities

Used to verify the technical capabilities of a party. Returns a capabilitiesInfo object as signed JWT (capabilitiesToken) or as plain JSON

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "capabilitiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

Data Service Rights Holder

Endpoints for the Data Service Rights Holder. All endpoints are optional for this role.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

GET /capabilities

Used to verify the technical capabilities of a party. Returns a capabilitiesInfo object as signed JWT (capabilitiesToken) or as plain JSON

Authorizations:
bearerAuth
query Parameters
format
string
Default: "jwt"
Enum: "json" "jwt"
Example: format=jwt

Selects the response format.

Responses

Response samples

Content type
application/json
Example
{
  • "capabilitiesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

GET /dataServices

Used to obtain information about data services provided by this data service provider.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "dataServicesToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

POST /delegation

Used to obtain delegation evidence from an Entitled Party.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body contains object with information about the requested delegation

required
object
previous_steps
required
Array of strings
delegation_path
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "delegationRequest": {
    },
  • "previous_steps": [
    ],
  • "delegation_path": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "delegationToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}

Legal Data Service Consumer

Endpoints for the Legal Data Service Consumer. All endpoints are optional for this role.

POST /connect/token

Token endpoint supporting both the OAuth2 Client Credentials Grant, and the OAuth 2.0 Token Exchange Grant (RFC 8693). The request MUST include the header: Content-Type: application/x-www-form-urlencoded. See DSGO token endpoint documentation for more information

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
required
One of
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain the value iSHARE to indicate usage within the iSHARE framework.

client_id
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=client_credentials&
scope=iSHARE&
client_id=did:ishare:EU.NL.NTRNL-12345678&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&
client_assertion=eyJhbGciOiJSUzI1NiIsImtpZCI6IjIyIn0...

Response samples

Content type
application/json
{
  • "access_token": "aW2ys9NGE8RjHPZ4mytQivkWJO5HGQCYJ7VyMNGGDLIOw",
  • "token_type": "bearer",
  • "expires_in": 3600
}

POST /connect/token/revoke

Used to revoke an OAuth access token. The request MUST include the header: Content-Type: application/x-www-form-urlencoded

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
optional
grant_type
required
string

OAuth 2.0 grant type. MUST contain client_credentials

scope
required
string

OAuth 2.0 scope. MUST contain iSHARE scope value. Other values allow the Service Consumer to get tokens that do not include all rights the Service Consumer has. According to RFC 6749, scopes are case-sensitive.

client_id
required
string

MUST contain a valid DSGO identifier of the Service Consumer

client_assertion_type
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain “urn:ietf:params:oauth:client-assertion-type:jwt-bearer”

client_assertion
required
string

Used in DSGO for all client identification for OAuth/OpenID Connect. MUST contain basic JWT token conform DSGO specifications, signed by the client.

token
required
string

access token to be revoked

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_uri": "http://example.com",
  • "unsupported_token_type": "string"
}

POST /delegation

Used to obtain delegation evidence from an Entitled Party.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body contains object with information about the requested delegation

required
object
previous_steps
required
Array of strings
delegation_path
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "delegationRequest": {
    },
  • "previous_steps": [
    ],
  • "delegation_path": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "delegationToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIng1YyI6WyJNSUlCSXpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVJBQU1JSUJDd0tDQVFJQTF1RGRyblAzd3dmcmhDdGZEUzNCMjVzWFBWU1o1VUdpK2swTTdDTklSRFBJUDFCaFJMYjI5RWdBYktjWGF6YlhYTXpGSkMwODBvMlJuZXFZODBZOHV1cm5pRExhV2Q3dFNmak0rSG1mWjV0T3k1aWUyVHFrYWxkZUphcS9yU1IyUkJCdFRISmhLdUZzYmVaRG1IMzQrSXUydWdIUmNSU2pUaEcxS3cyYlYzYUVOZytVZ2k1MVR6QjlReGUrbk8vTmFpY2NmSWpyZWdSOWtscEdIVmxTMlU4bW1tcG00bkh0SUJER0tlUlhzUmJROFhKc0l0T0s3SXBjR2lkRnpmYjUxT0o3OGtzUjVxMDBQSHhXRXN4ZUhUTGlvWmFUMnhoSHRpYmYxaEJnclc3TU9YYjBHQVhrWHdub0RtYlB1S0JBc1krSjI0YnVxR2lPdSthYkI0cThpS01DQXdFQUFRPT0iXX0.eyJpc3MiOiJFVS5FT1JJLk5MMDAwMTMwNjE0Iiwic3ViIjoiRVUuRU9SSS5OTDAwMDEzMDYxNCIsImF1ZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJjYXBhYmlsaXRpZXNfaW5mbyI6eyJwYXJ0eV9pZCI6IkVVLkVPUkkuTkwzMTQxNTkyNjUiLCJyb2xlcyI6W3sicm9sZSI6IkRhdGEgU2VydmljZSBQcm92aWRlciJ9XSwic3VwcG9ydGVkX3ZlcnNpb25zIjpbeyJ2ZXJzaW9uIjoiMS4wIiwic3VwcG9ydGVkX2ZlYXR1cmVzIjpbeyJwdWJsaWMiOlt7ImlkIjoiQTUxRDQxM0YtQjNDQy00NzdELTk2QzQtRTM3QTkwMDNCRkUzIiwiZmVhdHVyZSI6ImNhcGFiaWxpdGllcyIsImRlc2NyaXB0aW9uIjoiUmV0cmlldmVzIGNhcGFiaWxpdGllcyIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2NhcGFiaWxpdGllcyIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifSx7ImlkIjoiNDlGNkU2NjItRjA1NS00QUFDLTk2QjItRTgzM0ZBNUY1NDE0IiwiZmVhdHVyZSI6ImNyZWF0ZSBiYXNpYyBqc29uIHdlYiB0b2tlbiIsImRlc2NyaXB0aW9uIjoiT2J0YWlucyBiYXNpYyBqc29uIHdlYiB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvY3JlYXRlLWp3dCJ9LHsiaWQiOiI0OUY2RTY2Mi1GMDU1LTRBQUMtOTZCMi1FODMzRkE1RjU0MTQiLCJmZWF0dXJlIjoiYWNjZXNzIHRva2VuIiwiZGVzY3JpcHRpb24iOiJPYnRhaW5zIGFjY2VzcyB0b2tlbiIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L2Nvbm5lY3QvdG9rZW4vIn0seyJpZCI6IjA1MzU3QjFDLUE5MzQtNEJCMi1BN0NELTQyOTQ4REE1MjM3OSIsImZlYXR1cmUiOiJQcm9qZWN0IFggc3Vic2NyaXB0aW9uIiwiZGVzY3JpcHRpb24iOiJTdGF5IHVwIHRvIGRhdGUgb24gdGhlIHByb2dyZXNzIG9mIHByb2plY3QgWCIsInVybCI6Imh0dHBzOi8vZHNnby10ZWNoeC1zdGVya3dlcmstYm91d2dyb2VwLmF6dXJld2Vic2l0ZXMubmV0L3N1YnNjcmlwdGlvbnMvIiwidG9rZW5fZW5kcG9pbnQiOiJodHRwczovL2RzZ28tdGVjaHgtc3Rlcmt3ZXJrLWJvdXdncm9lcC5henVyZXdlYnNpdGVzLm5ldC9jb25uZWN0L3Rva2VuLyJ9LHsiaWQiOiIxMDVEMTlDNy0wMkIxLTQ4MUYtOEI5OC0wQzBGMkY1RUJCNEIiLCJmZWF0dXJlIjoiUHJvamVjdCBzdGF0dXMiLCJkZXNjcmlwdGlvbiI6IlJldHJpZXZlIHRoZSBsYXRlc3Qgc3RhdHVzIG9mIHRoZSBwcm9qZWN0IGFzIGEgQklNIG1vZGVsIHdpdGggY29ubmVjdGVkIHBsYW5uaW5nIiwidXJsIjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvcmVzb3VyY2Uve2lkfSIsInRva2VuX2VuZHBvaW50IjoiaHR0cHM6Ly9kc2dvLXRlY2h4LXN0ZXJrd2Vyay1ib3V3Z3JvZXAuYXp1cmV3ZWJzaXRlcy5uZXQvY29ubmVjdC90b2tlbi8ifV19XX1dfSwianRpIjoiSFJuS3J0Wmxtd2VuQVZrVWV3S04iLCJpYXQiOjE3MDk2MzYyOTYsImV4cCI6MTcwOTYzNjMyNn0.DYaHEy4eilzct8eP6oMOz0svpE_0Ze0QyezhnECSHAzAYRbSikpH8bCvJcw_VMtfTYMal9vpOk6CMHTkwHT1-wioHRkM9nJ5hJi53ILQ7dzjZet630l2lfy3sYSWJHx8yFcwKJgLNq20N3rTv3JytdR4rsCXLNdfgqmEa9-BPwCSJNoIiNF755UmhVxVWmjzVN5Md2rxh2rwAihADjQlnVe3KI2FF3iwXIXalS2S2kBaN6LsrlFTzyUAUfSJw3WY0T73LQBTPILaxWZ8LA3mDtJBC3CVA33GacjtvLmHuFNtbvJ4L5Hl70MU8LwEa42gzjjsj6Y2uYrx7nmYcJNrp9s"
}