ConsentUrl
The ConsentUrl endpoint is used to generate a bank URL where users can give consent.
Currently the following banks are supported:
Name | BankId |
---|---|
ABN AMRO | D22D49F5-46C1-44F7-974C-C6E2FE7C8F0E |
ASN | 287F6BBE-44D4-4963-987B-FE2122DE5239 |
Bunq | F3695E7A-C064-4104-821B-2B707F4A656A |
ING | EC3E0888-36AC-4A96-AAF7-4AA744F0D5D7 |
Knab | A0AD6E35-766B-4A7A-AECD-21F6DD5D9011 |
Van Lanschot | 2466BD30-A9CE-4A7B-B5F4-78E69A176912 |
Rabobank | 3D70E5AE-7FED-4789-963C-A9F9DE7CF794 |
Regiobank | 6E2336FF-612E-4103-93B4-089D10281265 |
SNS | F3746ABD-DF60-4185-9B53-6F4E6652458B |
Triodos | E104CB12-F42A-444B-B65D-20FF1BD70960 |
A successful call to the ConsentUrl endpoint results in a URL where the user can be sent to give consent for a bank. After the consent has been received the user is returned to the given ReturnUrl.
Calling ConsentUrl
Endpoint: https://openbanking.invers.nl/api/v1/consents/generateUrl
Method: GET
Header: ApiKey: string (required)
X-Request-ID: string (required)
Ibans: string (optional)
Get-Parameters: ConsentCollectionId: string (required)
BankId: string (required)
ReturnUrl: string (required)
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 |
Ibans | Required for some banks. A JSON array with valid IBANs. Example: ["NL02ABNA0123456789","NL12SNSB0123456789"] |
ConsentCollectionId | Identifier of the Consent Collection, unique GUID for this collection. Example: d2c95f1b-6802-459e-ba7d-70491ac27d24 |
BankId | Bank identifier. Example: f3746abd-df60-4185-9b53-6f4e6652458b |
ReturnUrl | Redirect URL after consent has been given. Example: https://mywebsite.org/callback |
Output
Field | Type | Description |
---|---|---|
consentRequestUrl | string | Send the user to this URL to handle the consent |
consentCollectionId | GUID | Echo of the parameter in the call |
requestId | GUID | Echo of the parameter in the call |
Example output
{
"consentRequestUrl":"https://psd.bancairediensten.nl/psd2/snsbank/v1/authorize?scope=AIS&client_id=l7369255176d154541e8ae388fbbc9c7e5&response_type=code&redirect_uri=https%3a%2f%2fopenbanking.invers.nl%2foauth2%2fsuccess&state=4be5a061-f605-42d6-acde-0db6b7d9909a&consentId=SNS8680007804508",
"consentCollectionId":"d2c95f1b-6802-459e-ba7d-70491ac27d24",
"requestId":"f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f"
}