eHerkenning attributes in Authentication REST API

This page contains information about the user attributes that you can request and retrieve from eHerkenning when using the Signicat Authentication REST API as an authentication protocol.

Attribute glossary

To learn more about the properties of the data available through eHerkenning, visit the Attribute glossary page.

Attributes table

eHerkenning provides the following data:

* Pseudonym example: ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890@ABCDEF1234567890ABCDEF1234567890

Examples

Request example

To create a session using the Authentication REST API, you send a POST request to the Create a new session endpoint of the Authentication REST API. This is https://api.signicat.com/auth/rest/sessions.

You define the parameters of the session in the payload of the request. For example:

{
    "allowedProviders": [
        "eherkenning"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "idpId",
        "firstName",
        "lastName",
        "dateOfBirth",
        "gender",
        "phoneNumber",
        "email",
        "placeOfBirth",
        "nin",
        "chamberOfCommerce",
        "eherkenningIntermediatekvkNr",
        "eherkenningVestigingsNr",
        "eherkenningRsin",
        "eherkenningProbasNr",
        "eherkenningPseudo",
        "eherkenningPseudoID",
        "eherkenningServiceID",
        "eherkenningServiceUUID",
        "organisationName",
        "eherkenningIntermediateOrganisationName",
        "initials",
        "familyNameInfix",
        "18OrOlder",
        "16OrOlder",
        "12OrOlder",
        "65OrOlder",
	],
    "callbackUrls": {
        "success": "https://example.com/success",
        "abort": "https://example.com/abort",
        "error": "https://example.com/error"
	}
}

Response example

The following is an example of a response showing the end-user information attributes:

{
    ...
    "id": "4ccb8a1b-6f40-e146-af1b-15f1c6eabb56",
    "status": "SUCCESS",
    "provider": "eherkenning",
    "subject": {
        "id": "X-FUmG7SkaAb8fA-7IU0ZrpTIJ37fnaV-c5SbXAoOqw=",
        "idpId": "E0DA125456E34014919EC26C5B1E6D9A8A5F7F2663A14C4D98BB6ADB3426FF09",
        "firstName": "Jane",
        "initials": "J.",
        "lastName": "Doe",
        "familyNameInfix": "de",
        "dateOfBirth": "1980-01-15",
        "gender": "U",
        "phoneNumber": "+31612345678",
        "email": "jane.doe@example.com",
        "placeOfBirth": "Amsterdam",
        "nin": "123456789",
        "18OrOlder": true,
        "16OrOlder": true,
        "12OrOlder": true,
        "65OrOlder": false,
        "chamberOfCommerce": "12345678",
        "eherkenningIntermediatekvkNr": "87654321",
        "eherkenningVestigingsNr": "123400567890",
        "eherkenningRsin": "987654321",
        "eherkenningProbasNr": "PROBAS-00123",
        "eherkenningPseudo": "pseudo-org-12345",
        "eherkenningPseudoID": "pseudo-id-67890",
        "eherkenningServiceID": "service-001",
        "eherkenningServiceUUID": "d8f71022-789b-456c-abc1-2f1234567890",
        "organisationName": "Example BV",
        "eherkenningIntermediateOrganisationName": "Intermediate Services BV"
    }
    ...
}