...
Used to obtain information about participants in the DSGO from the trust framework catalogue (provided by the DSGO Trust framework authority). The /parties endpoint is available to verify the status of participants.
| Excerpt | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Information about participants is provided in party_info objects, as defined below.
Parties_info object
...
Parameters
...
Type
...
Description
...
party_id
...
Required
...
String
...
Unique identifier of the party, MUST be an Organisation ID, containing an EORI or KvK number.
...
party_name
...
Required
...
String
...
String representing the object type, MUST be equal to the organisation name as registered at the Chamber of Commerce.
...
adherance
...
Required
...
Object
...
Object MUST contain the status, and validity timestamps (start_date and end_date).
...
status
...
Required
...
String in adherance object
...
MUST be status of the party. Available values are Active, Pending, NotActive and Revoked.
...
start_date
...
Required
...
String in adherance object
...
Date and time which states since when the adherence status has established, MUST be according to ISO 8601.
...
end_date
...
Required
...
String in adherance object
...
Date and time which states till when the adherence status is established, MUST be according to ISO 8601.
...
certifications
...
Required
...
Object
...
MUST be an object containing a collection of the certifications of the party indicating what market facility role(s) the party fulfils (the role, start_date, end_date and loa).
...
role
...
Required
...
String in certifications object
...
MUST be the role of acquired certification. Available values are Authorisation Registry, Identity Provider, Data Service Broker, or Scheme Owner.
...
start_date
...
Required
...
String in certifications object
...
Date and time which states since when the certification has been established, MUST be according to ISO 8601.
...
end_date
...
Required
...
String in certifications object
...
Date and time which states till when the certification is established, MUST be according to ISO 8601.
...
loa
...
Required
...
Integer in certifications object
...
MUST be the certificate’s level of assurance. Available values are 1 (low), 2 (substantial) and 3 (high).
...
capability_url
...
Required
...
String
...
MUST be the /capabilities endpoint of the party. See /capabilities for more information.
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Endpoint
the The /parties endpoint follows the generic technical requirements, as well as the requirements specified for specific methods. The figure below gives an overview of the HTTP methods that are supported by the /parties endpoint. These methods are further detailed and specified in the pages below:
...