Consent Service

Processes on starting authorisations, update PSU identification or PSU authentication data and explicit authorisation of transactions by using SCA are very similar in PIS and AIS and signing baskets services. The API calls supporting these processes are described in the following independently from the service/endpoint. For reasons of clarity, the endpoints are defined always for the Payment Initiation Service, the payment cancellation, the Account Information Service (Consents), and Signing Baskets separately. These processes usually are used following a hyperlink of the ASPSP.

Create consent

This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method as parameters as a core function.

Side Effects When this consent request is a request where the "recurringIndicator" equals "true", and if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU.

Optional Extension: As an option, an ASPSP might optionally accept a specific access right on the access on all PSD2 related services for all available accounts.

As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. The relation to accounts is then handled afterwards between PSU and ASPSP. This option is not supported for the Embedded SCA Approach. As a last option, an ASPSP might in addition accept a command with access rights

to see the list of available payment accounts or
to see the list of available payment accounts with balances.

SecurityNone or BearerAuthOAuth

Request

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID required	string Client ID of the PSU in the ASPSP client interface. Example: PSU-1234
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP’s documentation.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
TPP-Redirect-Preferred	boolean If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. Default value True If true customer will be redirected to an Arion authentication website. If false customer will be using an app-to-app redirect approach trough the Arion app.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
TPP-Explicit-Authorisation-Preferred	boolean If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
TPP-Brand-Logging-Information	string This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. This header might be ignored by the ASPSP.
TPP-Notification-URI	string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.
TPP-Notification-Content-Preferred	string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-IP-Address required	string <ipv4> 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. Example: 192.168.8.78
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Request Body schema: application/json

Request body for a consents request.

required	object (accountAccess) Requested access services for a consent.
recurringIndicator required	boolean (recurringIndicator) "true", if the consent is for recurring access to the account data. "false", if the consent is for one access to the account data.
validUntil required	string <date> (validUntil) 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.
frequencyPerDay required	integer (frequencyPerDay) >= 1 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.
combinedServiceIndicator required	boolean If "true" indicates that a payment initiation service will be addressed in the same "session".

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/consents

Request samples

Response samples

application/json

Consent request response in case of a redirect.

{"consentStatus": "received",
"consentId": "1234-wertiq-983",
"_links": {"scaRedirect": {"href": "https://www.testbank.com/authentication/1234-wertiq-983"
},
"status": {"href": "/v1/consents/1234-wertiq-983/status"
},
"scaStatus": {"href": "v1/consents/1234-wertiq-983/authorisations/123auth567"
}
}
}

Get consent request

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.

SecurityNone or BearerAuthOAuth

Request

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an account information consent request.

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. Example: 192.168.8.78
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}

Response samples

application/json

Consent request on account list or without indication of accounts.

{"access": {"balances": [{"iban": "DE2310010010123456789"
}
],
"transactions": [{"iban": "DE2310010010123456789"
},
{"pan": "123456xxxxxx3457"
}
]
},
"recurringIndicator": "true",
"validUntil": "2017-11-01",
"frequencyPerDay": 4,
"consentStatus": "valid",
"_links": {"account": {"href": "/v1/accounts"
}
}
}

Delete consent

The TPP can delete an account information consent object if needed.

SecurityNone or BearerAuthOAuth

Request

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an account information consent request.

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. Example: 192.168.8.78
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

delete/v1/consents/{consentId}

Response samples

{"tppMessages": [{"category": "ERROR",
"code": "FORMAT_ERROR",
"path": "string",
"text": "string"
}
],
"_links": {"scaRedirect": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaOAuth": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"confirmation": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisation": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuIdentification": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuIdentification": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithProprietaryData": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateProprietaryData": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateEncryptedPsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateAdditionalPsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateAdditionalEncryptedPsuAuthentication": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"selectAuthenticationMethod": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"authoriseTransaction": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"self": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"status": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaStatus": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"account": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"balances": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactions": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactionDetails": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardAccount": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardTransactions": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"first": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"next": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"previous": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"last": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"download": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": {"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
}

Consent status request

Read the status of an account information consent resource.

SecurityNone or BearerAuthOAuth

Request

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an account information consent request.

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. Example: 192.168.8.78
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/status

Response samples

application/json

Response for a consent status request.

{"consentStatus": "valid"
}

Get consent authorisation sub-resources request

Return a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

SecurityNone or BearerAuthOAuth

Request

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an account information consent request.

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. Example: 192.168.8.78
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/authorisations

Response samples

application/json

{"authorisationIds": ["123auth456"
]
}

Read the SCA status of the consent authorisation

This method returns the SCA status of a consent initiation's authorisation sub-resource.

SecurityNone or BearerAuthOAuth

Request

path Parameters

consentId required	string (consentId) ID of the corresponding consent object as returned by an account information consent request.
authorisationId required	string (authorisationId) Resource identification of the related SCA. Example: 123auth456

header Parameters

X-Request-ID required	string <uuid> ID of the request, unique to the call, as determined by the initiating party. Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest	string Is contained if and only if the "Signature" element is contained in the header of the request. Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
Signature	string A signature of the request by the TPP on application level. This might be mandated by ASPSP. Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU. Example: 192.168.8.78
PSU-IP-Port	string The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: 1234
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Language that the SCA page will be presented in. Possible options are: "is" - Icelandic "en" - English If parameter is empty, the default language will be English.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
PSU-Device-ID	string <uuid> 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. Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: GEO:52.506931;13.144558
Ocp-Apim-Subscription-Key required	string Azure API management subscription key

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/authorisations/{authorisationId}

Response samples

application/json

{"scaStatus": "psuAuthenticated",
"psuMessage": "string",
"trustedBeneficiaryFlag": false
}