Get consent.
GET/api/v1/consents/:consentId
Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.
Request
Path Parameters
ID of the corresponding consent object as returned by an account information consent request.
Header Parameters
- GET
- POST
- PUT
- PATCH
- DELETE
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the OpenBankingGateway.Models.AccountInformationService.GetConsent.GetConsentRequestHeaders.Signature element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
Possible values: [GET, POST, PUT, PATCH, DELETE]
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Responses
- 200
- 401
- 403
Created
Response Headers
X-Request-ID string
ID of the request, unique to the call, as determined by the initiating party.
- application/json
- Schema
- Example (from schema)
- Example 1.
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
access objectrequired
Requested access services for a consent.
accounts object[]nullable
Is asking for detailed account information.
If the array is empty in a request, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
balances object[]nullable
Is asking for balances of the addressed accounts.
If the array is empty in the request, the TPP is asking for the balances of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
transactions object[]nullable
Is asking for transactions of the addressed accounts.
If the array is empty in the request, the TPP is asking for the balances of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
additionalInformation object
Optional if supported by API provider.
Is asking for additional information as added within this structured object. The usage of this data element requires at least one of the entries "accounts", "transactions" or "balances" also to be contained in the object. If detailed accounts are referenced, it is required in addition that any account addressed within the additionalInformation attribute is also addressed by at least one of the attributes "accounts", "transactions" or "balances".
ownerName object[]nullable
Is asking for account owner name of the accounts referenced within. If the array is empty in the request, the TPP is asking for the account owner name of all accessible accounts. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts, balances or transactions shall be empty, if used. The ASPSP will indicate in the consent resource after a successful authorisation, whether the ownerName consent can be accepted by providing the accounts on which the ownerName will be delivered. This array can be empty.
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
trustedBeneficiaries object[]nullable
Optional if supported by API provider. Is asking for the trusted beneficiaries related to the accounts referenced within and related to the PSU. If the array is empty in the request, the TPP is asking for the lists of trusted beneficiaries of all accessible accounts. This may be restricted in a PSU/ASPSP authorization dialogue by the PSU if also the account lists addressed by the tags “accounts”, “balances” or “transactions” are empty. The ASPSP will indicate in the consent resource after a successful authorisation, whether the trustedBeneficiaries consent can be accepted by providing the accounts on which the list of trusted beneficiaries will be delivered. This array can be empty.
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
Possible values: [allAccounts, allAccountsWithOwnerName]
Possible values: [allAccounts, allAccountsWithOwnerName]
Possible values: [allAccounts, allAccountsWithOwnerName]
Possible values: [allAccounts, allAccountsWithOwnerName]
"true", if the consent is for recurring access to the account data.
"false", if the consent is for one access to the account data.
This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISO-Date format, e.g. 2017-10-30.
Future dates might get adjusted by ASPSP.
If a maximal available date is requested, a date in far future is to be used: "9999-12-31".
In both cases the consent object to be retrieved by the get consent request will contain the adjusted date.
Possible values: >= 1 and <= 2147483647
This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1".
The frequency needs to be greater equal to one.
If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.
This date is containing the date of the last action on the consent object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.
Possible values: [received, rejected, valid, revokedByPsu, expired, terminatedByTpp, partiallyAuthorised]
This is the overall lifecycle status of the consent.
_links object
A list of hyperlinks to be recognised by the TPP.
Links of type "account" and/or "cardAccount", depending on the nature of the consent.
account object
Link to a resource.
href Entry.
card-account object
Link to a resource.
href Entry.
{
"access": {
"accounts": [
{
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
}
],
"balances": [
{
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
}
],
"transactions": [
{
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
}
],
"additionalInformation": {
"ownerName": [
{
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
}
],
"trustedBeneficiaries": [
{
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
}
]
},
"availableAccounts": "allAccounts",
"availableAccountsWithBalance": "allAccounts",
"allPsd2": "allAccounts",
"restrictedTo": "allAccounts"
},
"recurringIndicator": false,
"validUntil": "2024-12-31",
"frequencyPerDay": 4,
"lastActionDate": "2024-07-01",
"consentStatus": "received",
"_links": {
"account": {
"href": "string"
},
"card-account": {
"href": "string"
}
}
}
Example 1
{
"access": {
"balances": [
{
"iban": "AL9820542146036508CLIDCFAUDP"
},
{
"iban": "AL4420542146036508CLIDCLALL5"
},
{
"iban": "AL7120542146036508CLIDCLALL4",
"currency": "ALL"
}
],
"transactions": [
{
"iban": "AL9820542146036508CLIDCFAUDP"
},
{
"bban": "414036508CLIDCLALL48"
}
]
},
"recurringIndicator": true,
"validUntil": "2024-12-12",
"frequencyPerDay": 4,
"lastActionDate": "0001-01-01",
"consentStatus": "received"
}
Unauthorized
Forbidden