> For the complete documentation index, see [llms.txt](https://doc.api.tieto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.api.tieto.com/api-references/tieto-saas-aggregation/aggregated-xs2a/consents.md).

# Consents

Establish consent on account and card account information initiation services:

* get information on the consent status and the consent details
* update PSU authentication data and select PSU authentication methods for a consent.

## 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.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"authorisations":{"description":"An array of all authorisationIds.","properties":{"authorisationIds":{"$ref":"#/components/schemas/authorisationsList"}},"type":"object","required":["authorisationIds"]},"authorisationsList":{"description":"An array of all authorisationIds.","type":"array","items":{"$ref":"#/components/schemas/authorisationId"}},"authorisationId":{"description":"Resource identification of the related SCA.","type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"OK_200_Authorisations":{"description":"OK","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorisations"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/authorisations":{"get":{"tags":["consents"],"summary":"Get consent authorisation sub-resources request","description":"Return a list of all authorisation subresources IDs which have been created.\n\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.\n","operationId":"getConsentAuthorisation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_Authorisations"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## Start the authorisation process for a consent

> Create an authorisation sub-resource and start the authorisation process of a consent. \
> The message might in addition transmit authentication and authorisation related data.\
> \
> his 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:\
> \
> &#x20; \* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment \
> &#x20;   initiation response that an explicit start of the authorisation process is needed by the TPP. \
> &#x20;   The 'startAuthorisation' hyperlink can transport more information about data which needs to be \
> &#x20;   uploaded by using the extended forms:\
> &#x20;   \* 'startAuthorisationWithPsuIdentification', \
> &#x20;   \* 'startAuthorisationWithPsuAuthentication' \
> &#x20;   \* 'startAuthorisationWithEncryptedPsuAuthentication'\
> &#x20;   \* 'startAuthorisationWithAuthentciationMethodSelection' \
> &#x20; \* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\
> &#x20; \* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding \
> &#x20;   payment cancellation response that an explicit start of the authorisation process is needed by the TPP. \
> &#x20;   The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \
> &#x20;   by using the extended forms as indicated above.\
> &#x20; \* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \
> &#x20;   executing the cancellation.\
> &#x20; \* The signing basket needs to be authorised yet.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-ID":{"description":"Client ID of the PSU in the ASPSP client interface. \n\nMight be mandated in the ASPSP's documentation.\n\nIt 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\nAIS service in the same session.\nIn this case the ASPSP might check whether PSU-ID and token match, \naccording to ASPSP documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID"},"PSU-ID-Type":{"description":"Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.\n\nIn this case, the mean and use are then defined in the ASPSP’s documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID-Type"},"PSU-Corporate-ID":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID"},"PSU-Corporate-ID-Type":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID-Type"},"TPP-Redirect-Preferred":{"description":"If it equals \"true\", the TPP prefers a redirect over an embedded SCA approach.\nIf it equals \"false\", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled\nSCA approach, depending on the parameter TPP-Decoupled-Preferred and the choice of the SCA procedure by the TPP/PSU.\nIf the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the\nTPP/PSU.\n","required":false,"schema":{"type":"boolean"},"in":"header","name":"TPP-Redirect-Preferred"},"TPP-Redirect-URI":{"description":"URI of the TPP, where the transaction flow shall be redirected to after a Redirect.\n\nMandated for the Redirect SCA Approach, specifically \nwhen TPP-Redirect-Preferred equals \"true\".\nIt is recommended to always use this header field.\n\n**Remark for Future:** \nThis field might be changed to mandatory in the next version of the specification.\n","required":false,"schema":{"format":"uri","type":"string"},"in":"header","name":"TPP-Redirect-URI"},"TPP-Nok-Redirect-URI":{"description":"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\nof a negative result of the redirect SCA method. This might be ignored by the ASPSP.\n","required":false,"schema":{"format":"uri","type":"string"},"in":"header","name":"TPP-Nok-Redirect-URI"},"TPP-Notification-URI":{"description":"URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent.\nThis header field may by ignored by the ASPSP.\n\nFor 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:\n\nURIs 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.\n\nWildcard definitions shall be taken into account for compliance checks by the ASPSP.\n ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.\n","required":false,"schema":{"type":"string"},"in":"header","name":"TPP-Notification-URI"},"TPP-Notification-Content-Preferred":{"description":"The string has the form \n\nstatus=X1, ..., Xn\n\nwhere Xi is one of the constants SCA, PROCESS, LAST and where constants are not\nrepeated.\nThe usage of the constants supports the of following semantics:\n\n  SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.\n\n  PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP.\n  LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.\n\nThis header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"TPP-Notification-Content-Preferred"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"startConsentAuthorisationPsuDataRequest":{"oneOf":[{},{"$ref":"#/components/schemas/updatePsuAuthentication"},{"$ref":"#/components/schemas/selectPsuAuthenticationMethod"},{"$ref":"#/components/schemas/transactionAuthorisation"},{"$ref":"#/components/schemas/selectPsuAuthenticationMethodAndAuthorise"}]},"updatePsuAuthentication":{"description":"Content of the body of a Update PSU authentication request\n\nPassword subfield is used.\n","properties":{"psuData":{"$ref":"#/components/schemas/psuData"}},"type":"object","required":["psuData"]},"psuData":{"description":"PSU Data for Update PSU authentication.","minProperties":1,"properties":{"password":{"description":"Password.","type":"string"},"encryptedPassword":{"description":"Encrypted password.","type":"string"},"additionalPassword":{"description":"Additional password in plaintext.","type":"string"},"additionalEncryptedPassword":{"description":"Additional encrypted password.","type":"string"}},"type":"object"},"selectPsuAuthenticationMethod":{"description":"Content of the body of a Select PSU authentication method request\n","properties":{"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"}},"type":"object","required":["authenticationMethodId"]},"authenticationMethodId":{"description":"An identification provided by the ASPSP for the later identification of the authentication method selection.\n","maxLength":35,"type":"string"},"transactionAuthorisation":{"description":"Content of the body of a transaction authorisation request\n","properties":{"scaAuthenticationData":{"$ref":"#/components/schemas/scaAuthenticationData"}},"type":"object","required":["scaAuthenticationData"]},"scaAuthenticationData":{"description":"SCA authentication data, depending on the chosen authentication method. \nIf the data is binary, then it is base64 encoded.\n","type":"string"},"selectPsuAuthenticationMethodAndAuthorise":{"description":"Select PSU authentication method and transaction authorisation\n","properties":{"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"},"scaAuthenticationData":{"$ref":"#/components/schemas/scaAuthenticationData"}},"type":"object","required":["authenticationMethodId","scaAuthenticationData"]},"startScaprocessResponse":{"description":"Body of the JSON response for a Start SCA authorisation request.","properties":{"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"authorisationId":{"$ref":"#/components/schemas/authorisationId"},"scaMethods":{"$ref":"#/components/schemas/scaMethods"},"chosenScaMethod":{"$ref":"#/components/schemas/chosenScaMethod"},"challengeData":{"$ref":"#/components/schemas/challengeData"},"_links":{"$ref":"#/components/schemas/_linksStartScaProcess"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["scaStatus","authorisationId","_links"]},"scaStatus":{"description":"This data element is containing information about the status of the SCA method applied. \n\nThe following codes are defined for this data type.\n\n  * 'received':\n    An authorisation or cancellation-authorisation resource has been created successfully.\n  * 'psuIdentified':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n  * 'psuAuthenticated':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n  * 'scaMethodSelected':\n    The PSU/TPP has selected the related SCA routine. \n    If the SCA method is chosen implicitly since only one SCA method is available, \n    then this is the first status to be reported instead of 'received'.\n  * 'unconfirmed':\n    SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. \n  * 'started':\n    The addressed SCA routine has been started.\n  * 'finalised':\n    The SCA routine has been finalised successfully (including a potential confirmation command). \n    This is a final status of the authorisation resource.\n  * 'failed':\n    The SCA routine failed.\n    This is a final status of the authorisation resource.\n  * 'exempted':\n    SCA was exempted for the related transaction, the related authorisation is successful.\n    This is a final status of the authorisation resource.\n","type":"string","enum":["received","psuIdentified","psuAuthenticated","scaMethodSelected","started","unconfirmed","finalised","failed","exempted"]},"authorisationId":{"description":"Resource identification of the related SCA.","type":"string"},"scaMethods":{"description":"This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.\n","type":"array","items":{"$ref":"#/components/schemas/authenticationObject"}},"authenticationObject":{"description":"Authentication object.\n","properties":{"authenticationType":{"$ref":"#/components/schemas/authenticationType"},"authenticationVersion":{"description":"Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.\n","type":"string"},"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"},"name":{"description":"This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n","type":"string"},"explanation":{"description":"Detailed information about the SCA method for the PSU.\n","type":"string"}},"type":"object","required":["authenticationType","authenticationMethodId"]},"authenticationType":{"description":"Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n  - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n  - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. \n    To contact the card, the PSU normally needs a (handheld) device. \n    With this device, the PSU either reads the challenging data through a visual interface like flickering or \n    the PSU types in the challenge through the device key pad. \n    The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n  - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data \n    which can be read in by a consumer device or specific mobile app. \n    The device resp. the specific app than derives an OTP from the visual challenge data and displays \n    the OTP to the PSU.\n  - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.\n  - 'SMTP_OTP': An OTP is sent via email to the PSU.\n","type":"string","enum":["SMS_OTP","CHIP_OTP","PHOTO_OTP","PUSH_OTP","SMTP_OTP"]},"chosenScaMethod":{"$ref":"#/components/schemas/authenticationObject"},"challengeData":{"description":"It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.\nIn rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.\n","properties":{"image":{"description":"PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.\n","type":"string"},"data":{"description":"A collection of strings as challenge data.","type":"array","items":{"type":"string"}},"imageLink":{"description":"A link where the ASPSP will provides the challenge image for the TPP.","format":"url","type":"string"},"otpMaxLength":{"description":"The maximal length for the OTP to be typed in by the PSU.","type":"integer"},"otpFormat":{"description":"The format type of the OTP to be typed in. The admitted values are \"characters\" or \"integer\".","type":"string","enum":["characters","integer"]},"additionalInformation":{"description":"Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.\n","type":"string"}},"type":"object"},"_linksStartScaProcess":{"description":"A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the \nresponse depend on the dynamical decisions of the ASPSP when processing the request.\n\n**Remark:** All links can be relative or full links, to be decided by the ASPSP.\n\nType of links admitted in this response, (further links might be added for ASPSP defined \nextensions):\n\n- 'scaRedirect': \n  In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to \n  redirect the PSU browser.\n- 'scaOAuth': \n  In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.\n* 'confirmation': \n  Might be added by the ASPSP if either the \"scaRedirect\" or \"scaOAuth\" hyperlink is returned \n  in the same response message. \n  This hyperlink defines the URL to the resource which needs to be updated with \n    * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or\n    * an access token as retrieved by submitting an authorization code after the integrated OAuth based authentication process with the ASPSP authentication server.\n- 'updatePsuIdentification': \n  The link to the authorisation or cancellation authorisation sub-resource, \n  where PSU identification data needs to be uploaded.\n- 'startAuthorisationWithPsuAuthentication':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where PSU authentication data needs to be uploaded.\n- 'startAuthorisationWithEncryptedPsuAuthentication':\n    Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on \n    application layer in uploading.\n- 'selectAuthenticationMethod':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where the selected authentication method needs to be uploaded. \n  This link is contained under exactly the same conditions as the data element 'scaMethods'.\n- 'authoriseTransaction':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where the authorisation data has to be uploaded, e.g. the TOP received by SMS. \n- 'scaStatus': \n  The link to retrieve the scaStatus of the corresponding authorisation sub-resource. \n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"psuMessageText":{"description":"Text to be displayed to the PSU.","maxLength":500,"type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"CREATED_201_StartScaProcess":{"description":"Created","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"ASPSP-SCA-Approach":{"$ref":"#/components/headers/ASPSP-SCA-Approach"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/startScaprocessResponse"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"ASPSP-SCA-Approach":{"description":"This data element must be contained, if the SCA Approach is already fixed.\nPossible values are\n  * EMBEDDED\n  * DECOUPLED\n  * REDIRECT\nThe OAuth SCA approach will be subsumed by REDIRECT.\n","required":false,"schema":{"type":"string","enum":["EMBEDDED","DECOUPLED","REDIRECT"]}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/authorisations":{"post":{"tags":["consents"],"summary":"Start the authorisation process for a consent","description":"Create an authorisation sub-resource and start the authorisation process of a consent. \nThe message might in addition transmit authentication and authorisation related data.\n\nhis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the consent.\n\nThe ASPSP might make the usage of this access method unnecessary, \nsince the related authorisation resource will be automatically created by \nthe ASPSP after the submission of the consent data with the first POST consents call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n  * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment \n    initiation response that an explicit start of the authorisation process is needed by the TPP. \n    The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n    uploaded by using the extended forms:\n    * 'startAuthorisationWithPsuIdentification', \n    * 'startAuthorisationWithPsuAuthentication' \n    * 'startAuthorisationWithEncryptedPsuAuthentication'\n    * 'startAuthorisationWithAuthentciationMethodSelection' \n  * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n  * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding \n    payment cancellation response that an explicit start of the authorisation process is needed by the TPP. \n    The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n    by using the extended forms as indicated above.\n  * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n    executing the cancellation.\n  * The signing basket needs to be authorised yet.\n","operationId":"startConsentAuthorisation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-ID"},{"$ref":"#/components/parameters/PSU-ID-Type"},{"$ref":"#/components/parameters/PSU-Corporate-ID"},{"$ref":"#/components/parameters/PSU-Corporate-ID-Type"},{"$ref":"#/components/parameters/TPP-Redirect-Preferred"},{"$ref":"#/components/parameters/TPP-Redirect-URI"},{"$ref":"#/components/parameters/TPP-Nok-Redirect-URI"},{"$ref":"#/components/parameters/TPP-Notification-URI"},{"$ref":"#/components/parameters/TPP-Notification-Content-Preferred"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/startConsentAuthorisationPsuDataRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CREATED_201_StartScaProcess"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## Consent status request

> Read the status of an account information consent resource.

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"consentStatusResponse-200":{"description":"Body of the JSON response for a successful get status request for a consent.","properties":{"consentStatus":{"$ref":"#/components/schemas/consentStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["consentStatus"]},"consentStatus":{"description":"This is the overall lifecycle status of the consent.\n\nValid values are:\n  - 'received': The consent data have been received and are technically correct. \n    The data is not authorised yet.\n  - 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.\n  - 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.\n  - 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.\n  - 'expired': The consent expired.\n  - 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.\n  - 'partiallyAuthorised': The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.\n\nThe ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface \nand has to be added to this API definition as well.\n","type":"string","enum":["received","rejected","valid","revokedByPsu","expired","terminatedByTpp","partiallyAuthorised"]},"psuMessageText":{"description":"Text to be displayed to the PSU.","maxLength":500,"type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"OK_200_ConsentStatus":{"description":"OK","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consentStatusResponse-200"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/status":{"get":{"tags":["consents"],"summary":"Consent status request","description":"Read the status of an account information consent resource.","operationId":"getConsentStatus","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ConsentStatus"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## 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.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"consentInformationResponse-200_json":{"description":"Body of the JSON response for a successfull get consent request.","properties":{"access":{"$ref":"#/components/schemas/accountAccess"},"recurringIndicator":{"$ref":"#/components/schemas/recurringIndicator"},"validUntil":{"$ref":"#/components/schemas/validUntil"},"frequencyPerDay":{"$ref":"#/components/schemas/frequencyPerDay"},"lastActionDate":{"$ref":"#/components/schemas/lastActionDate"},"consentStatus":{"$ref":"#/components/schemas/consentStatus"},"_links":{"$ref":"#/components/schemas/_linksGetConsent"}},"type":"object","required":["access","recurringIndicator","validUntil","frequencyPerDay","lastActionDate","consentStatus"]},"accountAccess":{"description":"Requested access services for a consent.\n","properties":{"accounts":{"description":"Is asking for detailed account information. \n\nIf the array is empty in a request, the TPP is asking for an accessible account list. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"balances":{"description":"Is asking for balances of the addressed accounts.\n\nIf the array is empty in the request, the TPP is asking for the balances of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"transactions":{"description":"Is asking for transactions of the addressed accounts. \n\nIf the array is empty in the request, the TPP is asking for the transactions of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or balances shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"additionalInformation":{"$ref":"#/components/schemas/additionalInformationAccess"},"availableAccounts":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"availableAccountsWithBalance":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"allPsd2":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"restrictedTo":{"description":"If the TPP requests access to accounts via availableAccounts (List of available accounts), global \nor bank driven consents, the TPP may include this element to restrict access to the referred \naccount types. Absence of the element is interpreted as \"no restriction\" (therefore access to \naccounts of all types is requested). The element may only occur, if each of the elements \n  - accounts \n  - balances \n  - transactions \nis either not present or contains an empty array.\n","type":"array","items":{"$ref":"#/components/schemas/cashAccountType"}}},"type":"object"},"accountReference":{"description":"Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * BBAN, for payment accounts if there is no IBAN, or \n  * the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or\n  * the Primary Account Number (PAN) of a card in a masked form, or\n  * an alias to access a payment account via a registered mobile phone number (MSISDN), or\n  * a proprietary ID of the  respective account that uniquely identifies the account for this ASPSP.\n","properties":{"iban":{"$ref":"#/components/schemas/iban"},"bban":{"$ref":"#/components/schemas/bban"},"pan":{"$ref":"#/components/schemas/pan"},"maskedPan":{"$ref":"#/components/schemas/maskedPan"},"msisdn":{"$ref":"#/components/schemas/msisdn"},"other":{"$ref":"#/components/schemas/otherType"},"currency":{"$ref":"#/components/schemas/currencyCode"},"cashAccountType":{"$ref":"#/components/schemas/cashAccountType"}},"type":"object"},"iban":{"description":"IBAN of an account.","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"bban":{"description":"Basic Bank Account Number (BBAN) Identifier.\n\nThis data element can be used in the body of the consent request.\n  Message for retrieving account access consent from this account. This\n  data elements is used for payment accounts which have no IBAN.\n  ISO20022: Basic Bank Account Number (BBAN). \n\n  Identifier used nationally by financial institutions, i.e., in individual countries, \n  generally as part of a National Account Numbering Scheme(s), \n  which uniquely identifies the account of a customer.\n","pattern":"[a-zA-Z0-9]{1,30}","type":"string"},"pan":{"description":"Primary Account Number according to ISO/IEC 7812.\n","maxLength":35,"type":"string"},"maskedPan":{"description":"Masked Primary Account Number.\n","maxLength":35,"type":"string"},"msisdn":{"description":"Mobile phone number.","maxLength":35,"type":"string"},"otherType":{"description":"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.","properties":{"identification":{"description":"Proprietary identification of the account.","maxLength":35,"type":"string"},"schemeNameCode":{"description":"An entry provided by an external ISO code list.","maxLength":35,"type":"string"},"schemeNameProprietary":{"description":"A scheme name defined in a proprietary way.","maxLength":35,"type":"string"},"issuer":{"description":"Issuer of the identification.","maxLength":35,"type":"string"}},"type":"object","required":["identification"]},"currencyCode":{"description":"ISO 4217 Alpha 3 currency code.\n","pattern":"[A-Z]{3}","type":"string"},"cashAccountType":{"description":"ExternalCashAccountType1Code from ISO 20022.\n","type":"string"},"additionalInformationAccess":{"description":"Optional if supported by API provider.\n\nIs asking for additional information as added within this structured object.\nThe usage of this data element requires at least one of the entries \"accounts\", \n\"transactions\" or \"balances\" also to be contained in the object. \nIf detailed accounts are referenced, it is required in addition that any account addressed within \nthe additionalInformation attribute is also addressed by at least one of the attributes \"accounts\", \n\"transactions\" or \"balances\".\n","properties":{"ownerName":{"description":"Is asking for account owner name of the accounts referenced within. \nIf the array is empty in the request, the TPP is asking for the account \nowner name of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, balances or transactions shall be empty, if used.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the ownerName consent can be accepted by providing the accounts on which the ownerName will \nbe delivered. \nThis array can be empty.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"trustedBeneficiaries":{"description":"Optional if supported by API provider.\nIs asking for the trusted beneficiaries related to the accounts referenced within and related to the PSU.\nIf the array is empty in the request, the TPP is asking for the lists of trusted beneficiaries of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue by the PSU if also the account lists addressed \nby the tags “accounts”, “balances” or “transactions” are empty.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the trustedBeneficiaries consent can be accepted by providing the accounts on which the list of trusted beneficiaries will be delivered. \nThis array can be empty.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}}},"type":"object"},"recurringIndicator":{"description":"\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.\n","type":"boolean"},"validUntil":{"description":"This parameter is defining a valid until date (including the mentioned date) for the requested consent. \nThe content is the local ASPSP date in ISO-Date format, e.g. 2017-10-30.\n\nFuture dates might get adjusted by ASPSP. \n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\". \n\nIn both cases the consent object to be retrieved by the get consent request will contain the adjusted date.\n","format":"date","type":"string"},"frequencyPerDay":{"description":"This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one. \n\nIf not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.\n","exclusiveMinimum":false,"minimum":1,"type":"integer"},"lastActionDate":{"description":"This date is containing the date of the last action on the consent object either through \nthe XS2A interface or the PSU/ASPSP interface having an impact on the status.\n","format":"date","type":"string"},"consentStatus":{"description":"This is the overall lifecycle status of the consent.\n\nValid values are:\n  - 'received': The consent data have been received and are technically correct. \n    The data is not authorised yet.\n  - 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.\n  - 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.\n  - 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.\n  - 'expired': The consent expired.\n  - 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.\n  - 'partiallyAuthorised': The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.\n\nThe ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface \nand has to be added to this API definition as well.\n","type":"string","enum":["received","rejected","valid","revokedByPsu","expired","terminatedByTpp","partiallyAuthorised"]},"_linksGetConsent":{"description":"A list of hyperlinks to be recognised by the TPP.\n\nLinks of type \"account\" and/or \"cardAccount\", depending on the nature of the consent.\n","properties":{"account":{"$ref":"#/components/schemas/hrefType"},"card-account":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"OK_200_ConsentInformation":{"description":"OK","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consentInformationResponse-200_json"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}":{"get":{"tags":["consents"],"summary":"Get consent request","description":"Returns the content of an account information consent object. \nThis is returning the data for the TPP especially in cases, \nwhere the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.\n","operationId":"getConsentInformation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ConsentInformation"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## Delete consent

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

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"NO_CONTENT_204_Consents":{"description":"No Content","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}":{"delete":{"tags":["consents"],"summary":"Delete consent","description":"The TPP can delete an account information consent object if needed.","operationId":"deleteConsent","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"204":{"$ref":"#/components/responses/NO_CONTENT_204_Consents"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## 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\
> &#x20; \* to see the list of available payment accounts or\
> &#x20; \* to see the list of available payment accounts with balances.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-ID":{"description":"Client ID of the PSU in the ASPSP client interface. \n\nMight be mandated in the ASPSP's documentation.\n\nIt 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\nAIS service in the same session.\nIn this case the ASPSP might check whether PSU-ID and token match, \naccording to ASPSP documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID"},"PSU-ID-Type":{"description":"Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.\n\nIn this case, the mean and use are then defined in the ASPSP’s documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID-Type"},"PSU-Corporate-ID":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID"},"PSU-Corporate-ID-Type":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID-Type"},"TPP-Redirect-Preferred":{"description":"If it equals \"true\", the TPP prefers a redirect over an embedded SCA approach.\nIf it equals \"false\", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled\nSCA approach, depending on the parameter TPP-Decoupled-Preferred and the choice of the SCA procedure by the TPP/PSU.\nIf the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the\nTPP/PSU.\n","required":false,"schema":{"type":"boolean"},"in":"header","name":"TPP-Redirect-Preferred"},"TPP-Decoupled-Preferred":{"description":"If it equals \"true\", the TPP prefers a decoupled SCA approach. \nIf it equals \"false\", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. \nIf the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU. \nThe parameter might be ignored by the ASPSP.\nIf both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.\n\n**Remark for Future:** \nTPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.\n","required":false,"schema":{"type":"boolean"},"in":"header","name":"TPP-Decoupled-Preferred"},"TPP-Redirect-URI":{"description":"URI of the TPP, where the transaction flow shall be redirected to after a Redirect.\n\nMandated for the Redirect SCA Approach, specifically \nwhen TPP-Redirect-Preferred equals \"true\".\nIt is recommended to always use this header field.\n\n**Remark for Future:** \nThis field might be changed to mandatory in the next version of the specification.\n","required":false,"schema":{"format":"uri","type":"string"},"in":"header","name":"TPP-Redirect-URI"},"TPP-Nok-Redirect-URI":{"description":"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\nof a negative result of the redirect SCA method. This might be ignored by the ASPSP.\n","required":false,"schema":{"format":"uri","type":"string"},"in":"header","name":"TPP-Nok-Redirect-URI"},"TPP-Explicit-Authorisation-Preferred":{"description":"If it equals \"true\", the TPP prefers to start the authorisation process separately, \ne.g. because of the usage of a signing basket. \nThis preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.\n\nIf it equals \"false\" or if the parameter is not used, there is no preference of the TPP. \nThis especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, \nwithout using a signing basket.\n","required":false,"schema":{"type":"boolean"},"in":"header","name":"TPP-Explicit-Authorisation-Preferred"},"TPP-Brand-Logging-Information":{"description":"This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. \nThis information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. \nThis header might be ignored by the ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"TPP-Brand-Logging-Information"},"TPP-Notification-URI":{"description":"URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent.\nThis header field may by ignored by the ASPSP.\n\nFor 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:\n\nURIs 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.\n\nWildcard definitions shall be taken into account for compliance checks by the ASPSP.\n ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.\n","required":false,"schema":{"type":"string"},"in":"header","name":"TPP-Notification-URI"},"TPP-Notification-Content-Preferred":{"description":"The string has the form \n\nstatus=X1, ..., Xn\n\nwhere Xi is one of the constants SCA, PROCESS, LAST and where constants are not\nrepeated.\nThe usage of the constants supports the of following semantics:\n\n  SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.\n\n  PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP.\n  LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.\n\nThis header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"TPP-Notification-Content-Preferred"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-IP-Address_mandatory":{"description":"The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.\nIf not available, the TPP shall use the IP Address used by the TPP when submitting this request.\n","required":true,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"requestBodies":{"consents":{"description":"Request body for a consents request.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consents"}}}}},"schemas":{"consents":{"description":"Content of the body of a consent request.\n","properties":{"access":{"$ref":"#/components/schemas/accountAccess"},"recurringIndicator":{"$ref":"#/components/schemas/recurringIndicator"},"validUntil":{"$ref":"#/components/schemas/validUntil"},"frequencyPerDay":{"$ref":"#/components/schemas/frequencyPerDay"},"combinedServiceIndicator":{"description":"If \"true\" indicates that a payment initiation service will be addressed in the same \"session\".\n","type":"boolean"}},"type":"object","required":["access","recurringIndicator","validUntil","frequencyPerDay","combinedServiceIndicator"]},"accountAccess":{"description":"Requested access services for a consent.\n","properties":{"accounts":{"description":"Is asking for detailed account information. \n\nIf the array is empty in a request, the TPP is asking for an accessible account list. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"balances":{"description":"Is asking for balances of the addressed accounts.\n\nIf the array is empty in the request, the TPP is asking for the balances of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"transactions":{"description":"Is asking for transactions of the addressed accounts. \n\nIf the array is empty in the request, the TPP is asking for the transactions of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or balances shall be empty, if used.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"additionalInformation":{"$ref":"#/components/schemas/additionalInformationAccess"},"availableAccounts":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"availableAccountsWithBalance":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"allPsd2":{"description":"Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n","type":"string","enum":["allAccounts","allAccountsWithOwnerName"]},"restrictedTo":{"description":"If the TPP requests access to accounts via availableAccounts (List of available accounts), global \nor bank driven consents, the TPP may include this element to restrict access to the referred \naccount types. Absence of the element is interpreted as \"no restriction\" (therefore access to \naccounts of all types is requested). The element may only occur, if each of the elements \n  - accounts \n  - balances \n  - transactions \nis either not present or contains an empty array.\n","type":"array","items":{"$ref":"#/components/schemas/cashAccountType"}}},"type":"object"},"accountReference":{"description":"Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * BBAN, for payment accounts if there is no IBAN, or \n  * the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or\n  * the Primary Account Number (PAN) of a card in a masked form, or\n  * an alias to access a payment account via a registered mobile phone number (MSISDN), or\n  * a proprietary ID of the  respective account that uniquely identifies the account for this ASPSP.\n","properties":{"iban":{"$ref":"#/components/schemas/iban"},"bban":{"$ref":"#/components/schemas/bban"},"pan":{"$ref":"#/components/schemas/pan"},"maskedPan":{"$ref":"#/components/schemas/maskedPan"},"msisdn":{"$ref":"#/components/schemas/msisdn"},"other":{"$ref":"#/components/schemas/otherType"},"currency":{"$ref":"#/components/schemas/currencyCode"},"cashAccountType":{"$ref":"#/components/schemas/cashAccountType"}},"type":"object"},"iban":{"description":"IBAN of an account.","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"bban":{"description":"Basic Bank Account Number (BBAN) Identifier.\n\nThis data element can be used in the body of the consent request.\n  Message for retrieving account access consent from this account. This\n  data elements is used for payment accounts which have no IBAN.\n  ISO20022: Basic Bank Account Number (BBAN). \n\n  Identifier used nationally by financial institutions, i.e., in individual countries, \n  generally as part of a National Account Numbering Scheme(s), \n  which uniquely identifies the account of a customer.\n","pattern":"[a-zA-Z0-9]{1,30}","type":"string"},"pan":{"description":"Primary Account Number according to ISO/IEC 7812.\n","maxLength":35,"type":"string"},"maskedPan":{"description":"Masked Primary Account Number.\n","maxLength":35,"type":"string"},"msisdn":{"description":"Mobile phone number.","maxLength":35,"type":"string"},"otherType":{"description":"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.","properties":{"identification":{"description":"Proprietary identification of the account.","maxLength":35,"type":"string"},"schemeNameCode":{"description":"An entry provided by an external ISO code list.","maxLength":35,"type":"string"},"schemeNameProprietary":{"description":"A scheme name defined in a proprietary way.","maxLength":35,"type":"string"},"issuer":{"description":"Issuer of the identification.","maxLength":35,"type":"string"}},"type":"object","required":["identification"]},"currencyCode":{"description":"ISO 4217 Alpha 3 currency code.\n","pattern":"[A-Z]{3}","type":"string"},"cashAccountType":{"description":"ExternalCashAccountType1Code from ISO 20022.\n","type":"string"},"additionalInformationAccess":{"description":"Optional if supported by API provider.\n\nIs asking for additional information as added within this structured object.\nThe usage of this data element requires at least one of the entries \"accounts\", \n\"transactions\" or \"balances\" also to be contained in the object. \nIf detailed accounts are referenced, it is required in addition that any account addressed within \nthe additionalInformation attribute is also addressed by at least one of the attributes \"accounts\", \n\"transactions\" or \"balances\".\n","properties":{"ownerName":{"description":"Is asking for account owner name of the accounts referenced within. \nIf the array is empty in the request, the TPP is asking for the account \nowner name of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, balances or transactions shall be empty, if used.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the ownerName consent can be accepted by providing the accounts on which the ownerName will \nbe delivered. \nThis array can be empty.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}},"trustedBeneficiaries":{"description":"Optional if supported by API provider.\nIs asking for the trusted beneficiaries related to the accounts referenced within and related to the PSU.\nIf the array is empty in the request, the TPP is asking for the lists of trusted beneficiaries of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue by the PSU if also the account lists addressed \nby the tags “accounts”, “balances” or “transactions” are empty.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the trustedBeneficiaries consent can be accepted by providing the accounts on which the list of trusted beneficiaries will be delivered. \nThis array can be empty.\n","type":"array","items":{"$ref":"#/components/schemas/accountReference"}}},"type":"object"},"recurringIndicator":{"description":"\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.\n","type":"boolean"},"validUntil":{"description":"This parameter is defining a valid until date (including the mentioned date) for the requested consent. \nThe content is the local ASPSP date in ISO-Date format, e.g. 2017-10-30.\n\nFuture dates might get adjusted by ASPSP. \n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\". \n\nIn both cases the consent object to be retrieved by the get consent request will contain the adjusted date.\n","format":"date","type":"string"},"frequencyPerDay":{"description":"This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one. \n\nIf not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.\n","exclusiveMinimum":false,"minimum":1,"type":"integer"},"consentsResponse-201":{"description":"Body of the JSON response for a successful consent request.","properties":{"consentStatus":{"$ref":"#/components/schemas/consentStatus"},"consentId":{"$ref":"#/components/schemas/consentId"},"scaMethods":{"$ref":"#/components/schemas/scaMethods"},"chosenScaMethod":{"$ref":"#/components/schemas/chosenScaMethod"},"challengeData":{"$ref":"#/components/schemas/challengeData"},"_links":{"$ref":"#/components/schemas/_linksConsents"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["consentStatus","consentId","_links"]},"consentStatus":{"description":"This is the overall lifecycle status of the consent.\n\nValid values are:\n  - 'received': The consent data have been received and are technically correct. \n    The data is not authorised yet.\n  - 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.\n  - 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.\n  - 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.\n  - 'expired': The consent expired.\n  - 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.\n  - 'partiallyAuthorised': The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.\n\nThe ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface \nand has to be added to this API definition as well.\n","type":"string","enum":["received","rejected","valid","revokedByPsu","expired","terminatedByTpp","partiallyAuthorised"]},"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"scaMethods":{"description":"This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.\n","type":"array","items":{"$ref":"#/components/schemas/authenticationObject"}},"authenticationObject":{"description":"Authentication object.\n","properties":{"authenticationType":{"$ref":"#/components/schemas/authenticationType"},"authenticationVersion":{"description":"Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.\n","type":"string"},"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"},"name":{"description":"This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n","type":"string"},"explanation":{"description":"Detailed information about the SCA method for the PSU.\n","type":"string"}},"type":"object","required":["authenticationType","authenticationMethodId"]},"authenticationType":{"description":"Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n  - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n  - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. \n    To contact the card, the PSU normally needs a (handheld) device. \n    With this device, the PSU either reads the challenging data through a visual interface like flickering or \n    the PSU types in the challenge through the device key pad. \n    The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n  - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data \n    which can be read in by a consumer device or specific mobile app. \n    The device resp. the specific app than derives an OTP from the visual challenge data and displays \n    the OTP to the PSU.\n  - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.\n  - 'SMTP_OTP': An OTP is sent via email to the PSU.\n","type":"string","enum":["SMS_OTP","CHIP_OTP","PHOTO_OTP","PUSH_OTP","SMTP_OTP"]},"authenticationMethodId":{"description":"An identification provided by the ASPSP for the later identification of the authentication method selection.\n","maxLength":35,"type":"string"},"chosenScaMethod":{"$ref":"#/components/schemas/authenticationObject"},"challengeData":{"description":"It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.\nIn rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.\n","properties":{"image":{"description":"PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.\n","type":"string"},"data":{"description":"A collection of strings as challenge data.","type":"array","items":{"type":"string"}},"imageLink":{"description":"A link where the ASPSP will provides the challenge image for the TPP.","format":"url","type":"string"},"otpMaxLength":{"description":"The maximal length for the OTP to be typed in by the PSU.","type":"integer"},"otpFormat":{"description":"The format type of the OTP to be typed in. The admitted values are \"characters\" or \"integer\".","type":"string","enum":["characters","integer"]},"additionalInformation":{"description":"Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.\n","type":"string"}},"type":"object"},"_linksConsents":{"description":"A list of hyperlinks to be recognised by the TPP.\n\nType of links admitted in this response (which might be extended by single ASPSPs as indicated in its XS2A \ndocumentation):\n  * 'scaRedirect': \n    In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the \n    PSU browser.\n  * 'scaOAuth': \n    In case of an OAuth2 based Redirect Approach, the ASPSP is transmitting the link where the configuration \n    of the OAuth2 Server is defined. \n    The configuration follows the OAuth 2.0 Authorisation Server Metadata specification. \n* 'confirmation': \n  Might be added by the ASPSP if either the \"scaRedirect\" or \"scaOAuth\" hyperlink is returned \n  in the same response message. \n  This hyperlink defines the URL to the resource which needs to be updated with \n    * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or\n    * an access token as retrieved by submitting an authorization code after the integrated OAuth based authentication process with the ASPSP authentication server.\n  * 'startAuthorisation': \n    In case, where an explicit start of the transaction authorisation is needed, \n    but no more data needs to be updated (no authentication method to be selected, \n    no PSU identification nor PSU authentication data to be uploaded).\n  * 'startAuthorisationWithPsuIdentification': \n    The link to the authorisation end-point, where the authorisation sub-resource has to be generated \n    while uploading the PSU identification data.\n  * 'startAuthorisationWithPsuAuthentication':\n    The link to the authorisation end-point, where the authorisation sub-resource has to be generated \n    while uploading the PSU authentication data.\n  * 'startAuthorisationWithEncryptedPsuAuthentication':\n    Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on \n    application layer in uploading.\n  * 'startAuthorisationWithAuthenticationMethodSelection':\n    The link to the authorisation end-point, where the authorisation sub-resource has to be generated \n    while selecting the authentication method. This link is contained under exactly the same conditions \n    as the data element 'scaMethods' \n  * 'startAuthorisationWithTransactionAuthorisation':\n    The link to the authorisation end-point, where the authorisation sub-resource has to be generated \n    while authorising the transaction e.g. by uploading an OTP received by SMS.\n  * 'self': \n    The link to the Establish Account Information Consent resource created by this request. \n    This link can be used to retrieve the resource data. \n  * 'status': \n    The link to retrieve the status of the account information consent.\n  * 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. \n    This link is only contained, if an authorisation sub-resource has been already created.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"psuMessageText":{"description":"Text to be displayed to the PSU.","maxLength":500,"type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"CREATED_201_Consents":{"description":"Created","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"ASPSP-SCA-Approach":{"$ref":"#/components/headers/ASPSP-SCA-Approach"},"ASPSP-Notification-Support":{"$ref":"#/components/headers/ASPSP-Notification-Support"},"ASPSP-Notification-Content":{"$ref":"#/components/headers/ASPSP-Notification-Content"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consentsResponse-201"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"ASPSP-SCA-Approach":{"description":"This data element must be contained, if the SCA Approach is already fixed.\nPossible values are\n  * EMBEDDED\n  * DECOUPLED\n  * REDIRECT\nThe OAuth SCA approach will be subsumed by REDIRECT.\n","required":false,"schema":{"type":"string","enum":["EMBEDDED","DECOUPLED","REDIRECT"]}},"ASPSP-Notification-Support":{"description":"true if the ASPSP supports resource status notification services.\n\nfalse if the ASPSP supports resource status notification in general, but not for the current request.\n\nNot used, if resource status notification services are generally not supported by the ASPSP.\n\nShall be supported if the ASPSP supports resource status notification services.\n","required":false,"schema":{"type":"boolean"}},"ASPSP-Notification-Content":{"description":"The string has the form\nstatus=X1, …, Xn\nwhere Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated.\nThe usage of the constants supports the following semantics\nSCA - Notification on every change of the scaStatus attribute for all related authorisation processes is provided by the ASPSP for the related resource.\nPROCESS - Notification on all changes of consentStatus or transactionStatus attributes is provided by the ASPSP for the related resource\nLAST - Notification on the last consentStatus or transactionStatus as available in the XS2A interface is provided by the ASPSP for the related resource.\nThis field must be provided if the ASPSP-Notification-Support=true. The ASPSP might consider the notification content as preferred by the TPP, but can also respond independently of the preferred request\n","required":false,"schema":{"type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents":{"post":{"tags":["consents"],"summary":"Create consent","description":"This method create a consent resource, defining access rights to dedicated accounts of \na given PSU-ID. These accounts are addressed explicitly in the method as \nparameters as a core function.\n\n**Side Effects**\nWhen this consent request is a request where the \"recurringIndicator\" equals \"true\",\nand if it exists already a former consent for recurring access on account information \nfor the addressed PSU, then the former consent automatically expires as soon as the new \nconsent request is authorised by the PSU.\n\nOptional Extension:\nAs an option, an ASPSP might optionally accept a specific access right on the access on all PSD2 related services for all available accounts.\n\nAs another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. \nThe relation to accounts is then handled afterwards between PSU and ASPSP. \nThis option is not supported for the Embedded SCA Approach. \nAs a last option, an ASPSP might in addition accept a command with access rights\n  * to see the list of available payment accounts or\n  * to see the list of available payment accounts with balances.\n","operationId":"createConsent","parameters":[{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-ID"},{"$ref":"#/components/parameters/PSU-ID-Type"},{"$ref":"#/components/parameters/PSU-Corporate-ID"},{"$ref":"#/components/parameters/PSU-Corporate-ID-Type"},{"$ref":"#/components/parameters/TPP-Redirect-Preferred"},{"$ref":"#/components/parameters/TPP-Decoupled-Preferred"},{"$ref":"#/components/parameters/TPP-Redirect-URI"},{"$ref":"#/components/parameters/TPP-Nok-Redirect-URI"},{"$ref":"#/components/parameters/TPP-Explicit-Authorisation-Preferred"},{"$ref":"#/components/parameters/TPP-Brand-Logging-Information"},{"$ref":"#/components/parameters/TPP-Notification-URI"},{"$ref":"#/components/parameters/TPP-Notification-Content-Preferred"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-IP-Address_mandatory"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"requestBody":{"$ref":"#/components/requestBodies/consents"},"responses":{"201":{"$ref":"#/components/responses/CREATED_201_Consents"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## Callback for consent authorisation

> This method is used by the ASPSP to callback the TPP with the result of the SCA process.\
> The ASPSP can use this method to inform the TPP about the result of the SCA process.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Authorisation-Code":{"description":"Authorisation code.","required":true,"schema":{"type":"string"},"in":"query","name":"code"},"Authorisation-State":{"description":"Authorisation state.","required":true,"schema":{"type":"string"},"in":"query","name":"state"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"RECEIVED_202_CallbackAuthorisation":{"description":"Received","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/authorisations/callback":{"post":{"tags":["consents"],"summary":"Callback for consent authorisation","description":"This method is used by the ASPSP to callback the TPP with the result of the SCA process.\nThe ASPSP can use this method to inform the TPP about the result of the SCA process.\n","operationId":"callbackConsentAuthorisation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Authorisation-Code"},{"$ref":"#/components/parameters/Authorisation-State"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"202":{"$ref":"#/components/responses/RECEIVED_202_CallbackAuthorisation"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"METHOD_NOT_ALLOWED","content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"406":{"description":"NOT_ACCEPTABLE","content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"415":{"description":"UNSUPPORTED_MEDIA_TYPE","content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"TOO_MANY_REQUESTS","content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}}}}}}}
```

## Read the SCA status of the consent authorisation

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

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"authorisationId":{"description":"Resource identification of the related SCA.","required":true,"schema":{"$ref":"#/components/schemas/authorisationId"},"in":"path","name":"authorisationId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"authorisationId":{"description":"Resource identification of the related SCA.","type":"string"},"scaStatusResponse":{"description":"Body of the JSON response with SCA Status.","properties":{"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"},"psuName":{"description":"Name of the PSU. In case of a corporate account, this might be the person acting on behalf of the corporate.\n","maxLength":140,"type":"string"},"trustedBeneficiaryFlag":{"$ref":"#/components/schemas/trustedBeneficiaryFlag"},"_links":{"$ref":"#/components/schemas/_linksAll"},"tppMessage":{"description":"Messages to the TPP on operational issues.","type":"array","items":{"$ref":"#/components/schemas/tppMessageGeneric"}}},"type":"object","required":["scaStatus"]},"scaStatus":{"description":"This data element is containing information about the status of the SCA method applied. \n\nThe following codes are defined for this data type.\n\n  * 'received':\n    An authorisation or cancellation-authorisation resource has been created successfully.\n  * 'psuIdentified':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n  * 'psuAuthenticated':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n  * 'scaMethodSelected':\n    The PSU/TPP has selected the related SCA routine. \n    If the SCA method is chosen implicitly since only one SCA method is available, \n    then this is the first status to be reported instead of 'received'.\n  * 'unconfirmed':\n    SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. \n  * 'started':\n    The addressed SCA routine has been started.\n  * 'finalised':\n    The SCA routine has been finalised successfully (including a potential confirmation command). \n    This is a final status of the authorisation resource.\n  * 'failed':\n    The SCA routine failed.\n    This is a final status of the authorisation resource.\n  * 'exempted':\n    SCA was exempted for the related transaction, the related authorisation is successful.\n    This is a final status of the authorisation resource.\n","type":"string","enum":["received","psuIdentified","psuAuthenticated","scaMethodSelected","started","unconfirmed","finalised","failed","exempted"]},"psuMessageText":{"description":"Text to be displayed to the PSU.","maxLength":500,"type":"string"},"trustedBeneficiaryFlag":{"description":"Additional Service: Trusted Beneficiaries\nWithin this data element, the ASPSP might optionally communicate towards the TPP whether the creditor was part of the related trusted beneficiary list. \nThis attribute is only contained in case of a final scaStatus.\n","type":"boolean"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"tppMessageGeneric":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/tppMessageCodeGeneric"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"tppMessageCodeGeneric":{"description":"Code of the TPP message category.","type":"string"},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"OK_200_ScaStatus":{"description":"OK","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scaStatusResponse"}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/authorisations/{authorisationId}":{"get":{"tags":["consents"],"summary":"Read the SCA status of the consent authorisation","description":"This method returns the SCA status of a consent initiation's authorisation sub-resource.\n","operationId":"getConsentScaStatus","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/authorisationId"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ScaStatus"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```

## Update PSU Data for consents

> This method update PSU data on the consents  resource if needed. \
> It may authorise a consent within the Embedded SCA Approach where needed.\
> \
> Independently from the SCA Approach it supports e.g. the selection of \
> the authentication method and a non-SCA PSU authentication.\
> \
> This methods updates PSU data on the cancellation authorisation resource if needed. \
> \
> There are several possible update PSU data requests in the context of a consent request if needed, \
> which depends on the SCA approach:\
> \
> \* Redirect SCA Approach:\
> &#x20; A specific Update PSU data request is applicable for \
> &#x20;   \* the selection of authentication methods, before choosing the actual SCA approach.\
> \* Decoupled SCA Approach:\
> &#x20; A specific update PSU data request is only applicable for\
> &#x20; \* adding the PSU Identification, if not provided yet in the payment initiation request or the Account Information Consent Request, or if no OAuth2 access token is used, or\
> &#x20; \* the selection of authentication methods.\
> \* Embedded SCA Approach: \
> &#x20; The Update PSU data request might be used \
> &#x20; \* to add credentials as a first factor authentication data of the PSU and\
> &#x20; \* to select the authentication method and\
> &#x20; \* transaction authorisation.\
> \
> The SCA Approach might depend on the chosen SCA method. \
> For that reason, the following possible update PSU data request can apply to all SCA approaches:\
> \
> \* Select an SCA method in case of several SCA methods are available for the customer.\
> \
> There are the following request types on this access path:\
> &#x20; \* Update PSU identification\
> &#x20; \* Update PSU authentication\
> &#x20; \* Select PSU authorization method \
> &#x20;   WARNING: This method needs a reduced header, \
> &#x20;   therefore many optional elements are not present. \
> &#x20;   Maybe in a later version the access path will change.\
> &#x20; \* Transaction Authorisation\
> &#x20;   WARNING: This method needs a reduced header, \
> &#x20;   therefore many optional elements are not present. \
> &#x20;   Maybe in a later version the access path will change.<br>

```json
{"openapi":"3.0.1","info":{"title":"aggregated-xs2a","version":"1.3.1"},"tags":[{"name":"consents","description":"Establish consent on account and card account information initiation services:\n  * get information on the consent status and the consent details\n  * update PSU authentication data and select PSU authentication methods for a consent.\n"}],"servers":[{"url":"https://sandbox.api.tieto.com","description":"Tieto Aggregation sandbox"}],"security":[{"OAuth2ClientAuthentication":[]}],"components":{"securitySchemes":{"OAuth2ClientAuthentication":{"type":"openIdConnect","description":"This API uses OAuth 2 with the client credentials flow. [More info](https://www.rfc-editor.org/rfc/rfc6749#section-4.4)","openIdConnectUrl":"/auth/realms/participants/protocol/openid-connect/token"}},"parameters":{"consentId_PATH":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","required":true,"schema":{"$ref":"#/components/schemas/consentId"},"in":"path","name":"consentId"},"authorisationId":{"description":"Resource identification of the related SCA.","required":true,"schema":{"$ref":"#/components/schemas/authorisationId"},"in":"path","name":"authorisationId"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"},"in":"header","name":"X-Request-ID"},"Session-ID":{"description":"ID of the session.","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"Session-ID"},"Digest":{"description":"Is contained if and only if the \"Signature\" element is contained in the header of the request.","required":false,"schema":{"type":"string"},"in":"header","name":"Digest"},"Signature":{"description":"A signature of the request by the TPP on application level. This might be mandated by ASPSP.\n","required":false,"schema":{"type":"string"},"in":"header","name":"Signature"},"TPP-Signature-Certificate":{"description":"The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n","required":false,"schema":{"format":"byte","type":"string"},"in":"header","name":"TPP-Signature-Certificate"},"PSU-ID":{"description":"Client ID of the PSU in the ASPSP client interface. \n\nMight be mandated in the ASPSP's documentation.\n\nIt 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\nAIS service in the same session.\nIn this case the ASPSP might check whether PSU-ID and token match, \naccording to ASPSP documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID"},"PSU-ID-Type":{"description":"Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.\n\nIn this case, the mean and use are then defined in the ASPSP’s documentation.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-ID-Type"},"PSU-Corporate-ID":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID"},"PSU-Corporate-ID-Type":{"description":"Might be mandated in the ASPSP's documentation. Only used in a corporate context.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Corporate-ID-Type"},"PSU-IP-Address_conditionalForAis":{"description":"The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n","required":false,"schema":{"format":"ipv4","type":"string"},"in":"header","name":"PSU-IP-Address"},"PSU-IP-Port":{"description":"The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-IP-Port"},"PSU-Accept":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept"},"PSU-Accept-Charset":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Charset"},"PSU-Accept-Encoding":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Encoding"},"PSU-Accept-Language":{"description":"The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-Accept-Language"},"PSU-User-Agent":{"description":"The forwarded Agent header field of the HTTP request between PSU and TPP, if available.\n","required":false,"schema":{"type":"string"},"in":"header","name":"PSU-User-Agent"},"PSU-Http-Method":{"description":"HTTP method used at the PSU ? TPP interface, if available.\nValid values are:\n* GET\n* POST\n* PUT\n* PATCH\n* DELETE\n","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"in":"header","name":"PSU-Http-Method"},"PSU-Device-ID":{"description":"UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.\nUUID identifies either a device or a device dependant application installation.\nIn case of an installation identification this ID needs to be unaltered until removal from device.\n","required":false,"schema":{"format":"uuid","type":"string"},"in":"header","name":"PSU-Device-ID"},"PSU-Geo-Location":{"description":"The forwarded Geo Location of the corresponding http request between PSU and TPP if available.\n","required":false,"schema":{"pattern":"GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}","type":"string"},"in":"header","name":"PSU-Geo-Location"},"apiGroupVersion":{"description":"API Group Version string, consists of the major, minor and patch number. The highest minor and/or patch numbers are selected automatically if the short notation is used. The version is limited by the scopes defined in the Client Application.","required":true,"schema":{"type":"string","enum":["v1","v1.3","v1.3.1"]},"in":"path","name":"apiGroupVersion"},"providerId":{"description":"ID of an API Provider, which the operation shall be handled by.","required":true,"schema":{"description":"ID of an API Provider, which the operation shall be handled by.","type":"string"},"in":"path","name":"provider-id"}},"schemas":{"consentId":{"description":"ID of the corresponding consent object as returned by an account information consent request.\n","type":"string"},"authorisationId":{"description":"Resource identification of the related SCA.","type":"string"},"updateConsentPsuDataRequest":{"oneOf":[{},{"$ref":"#/components/schemas/updatePsuAuthentication"},{"$ref":"#/components/schemas/selectPsuAuthenticationMethod"},{"$ref":"#/components/schemas/transactionAuthorisation"},{"$ref":"#/components/schemas/authorisationConfirmation"}]},"updatePsuAuthentication":{"description":"Content of the body of a Update PSU authentication request\n\nPassword subfield is used.\n","properties":{"psuData":{"$ref":"#/components/schemas/psuData"}},"type":"object","required":["psuData"]},"psuData":{"description":"PSU Data for Update PSU authentication.","minProperties":1,"properties":{"password":{"description":"Password.","type":"string"},"encryptedPassword":{"description":"Encrypted password.","type":"string"},"additionalPassword":{"description":"Additional password in plaintext.","type":"string"},"additionalEncryptedPassword":{"description":"Additional encrypted password.","type":"string"}},"type":"object"},"selectPsuAuthenticationMethod":{"description":"Content of the body of a Select PSU authentication method request\n","properties":{"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"}},"type":"object","required":["authenticationMethodId"]},"authenticationMethodId":{"description":"An identification provided by the ASPSP for the later identification of the authentication method selection.\n","maxLength":35,"type":"string"},"transactionAuthorisation":{"description":"Content of the body of a transaction authorisation request\n","properties":{"scaAuthenticationData":{"$ref":"#/components/schemas/scaAuthenticationData"}},"type":"object","required":["scaAuthenticationData"]},"scaAuthenticationData":{"description":"SCA authentication data, depending on the chosen authentication method. \nIf the data is binary, then it is base64 encoded.\n","type":"string"},"authorisationConfirmation":{"description":"Content of the body of an authorisation confirmation request\n","properties":{"confirmationCode":{"description":"Confirmation Code as retrieved by the TPP from the redirect based SCA process.","type":"string"}},"type":"object","required":["confirmationCode"]},"updatePsuIdentificationResponse":{"description":"Body of the JSON response for a successful update PSU identification request.","properties":{"transactionFees":{"$ref":"#/components/schemas/amount"},"currencyConversionFees":{"$ref":"#/components/schemas/amount"},"estimatedTotalAmount":{"$ref":"#/components/schemas/amount"},"estimatedInterbankSettlementAmount":{"$ref":"#/components/schemas/amount"},"scaMethods":{"$ref":"#/components/schemas/scaMethods"},"_links":{"$ref":"#/components/schemas/_linksUpdatePsuIdentification"},"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["_links","scaStatus"]},"amount":{"properties":{"currency":{"$ref":"#/components/schemas/currencyCode"},"amount":{"$ref":"#/components/schemas/amountValue"}},"type":"object","required":["currency","amount"]},"currencyCode":{"description":"ISO 4217 Alpha 3 currency code.\n","pattern":"[A-Z]{3}","type":"string"},"amountValue":{"description":"The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n  * 1056\n  * 5768.2\n  * -1.50\n  * 5877.78\n","pattern":"-?[0-9]{1,14}(\\.[0-9]{1,3})?","type":"string"},"scaMethods":{"description":"This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.\n","type":"array","items":{"$ref":"#/components/schemas/authenticationObject"}},"authenticationObject":{"description":"Authentication object.\n","properties":{"authenticationType":{"$ref":"#/components/schemas/authenticationType"},"authenticationVersion":{"description":"Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.\n","type":"string"},"authenticationMethodId":{"$ref":"#/components/schemas/authenticationMethodId"},"name":{"description":"This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n","type":"string"},"explanation":{"description":"Detailed information about the SCA method for the PSU.\n","type":"string"}},"type":"object","required":["authenticationType","authenticationMethodId"]},"authenticationType":{"description":"Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n  - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n  - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. \n    To contact the card, the PSU normally needs a (handheld) device. \n    With this device, the PSU either reads the challenging data through a visual interface like flickering or \n    the PSU types in the challenge through the device key pad. \n    The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n  - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data \n    which can be read in by a consumer device or specific mobile app. \n    The device resp. the specific app than derives an OTP from the visual challenge data and displays \n    the OTP to the PSU.\n  - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.\n  - 'SMTP_OTP': An OTP is sent via email to the PSU.\n","type":"string","enum":["SMS_OTP","CHIP_OTP","PHOTO_OTP","PUSH_OTP","SMTP_OTP"]},"_linksUpdatePsuIdentification":{"description":"A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.\n\n**Remark:** All links can be relative or full links, to be decided by the ASPSP.\n\nType of links admitted in this response, (further links might be added for ASPSP \ndefined extensions):\n\n- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.\n- 'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there are several available authentication methods and if the PSU is already sufficiently authenticated.. If this link is contained, then there is also the data element \"scaMethods\" contained in the response body.\n","properties":{"scaStatus":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"hrefEntry":{"description":"Link to a resource.","type":"string"},"scaStatus":{"description":"This data element is containing information about the status of the SCA method applied. \n\nThe following codes are defined for this data type.\n\n  * 'received':\n    An authorisation or cancellation-authorisation resource has been created successfully.\n  * 'psuIdentified':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n  * 'psuAuthenticated':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n  * 'scaMethodSelected':\n    The PSU/TPP has selected the related SCA routine. \n    If the SCA method is chosen implicitly since only one SCA method is available, \n    then this is the first status to be reported instead of 'received'.\n  * 'unconfirmed':\n    SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. \n  * 'started':\n    The addressed SCA routine has been started.\n  * 'finalised':\n    The SCA routine has been finalised successfully (including a potential confirmation command). \n    This is a final status of the authorisation resource.\n  * 'failed':\n    The SCA routine failed.\n    This is a final status of the authorisation resource.\n  * 'exempted':\n    SCA was exempted for the related transaction, the related authorisation is successful.\n    This is a final status of the authorisation resource.\n","type":"string","enum":["received","psuIdentified","psuAuthenticated","scaMethodSelected","started","unconfirmed","finalised","failed","exempted"]},"psuMessageText":{"description":"Text to be displayed to the PSU.","maxLength":500,"type":"string"},"updatePsuAuthenticationResponse":{"description":"Body of the JSON response for a successful update PSU authentication request.","properties":{"transactionFees":{"$ref":"#/components/schemas/amount"},"currencyConversionFees":{"$ref":"#/components/schemas/amount"},"estimatedTotalAmount":{"$ref":"#/components/schemas/amount"},"estimatedInterbankSettlementAmount":{"$ref":"#/components/schemas/amount"},"chosenScaMethod":{"$ref":"#/components/schemas/chosenScaMethod"},"challengeData":{"$ref":"#/components/schemas/challengeData"},"scaMethods":{"$ref":"#/components/schemas/scaMethods"},"_links":{"$ref":"#/components/schemas/_linksUpdatePsuAuthentication"},"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"},"authorisationId":{"$ref":"#/components/schemas/authorisationId"}},"type":"object","required":["scaStatus"]},"chosenScaMethod":{"$ref":"#/components/schemas/authenticationObject"},"challengeData":{"description":"It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.\nIn rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.\n","properties":{"image":{"description":"PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.\n","type":"string"},"data":{"description":"A collection of strings as challenge data.","type":"array","items":{"type":"string"}},"imageLink":{"description":"A link where the ASPSP will provides the challenge image for the TPP.","format":"url","type":"string"},"otpMaxLength":{"description":"The maximal length for the OTP to be typed in by the PSU.","type":"integer"},"otpFormat":{"description":"The format type of the OTP to be typed in. The admitted values are \"characters\" or \"integer\".","type":"string","enum":["characters","integer"]},"additionalInformation":{"description":"Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.\n","type":"string"}},"type":"object"},"_linksUpdatePsuAuthentication":{"description":"A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods \nare available for the PSU.\nType of links admitted in this response:\n  * 'updateAdditionalPsuAuthentication':\n    The link to the payment initiation or account information resource, \n    which needs to be updated by an additional PSU password. \n    This link is only contained in rare cases, \n    where such additional passwords are needed for PSU authentications.\n  * 'updateAdditionalEncryptedPsuAuthentication': \n    The link to the payment initiation or account information resource, \n    which needs to be updated by an additional encrypted PSU password. \n    This link is only contained in rare cases, where such additional passwords are needed for PSU authentications.\n  * 'selectAuthenticationMethod': \n    This is a link to a resource, where the TPP can select the applicable second factor authentication \n    methods for the PSU, if there were several available authentication methods. \n    This link is only contained, if the PSU is already identified or authenticated with the first relevant \n    factor or alternatively an access token, if SCA is required and if the PSU has a choice between different \n    authentication methods. \n    If this link is contained, then there is also the data element 'scaMethods' contained in the response body.\n  * 'authoriseTransaction': \n    The link to the resource, where the \"Transaction authorisation request\" is sent to. \n    This is the link to the resource which will authorise the transaction by checking the SCA authentication \n    data within the Embedded SCA approach.\n  * 'scaStatus': \n    The link to retrieve the scaStatus of the corresponding authorisation sub-resource.\n","properties":{"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"selectPsuAuthenticationMethodResponse":{"description":"Body of the JSON response for a successful select PSU authentication method request.","properties":{"transactionFees":{"$ref":"#/components/schemas/amount"},"currencyConversionFees":{"$ref":"#/components/schemas/amount"},"estimatedTotalAmount":{"$ref":"#/components/schemas/amount"},"estimatedInterbankSettlementAmount":{"$ref":"#/components/schemas/amount"},"chosenScaMethod":{"$ref":"#/components/schemas/chosenScaMethod"},"challengeData":{"$ref":"#/components/schemas/challengeData"},"_links":{"$ref":"#/components/schemas/_linksSelectPsuAuthenticationMethod"},"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["scaStatus"]},"_linksSelectPsuAuthenticationMethod":{"description":"A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in \nthe response depend on the dynamical decisions of the ASPSP when processing the request.\n\n**Remark:** All links can be relative or full links, to be decided by the ASPSP. \n\n**Remark:** This method can be applied before or after PSU identification. \nThis leads to many possible hyperlink responses.\nType of links admitted in this response, (further links might be added for ASPSP defined \nextensions):\n\n- 'scaRedirect': \n  In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to \n  redirect the PSU browser.\n- 'scaOAuth': \n  In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the \n  configuration of the Authorisation Server can be retrieved. \n  The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.\n* 'confirmation': \n  Might be added by the ASPSP if either the \"scaRedirect\" or \"scaOAuth\" hyperlink is returned \n  in the same response message. \n  This hyperlink defines the URL to the resource which needs to be updated with \n    * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or\n    * an access token as retrieved by submitting an authorization code after the integrated OAuth based authentication process with the ASPSP authentication server.\n- 'updatePsuIdentification': \n  The link to the authorisation or cancellation authorisation sub-resource, \n  where PSU identification data needs to be uploaded.\n- 'updatePsuAuthentication':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where PSU authentication data needs to be uploaded.\n  - 'updateEncryptedPsuAuthentication':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where PSU authentication encrypted data needs to be uploaded.\n- 'updateAdditionalPsuAuthentication':\n    The link to the payment initiation or account information resource, \n    which needs to be updated by an additional PSU password. \n- 'updateAdditionalEncryptedPsuAuthentication': \n    The link to the payment initiation or account information resource, \n    which needs to be updated by an additional encrypted PSU password. \n- 'authoriseTransaction':\n  The link to the authorisation or cancellation authorisation sub-resource, \n  where the authorisation data has to be uploaded, e.g. the TOP received by SMS. \n- 'scaStatus': \n  The link to retrieve the scaStatus of the corresponding authorisation sub-resource.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"scaStatusResponse":{"description":"Body of the JSON response with SCA Status.","properties":{"scaStatus":{"$ref":"#/components/schemas/scaStatus"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"},"psuName":{"description":"Name of the PSU. In case of a corporate account, this might be the person acting on behalf of the corporate.\n","maxLength":140,"type":"string"},"trustedBeneficiaryFlag":{"$ref":"#/components/schemas/trustedBeneficiaryFlag"},"_links":{"$ref":"#/components/schemas/_linksAll"},"tppMessage":{"description":"Messages to the TPP on operational issues.","type":"array","items":{"$ref":"#/components/schemas/tppMessageGeneric"}}},"type":"object","required":["scaStatus"]},"trustedBeneficiaryFlag":{"description":"Additional Service: Trusted Beneficiaries\nWithin this data element, the ASPSP might optionally communicate towards the TPP whether the creditor was part of the related trusted beneficiary list. \nThis attribute is only contained in case of a final scaStatus.\n","type":"boolean"},"_linksAll":{"description":"A _link object with all available link types.\n","properties":{"scaRedirect":{"$ref":"#/components/schemas/hrefType"},"scaOAuth":{"$ref":"#/components/schemas/hrefType"},"confirmation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisation":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuIdentification":{"$ref":"#/components/schemas/hrefType"},"updatePsuIdentification":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithProprietaryData":{"$ref":"#/components/schemas/hrefType"},"updateProprietaryData":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updatePsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"updateAdditionalEncryptedPsuAuthentication":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithAuthenticationMethodSelection":{"$ref":"#/components/schemas/hrefType"},"selectAuthenticationMethod":{"$ref":"#/components/schemas/hrefType"},"startAuthorisationWithTransactionAuthorisation":{"$ref":"#/components/schemas/hrefType"},"authoriseTransaction":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"cardAccount":{"$ref":"#/components/schemas/hrefType"},"cardTransactions":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"tppMessageGeneric":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/tppMessageCodeGeneric"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"tppMessageCategory":{"description":"Category of the TPP message category.","type":"string","enum":["ERROR","WARNING"]},"tppMessageCodeGeneric":{"description":"Code of the TPP message category.","type":"string"},"tppMessageText":{"description":"Additional explaining text to the TPP.","maxLength":500,"type":"string"},"authorisationConfirmationResponse":{"description":"Body of the JSON response for an authorisation confirmation request.","properties":{"scaStatus":{"$ref":"#/components/schemas/scaStatusAuthorisationConfirmation"},"_links":{"$ref":"#/components/schemas/_linksAuthorisationConfirmation"},"psuMessage":{"$ref":"#/components/schemas/psuMessageText"}},"type":"object","required":["scaStatus","_links"]},"scaStatusAuthorisationConfirmation":{"description":"This data element is containing information about the status of the SCA method in an authorisation confirmation response. \n\nThe following codes are defined for this data type.\n\n  * 'finalised': if the transaction authorisation and confirmation was successful.\n  * 'failed': if the transaction authorisation or confirmation was not successful.\n","type":"string","enum":["finalised","failed"]},"_linksAuthorisationConfirmation":{"description":"A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.\n\n**Remark:** All links can be relative or full links, to be decided by the ASPSP.\n\nType of links admitted in this response, (further links might be added for ASPSP \ndefined extensions):\n\n- 'scaStatus': The link to retrieve the status of the corresponding transaction resource.\n","properties":{"scaStatus":{"$ref":"#/components/schemas/hrefType"}},"type":"object","additionalProperties":{"$ref":"#/components/schemas/hrefType"}},"Error400_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage400_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage400_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode400_AIS":{"description":"Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"Error400_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 400 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"tppErrorTitle":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"Error401_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage401_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage401_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode401_AIS":{"description":"Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","CORPORATE_ID_INVALID","PSU_CREDENTIALS_INVALID","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error401_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 401 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error403_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage403_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage403_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode403_AIS":{"description":"Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"Error403_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 403 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error404_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage404_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage404_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode404_AIS":{"description":"Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 404 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error405_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage405_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage405_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode405_AIS":{"description":"Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 405 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error406_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage406_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage406_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode406_AIS":{"description":"Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).","type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"Error406_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 406 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode406_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error409_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage409_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage409_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode409_AIS":{"description":"Message codes defined for AIS for HTTP Error code 409 (CONFLICT).","type":"string","enum":["STATUS_INVALID"]},"Error409_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 409 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode409_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]},"Error429_NG_AIS":{"description":"NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.\n","properties":{"tppMessages":{"type":"array","items":{"$ref":"#/components/schemas/tppMessage429_AIS"}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object"},"tppMessage429_AIS":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object","required":["category","code"]},"MessageCode429_AIS":{"description":"Message codes for HTTP Error code 429 (TOO MANY REQUESTS).","type":"string","enum":["ACCESS_EXCEEDED"]},"Error429_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807] \nin case of a HTTP error code 429 for AIS.\n","properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"},"title":{"description":"Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"detail":{"description":"Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.\n","maxLength":500,"type":"string"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807] \nin case of a HTTP error code 429 for.\n","properties":{"title":{"$ref":"#/components/schemas/tppErrorTitle"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"code":{"$ref":"#/components/schemas/MessageCode429_AIS"}},"type":"object","required":["code"]}},"_links":{"$ref":"#/components/schemas/_linksAll"}},"type":"object","required":["type","code"]}},"responses":{"OK_200_UpdatePsuData":{"description":"OK","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"ASPSP-SCA-Approach":{"$ref":"#/components/headers/ASPSP-SCA-Approach"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/updatePsuIdentificationResponse"},{"$ref":"#/components/schemas/updatePsuAuthenticationResponse"},{"$ref":"#/components/schemas/selectPsuAuthenticationMethodResponse"},{"$ref":"#/components/schemas/scaStatusResponse"},{"$ref":"#/components/schemas/authorisationConfirmationResponse"}]}}}},"REQUEST_TIMEOUT_408_AIS":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"CONFLICT_409_AIS":{"description":"Conflict","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error409_NG_AIS"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error409_AIS"}}}},"INTERNAL_SERVER_ERROR_500_AIS":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503_AIS":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"format":"uuid","type":"string"}},"ASPSP-SCA-Approach":{"description":"This data element must be contained, if the SCA Approach is already fixed.\nPossible values are\n  * EMBEDDED\n  * DECOUPLED\n  * REDIRECT\nThe OAuth SCA approach will be subsumed by REDIRECT.\n","required":false,"schema":{"type":"string","enum":["EMBEDDED","DECOUPLED","REDIRECT"]}},"Location":{"description":"Location of the created resource.\n","required":false,"schema":{"format":"url","type":"string"}}}},"paths":{"/providers/{provider-id}/aggregated-xs2a/{apiGroupVersion}/consents/{consentId}/authorisations/{authorisationId}":{"put":{"tags":["consents"],"summary":"Update PSU Data for consents","description":"This method update PSU data on the consents  resource if needed. \nIt may authorise a consent within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible update PSU data requests in the context of a consent request if needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\n  A specific Update PSU data request is applicable for \n    * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\n  A specific update PSU data request is only applicable for\n  * adding the PSU Identification, if not provided yet in the payment initiation request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n  * the selection of authentication methods.\n* Embedded SCA Approach: \n  The Update PSU data request might be used \n  * to add credentials as a first factor authentication data of the PSU and\n  * to select the authentication method and\n  * transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible update PSU data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n  * Update PSU identification\n  * Update PSU authentication\n  * Select PSU authorization method \n    WARNING: This method needs a reduced header, \n    therefore many optional elements are not present. \n    Maybe in a later version the access path will change.\n  * Transaction Authorisation\n    WARNING: This method needs a reduced header, \n    therefore many optional elements are not present. \n    Maybe in a later version the access path will change.\n","operationId":"updateConsentsPsuData","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$ref":"#/components/parameters/authorisationId"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Session-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/PSU-ID"},{"$ref":"#/components/parameters/PSU-ID-Type"},{"$ref":"#/components/parameters/PSU-Corporate-ID"},{"$ref":"#/components/parameters/PSU-Corporate-ID-Type"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$ref":"#/components/parameters/PSU-IP-Port"},{"$ref":"#/components/parameters/PSU-Accept"},{"$ref":"#/components/parameters/PSU-Accept-Charset"},{"$ref":"#/components/parameters/PSU-Accept-Encoding"},{"$ref":"#/components/parameters/PSU-Accept-Language"},{"$ref":"#/components/parameters/PSU-User-Agent"},{"$ref":"#/components/parameters/PSU-Http-Method"},{"$ref":"#/components/parameters/PSU-Device-ID"},{"$ref":"#/components/parameters/PSU-Geo-Location"},{"$ref":"#/components/parameters/apiGroupVersion"},{"$ref":"#/components/parameters/providerId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateConsentPsuDataRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/OK_200_UpdatePsuData"},"400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error400_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED"]},"text":{"type":"string"},"invalidParams":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400_AIS"}}}},"401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error401_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["TOKEN_INVALID","TOKEN_EXPIRED","TOKEN_UNKNOWN","AUTHENTICATION_MISSING","CERTIFICATE_INVALID","CERTIFICATE_REVOKED","CERTIFICATE_EXPIRED","SIGNATURE_MISSING","SIGNATURE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401_AIS"}}}},"403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403_AIS"}}}},"404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error404_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["RESOURCE_UNKNOWN"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404_AIS"}}}},"405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error405_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405_AIS"}}}},"406":{"description":"Not Acceptable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error406_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["REQUESTED_FORMATS_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error406_AIS"}}}},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["SERVICE_INVALID"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"429":{"description":"Too Many Requests","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error429_NG_AIS"},{"properties":{"apiClientMessages":{"type":"array","items":{"properties":{"category":{"type":"string","enum":["ERROR"]},"code":{"type":"string","enum":["OPERATION_NOT_ALLOWED"]},"text":{"type":"string"}},"type":"object"}}},"type":"object"}]}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error429_AIS"}}}},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.api.tieto.com/api-references/tieto-saas-aggregation/aggregated-xs2a/consents.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.