Ga naar inhoud
buildinglinksbuildinglinks

Get a participant

GET
/api/v1/registry/participants/{did}
curl --request GET \
  --url https://example.com/api/v1/registry/participants/example \
  --cookie bl_authority_session=<bl_authority_session>

With the monitoring’s last checks and the current membership credential.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
did
required
string

The DID of the participant.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

GET /api/v1/registry/participants/{did}: documents the JSON built in [get_one].

object
participant
required

A participant in the registry.

object
did
required
string
slug
required

Short name, used in addresses.

string
name
required
string
legal_name
required
string
kvk_number
required

Number in the Dutch trade register (KvK).

string
roles
required

The roles in the dataspace, e.g. provider, consumer.

Array<string>
dsp_endpoint
required

Where other connectors reach its Dataspace Protocol endpoints.

string
dataplane_url
string | null
color
string | null
status
required

active or suspended.

string
onboarded_at
required
string format: date-time
credential_id

The current membership credential.

string | null
health
required

What the monitoring of the authority last saw: e.g. healthy, degraded, unreachable.

string
last_seen_at
string | null format: date-time
telemetry_level

Operators only: how much the participant shares with the monitoring.

string | null
contact_email

Operators only.

string | null
health_detail
required

The last checks of the monitoring, per check.

object
credential
One of:
null

Example generated

{
  "participant": {
    "did": "example",
    "slug": "example",
    "name": "example",
    "legal_name": "example",
    "kvk_number": "example",
    "roles": [
      "example"
    ],
    "dsp_endpoint": "example",
    "dataplane_url": "example",
    "color": "example",
    "status": "example",
    "onboarded_at": "2026-04-15T12:00:00Z",
    "credential_id": "example",
    "health": "example",
    "last_seen_at": "2026-04-15T12:00:00Z",
    "telemetry_level": "example",
    "contact_email": "example"
  },
  "health_detail": {},
  "credential": {
    "id": "example",
    "types": [
      "example"
    ],
    "revoked": true,
    "issued_at": "2026-04-15T12:00:00Z",
    "expires_at": "2026-04-15T12:00:00Z",
    "claims": {},
    "status_index": 1
  }
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

404

Section titled “404”

Not found.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}