Consent authorisation.
POST/api/v1/consents/:consentId/authorisations
Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment initiation response
that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms:
* 'startAuthorisationWithPsuIdentification',
* 'startAuthorisationWithPsuAuthentication'
* 'startAuthorisationWithEncryptedPsuAuthentication'
* 'startAuthorisationWithAuthentciationMethodSelection' - The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding payment cancellation response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
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.ConsentAuthorisation.ConsentAuthorisationRequestHeaders.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.
Client ID of the PSU in the ASPSP client interface.
Might be mandated in the ASPSP's documentation.
It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
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.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
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 parameter TPP-Decoupled-Preferred and 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.
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.
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.
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.
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.
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 Port header field consists of the corresponding HTTP request IP Port field 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 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
- 201
- 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)
Schema
- Array [
- ]
Possible values: [received, psuIdentified, psuAuthenticated, scaMethodSelected, unconfirmed, started, finalised, failed, exempted]
This data element is containing information about the status of the SCA method applied.
Possible values: non-empty
Resource identification of the related SCA.
scaMethods object[]nullable
Authentication object. This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.
Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported.
If this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body.
These methods shall be presented towards the PSU for selection by the TPP.
Possible values: [SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP]
Type of the authentication method.
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation.
Possible values: non-empty and <= 35 characters
An identification provided by the ASPSP for the later identification of the authentication method selection.
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
Detailed information about the SCA method for the PSU.
chosenScaMethod object
Authentication object.
Possible values: [SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP]
Type of the authentication method.
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation.
Possible values: non-empty and <= 35 characters
An identification provided by the ASPSP for the later identification of the authentication method selection.
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
Detailed information about the SCA method for the PSU.
challengeData object
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
PNG data(max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.
A collection of strings as challenge data.
A link where the ASPSP will provides the challenge image for the TPP.
The maximal length for the OTP to be typed in by the PSU.
Possible values: [characters, integer]
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU
psuMessage object
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
PNG data(max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.
A collection of strings as challenge data.
A link where the ASPSP will provides the challenge image for the TPP.
The maximal length for the OTP to be typed in by the PSU.
Possible values: [characters, integer]
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU
{
"scaStatus": "received",
"authorisationId": "string",
"scaMethods": [
{
"authenticationType": "SMS_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "string",
"name": "SMS OTP on phone +49160 xxxxx 28",
"explanation": "Detailed information about the SCA method for the PSU."
}
],
"chosenScaMethod": {
"authenticationType": "SMS_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "string",
"name": "SMS OTP on phone +49160 xxxxx 28",
"explanation": "Detailed information about the SCA method for the PSU."
},
"challengeData": {
"myProperty": "string",
"data": "string",
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "characters",
"additionalInformation": "string"
},
"psuMessage": {
"myProperty": "string",
"data": "string",
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "characters",
"additionalInformation": "string"
}
}
Unauthorized
Forbidden