ConsentWizard

The ConsentWizard is a portal where users give consent for their bank accounts. They can choose for which banks they wish to give consent.

Wizard sessions can only be started through a generated URL. This URL stays valid during the validity of the session. A ConsentWizard session has a timeout of 10 minutes.

After consents have been given the user is forwarded to the given ReturnUrl and the given consents can be collected using the ConsentInfo endpoint.

Calling the service

Endpoint:             https://openbanking.invers.nl/api/v1/consents/generateConsentWizardUrl
Method:               GET

Header:               ApiKey:                 string      (required)
                      X-Request-ID:           string      (required)
                      ExpectedIbans:          string      (optional)

Get-Parameters:       ConsentCollectionId:    string      (required)
                      ReturnUrl:              string      (required)
                      CustomerSubType:        string      (optional)
                      CollectionType:         int         (optional)

Body:                 empty

Errors:               400, 403 or 500

Parameters

Parameter	Description
ApiKey	ApiKey Example:cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=
X-Request-ID	Identifier of the request, guid that is unique for each request. Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f
ExpectedIbans	Optional. A JSON array with valid IBANs. When this is given, the accounts automatically appear in the wizard to show the user for which accounts consent is required. Example: ["NL02ABNA0123456789","NL12SNSB0123456789"]
ConsentCollectionId	Identifier of the Consent Collection, unique GUID for this collection. Example: d2c95f1b-6802-459e-ba7d-70491ac27d24
ReturnUrl	Redirect URL after consent has been given. Example: https://mywebsite.org/callback During the redirect the following values are added to the URL: ConsentCollectionId, RequestId and ConsentCount. Example:https://mywebsite.org/callback?ConsentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24&RequestId=f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f&ConsentCount=2
CustomerSubType	Optional. The customer sub type. Leave empty for default
CollectionType	Optional. The collection type. Leave empty for default.

Output

Field	Type	Description
url	string	Send the user to this URL to open the wizard
requestId	guid	Echo of the parameter when calling the service

Example output

{
   "url":"https://openbanking.invers.nl/startWizard?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJhMmQxZmJiNy1iZjFhLTRkZTItOGUwNS1jMzA2ODc5ZDFhZDMiLCJuYmYiOjE1Njk0NzkzMzIsImV4cCI6MTU2OTQ4MDUzMiwiaWF0IjoxNTY5NDc5MzMyfQ.GVKqU9Aib3-hol1ccDR0GwwvtCv6sVItOxDHAra9kas",
   "requestId":"1efc3403-3d77-4cb2-91f3-895d48075720"
}