GET v1/signing-baskets/{basketId}/status

openbankingproject.ch

Summary: Read the status of the signing basket
Operation ID: getSigningBasketStatus
Auth: unknown
Description

Returns the status of a signing basket object.

Parameters (19)

Digest (string, header, optional)

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

PSU-Accept (string, header, optional)

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

PSU-Accept-Charset (string, header, optional)

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

PSU-Accept-Encoding (string, header, optional)

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

PSU-Accept-Language (string, header, optional)

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

PSU-Corporate-ID (string, header, optional)

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type (string, header, optional)

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Device-ID (string, header, optional)

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-Location (string, header, optional)

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

Constraints: {'pattern': 'GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}'}

PSU-Http-Method (string, header, optional)

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

Constraints: {'enum': ['GET', 'POST', 'PUT', 'PATCH', 'DELETE']}

PSU-ID (string, header, optional)

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.

PSU-ID-Type (string, header, optional)

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.

PSU-IP-Address (string, header, optional)

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port (string, header, optional)

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

PSU-User-Agent (string, header, optional)

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

Signature (string, header, optional)

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

TPP-Signature-Certificate (string, header, optional)

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

X-Request-ID (string, header, required)

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

basketId (?, path, required)

This identification of the corresponding signing basket object.

No probe data for this endpoint yet.