party_info object

Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars

This object is used in the following endpoints:

/parties

Information about participants is provided in party_info objects, as defined below.

Parameters			Type	Description

Parameters			Type	Description
`party_id`		Required	Array of strings	Array with identifiers of the party. Each identifier includes a prefix and must be an Organisation ID that is allowed by DSGO. Examples: `did:ishare:EU.NL.NTRNL-98765432` `kvk:NL.KVK.98765432` `eori:EU.EORI.NL000123456`
`party_name`		Required	String	String representing the object type, MUST be equal to the organisation name as registered at the Chamber of Commerce.
`adherence`		Required	Object	Object MUST contain the `status`, and validity timestamps (`start_date` and `end_date`).
	`status`	Required	String in `adherence` object	MUST be status of the party. Available values are `Active`, `Pending`, `NotActive` and `Revoked`.
	`start_date`	Required	String in `adherence` object	Date and time which states since when the adherence status has established, MUST be according to ISO 8601.
	`end_date`	Required	String in `adherence` object	Date and time which states till when the adherence status is established, MUST be according to ISO 8601. Can be NULL.
`roles`		Required	Array of objects	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 `roles`object	MUST be the role of acquired certification. Available values are `ServiceConsumer`, `ServiceProvider`, `EntitledParty`, `AuthorisationRegistry`, `IdentityProvider`, `ParticipantRegistry`, `ServiceBroker`
	`start_date`	Required	String in `roles`	Date and time which states since when the role has been established, MUST be according to ISO 8601.
	`end_date`	Required	String in `roles`object	Date and time which states till when the role is established, MUST be according to ISO 8601. Can be NULL.
	`loa`	Required	string in `roles` object	the party’s level of assurance, MUST be according to iSHARE technical naming `low`, `substantial`, `high`. The parameter may be filled with an empty string for roles `ServiceConsumer`, `ServiceProvider`, `EntitledParty`,
	`compliancy_verified`	Required	Boolean in `roles` object	Indicates if the party compliance to DSGO is verified
	`legal_adherence`	Required	Boolean in `roles` object	Indicates if the party signed the appropriate legal agreements and has been verified during or after onboarding.
`capability_url`		Optional	String	MUST be the `/capabilities` endpoint of the party. See /capabilities for more information.

{
  "party_id": [
    "did:ishare:EU.NL.NTRNL-98765432",
    "kvk:NL.KVK.98765432", 
    "eori:EU.EORI.NL000123456"
  ],
  "party_name": "XYZ Vastgoed b.v.",
  "adherence": {
    "status": "Active",
    "start_date": "2018-04-26T00:00:00",
    "end_date": "2020-02-02T00:00:00"
  },
  "roles": [
    {
      "role": "ServiceProvider",
      "start_date": "2018-01-04T00:00:00",
      "end_date": "2020-02-02T00:00:00",
      "loa": "",
      "compliancy_verified": true,
      "legal_adherence": true
    }
  ],
  "capability_url": "https://api.xyzvastgoed.nl/capabilities"
}

party_info object

Related content