DM reference

This document specifies the Data Sharing Data Model.

Common data components

Generic data

Data component	Data type	Definition	HDN concept
Connection Key	String	Provider-specific opaque string representing a connection for data sharing.	DataleverancierSleutel1
Connection Request ID	String	Provider-generated ID for the connection request.	"recordUuid"
Connection URL	String	Provider-specific URL where the user can identify and provide consent.	104 HDN Reference Code2
Customer Reference	String	Unique administrative number generated by the customer requesting a data product.	DataMijNr
Data Product Type	String	Network-specific identifier for the type of data product.	SoortProduct
Data Provider Name	String	Network-specific identifier for the data provider.	DataleverancierNaam
Redirection URL	String	Customer-specific URL to redirect the user to after making the connection.	"frontendRedirectUrl"

Digital identification data

For the data component definitions, see the claim definitions under Identification API: Scopes and claims. The tables below only contain the definitions of additional data components.

Namespace from OpenID Connect

Data component	Data type	HDN concept
birthdate	String	GeboorteDt
email	String	E-mailadres
email_verified	Boolean	EmailadresGeverifieerdJN

Namespace com.cleverbase

Data component	Data type	HDN concept
birthplace	String	GeboortePlaats
nationality	String	Nationaliteit3
nl_brp_geslachtsnaam_zonder_voorvoegsel	String	GeboorteAchternaam
nl_brp_voornaam	String	VoorNamen
nl_brp_voorvoegsel	String	GeboorteTussenvoegsels

No common namespace

Data component	Data type	Definition	HDN concept
Identification Means Type	String	Identifier of one of the Identification means types.	LegitimatieSoort
Identification Means Number	String	Administrative number of identification means.	LegitimatieNr
Identification Means Expiration Date	String	Expiration date of the identification means in ISO 8601 format.	LegitimatieEindDt

Identification means types

Vidua supports the following type:

Value	Definition	HDN representation
Electronic identification means	A unit that enables a person to identify towards a service electronically.	ED Elektronisch Identiteitsbewijs

Data products

Vidua provides the following data products for connected users.

Digital identification

This product contains the following parameters.

Namespace	Parameter	Presence	Constraints
N/A	Data Product Type	Required	MUST be Identiteitsattributen.
Global	birthdate	Required	N/A
Global	email	Required	N/A
Global	email_verified	Required	N/A
com.cleverbase	birthplace	Required	N/A
com.cleverbase	nationality	Required	N/A
com.cleverbase	nl_brp_geslachtsnaam_zonder_voorvoegsel	Required	N/A
com.cleverbase	nl_brp_voornaam	Required	N/A
com.cleverbase	nl_brp_voorvoegsel	Required	N/A
N/A	Identification Means Type	Required	N/A
N/A	Identification Means Number	Required	N/A
N/A	Identification Means Expiration Date	Required	N/A

On the HDN Platform, these parameters are represented in two ways:

• As individual response message fields using the HDN concepts.
• As a base64-encoded JSON document with identifier 100 Dataleverancier oorspronkelijke output.

Message types

For a complete specification of the following message types, see the HDN Platform documentation.

Message type	HDN concept	HDN code
Connection URL Request	KoppelCodeAanvraag	RA
Connection URL Response	KoppelCodeBericht	RX
Connection Notification	ToestemmingsBericht	TX
Data Product Request	BronAanvraagBericht	CA
Data Product Response	BronBericht	CX

The following subsections specify the parameters that are functionally relevant to the Use cases.

Connection URL Request

Parameter	Presence	Constraints
Data Provider Name	Required	MUST equal 04 Vidua.
Redirection URL	Required	N/A

Connection URL Response

Parameter	Presence	Constraints
Connection Request ID	Required	N/A
Connection URL	Required	N/A

Connection Notification

Parameter	Presence	Constraints
Connection Key	Required	N/A
Connection Request ID	Required	MUST equal the value from the Connection URL Response.

Data Product Request

Parameter	Presence	Constraints
Connection Key	Required	MUST equal the value obtained from the Connection Notification.
Data Product Type	Required	MUST equal the type of one of the available Data products.
Data Provider Name	Required	MUST equal 04 Vidua.
Customer Reference	Required	N/A

Data Product Response

This response contains the requested data product.