ConsentInfo

The ConsentInfo endpoint provides a list of approved consents for requested ConsentCollectionId's. These can be used to check if (any) consents have been given and for which bank accounts.

Calling ConsentInfo

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

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

Get-Parameters:       ConsentCollectionId:    string      (required)

Body:                 empty

Errors:               400, 403 or 500

Parameters

Parameter	Description
ApiKey	ApiKey Example:cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=
X-Request-ID	Request identifier, guid that is unique for each request. Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f
ConsentCollectionId	Consent Collection Identifier from which information is being requested. Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Output

Field	Type	Description
bankId	guid	Bank identifier
bankName	string	Name of the bank
consentedOn	datetime	Date of consent
expiresOn	datetime	Date untill the consent is valid
fromHistoryDate	datetime	Oldest date for which transactions are available; if downloading of history is allowed
status	int	Consent status, see Consent status
accounts	list	List of information regarding the accounts in this consent collection

Account info

Field	Type	Description
iBan	string
status	int	, see Consent account status
lastdownload	datetime	Last download datedownload
historyAvailable	bool	True if historical transactions may be downloaded
name	string	Bank account owner's name
product	string	Bank account type if available

ConsentStatus

Value	Name	Description
0	Received	Consent has been received
1	Rejected	Consent has been rejected
2	Valid	Consent is valid
3	RevokedByPsu	Consent has been revoked by user
4	Expired	Consent has expired
5	TerminatedByTpp	Consent has been terminated by the provider

The most frequent values are valid and expired; Others are much less common.

ConsentAccountState

Value	Name	Description
0	None	Consent has no state (yet)
1	Valid	Data can be downloaded of this account
2	Expired	Consent has expired
3	Withdrawed	Consent has been withdrawn by account owner

Example output

[
   {
      "bankId":"f3746abd-df60-4185-9b53-6f4e6652458b",
      "bankName":"SNS bank",
      "consentedOn":"YYYY-MM-DDTHH:MM:SS+HH:MM",
      "expiresOn":"YYYY-MM-DDTHH:MM:SS+HH:MM",
      "fromHistoryDate":"YYYY-MM-DDTHH:MM:SS+HH:MM",
      "status":2,
      "accounts":[
         {
            "iBan":"NL00SNSB0123456789",
            "status":1,
            "lastdownload":null,
            "historyAvailable":true,
            "name":"Hr A B Janssen",
            "product":"SNS BETALEN"
         }
      ]
   }
]