Consent info endpoint
Het doel van deze pagina is om inzicht te geven in het ‘consent info’ endpoint van het toestemmingenplatform. Dit endpoint kan voor zowel afnemende als verstrekkende diensten van belang zijn om te gebruiken in hun dienstverlening.
Consumenten geven afnemende diensten toestemmingen om hun energie data op te halen bij verstrekkende diensten. Deze toestemmingen worden opgeslagen in het toestemmingenplatform. In het geval van een doorlopende toestemming kan het voor de afnemende dienst handig zijn om informatie op te halen over de gegeven toestemmingen.
Toestemmingsinformatie voor afnemende diensten
Voor afnemende diensten bevat de response de status, en de geldigheidsduur voor elke gevonden toestemming. Dit is bijvoorbeeld waardevol zodat een afnemende dienst de consument kan waarschuwen dat de toestemming binnenkort afloopt, en deze dus vernieuwd/verlengt moet worden om gebruik te blijven maken van de dienst.
Het consent-info endpoint voor afnemende diensten is:
Dit endpoint verwacht:
-
Een geldig access_token, zie hiervoor Access token ophalen
-
Een lijst de ids van alle toestemmingen waarvoor je info wilt ophalen.
Als resultaat krijg je een lijst met voor elke (gevonden) toestemming:
-
De consentId, zodat het duidelijk is voor welke toestemming de waardes gelden.
-
De status, welke ACTIVE of INACTIVE kan zijn.
-
En een optionele validUntil, welke aangeeft wanneer de toestemming verloopt.
curl --location --globoff '{{host}}/autorisatieregister/v1/consent-info/consuming-services' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
"consentIds": ["<YOUR CONSENT UUID HERE"]
}'Met als voorbeeld response:
[
{
"consentId": "<YOUR CONSENT UUID HERE",
"status": "ACTIVE",
"validUntil": "2024-05-15:10:00.000Z"
}
]