Sign in
Account Information Service (AIS)

Consent status request

Read the status of an account information consent resource.

get/v1/consents/{consentId}/status

Path parameters

consentIdstring required

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

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

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

OK

consentStatus'received' | 'rejected' | 'valid' | 'revokedByPsu' | 'expired' | 'terminatedByTpp' | 'partiallyAuthorised' required

This is the overall lifecycle status of the consent.

Valid values are:

  • 'received': The consent data have been received and are technically correct. The data is not authorised yet.
  • 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.
  • 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.
  • 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.
  • 'expired': The consent expired.
  • 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.
  • 'partiallyAuthorised': The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.

The ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface and has to be added to this API definition as well.

psuMessagestring

Text to be displayed to the PSU.

Changes

Changed in 6 of the 50 revisions of this API.312550

  • 41f56d33cdbf1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 08bfa92654931See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • 0d82c46995484426See the full diff
    • ▲

      added the new path request parameter account-id

      new-request-path-parameter

    • ▲

      added the new required header request parameter Consent-ID

      new-required-request-parameter

    • ▲

      added the new required query request parameter bookingStatus

      new-required-request-parameter

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      deleted the path request parameter consentId

      request-parameter-removed

    • ●

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)

      response-property-enum-value-added

    • ●

      added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)

      response-property-enum-value-added

    • ●

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)

      response-property-enum-value-added

    • ○

      added the new optional query request parameter dateFrom

      new-optional-request-parameter

    • ○

      added the new optional query request parameter dateTo

      new-optional-request-parameter

    • ○

      added the new optional query request parameter deltaList

      new-optional-request-parameter

    • ○

      added the new optional query request parameter entryReferenceFrom

      new-optional-request-parameter

    • ○

      added the new optional query request parameter withBalance

      new-optional-request-parameter

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b51fe6ddb1fc24176See the full diff
    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

      response-property-max-length-increased

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/json)

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status (media type: application/problem+json)

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      for the header request parameter PSU-Device-ID, the format was generalized from uuid to no format

      request-parameter-type-generalized

    • ○

      for the header request parameter X-Request-ID, the format was generalized from uuid to no format

      request-parameter-type-generalized

    • ○

      removed the SCA_INVALID enum value from the // response property for the response status (media type: application/problem+json)

      response-property-enum-value-removed

    • ○

      removed the SCA_INVALID enum value from the response property for the response status (media type: application/problem+json)

      response-property-enum-value-removed

    • ○

      removed the SCA_INVALID enum value from the // response property for the response status (media type: application/json)

      response-property-enum-value-removed

    • ○

      removed the partiallyAuthorised enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3cc5b6a584f1417See the full diff
    • ●

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)

      response-property-enum-value-added

    • ●

      added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)

      response-property-enum-value-added

    • ●

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new partiallyAuthorised enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property / to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f324b23056bf2See the full diff
    • ▲

      for the header request parameter PSU-Device-ID, the format changed from no format to uuid

      request-parameter-type-changed

    • ▲

      for the header request parameter X-Request-ID, the format changed from no format to uuid

      request-parameter-type-changed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.