Account Information Service (AIS)

Common Services

Read the SCA status of the consent authorisation

Changed on Mar 9, 2021

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

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

Request

Base URL
https://api.dev.openbankingproject.ch
URL
https://api.dev.openbankingproject.ch/v1/consents/{consentId}/authorisations/{authorisationId}
Auth
- none
- or HTTP bearer

Path parameters

consentIdstring required

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

authorisationIdstring required

Resource identification of the related SCA.

Example:123auth456

Headers

X-Request-IDstring required

ID of the request, unique to the call, as determined by the initiating party.

Digeststring

Is contained if and only if the "Signature" element is contained in the header of the request.

Signaturestring

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificatestring byte

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Addressstring ipv4

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

PSU-IP-Portstring

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Acceptstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Charsetstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Encodingstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Languagestring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-User-Agentstring

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

GET
POST
PUT
PATCH
DELETE

PSU-Device-IDstring

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.

PSU-Geo-Locationstring

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Response

This data element is containing information about the status of the SCA method applied.

The following codes are defined for this data type.

'received': An authorisation or cancellation-authorisation resource has been created successfully.
'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified.
'psuAuthenticated': 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.
'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'.
'unconfirmed': SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.
'started': The addressed SCA routine has been started.
'finalised': The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource.
'failed': The SCA routine failed. This is a final status of the authorisation resource.
'exempted': SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource.

psuMessagestring

Text to be displayed to the PSU.

trustedBeneficiaryFlagboolean

Additional Service: Trusted Benificiaries Within this data element, the ASPSP might optionally communicate towards the TPP whether the creditor was part of the related trusted beneficiary list. This attribute is only contained in case of a final scaStatus.

Example response

{
  "scaStatus": "psuAuthenticated"
}

Changes

Mar 9, 20210d82c4699548 Revision changes
- warning
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)
- warning
  added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)
- warning
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)
- warning
  added the new unconfirmed enum value to the response property for the response status
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
Mar 9, 2021b51fe6ddb1fc Revision changes
- breaking
  the response property became optional for the status
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  for the header request parameter PSU-Device-ID, the format was generalized from uuid to no format
- info
  for the header request parameter X-Request-ID, the format was generalized from uuid to no format
- info
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/problem+json)
- info
  removed the SCA_INVALID enum value from the response property for the response status (media type: application/problem+json)
- info
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/json)
- info
  removed the unconfirmed enum value from the response property for the response status

Operation history (5 revisions)

Read the SCA status of the consent authorisation

Request

Path parameters

Headers

Response 200OK

Example response

Changes

Response