Skip to main content

Consent status.

GET 
/api/v1/consents/:consentId/status

Read the status of an account information consent resource.

Request​

Path Parameters

    consentId stringrequired

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

    Example: 3b304df3-b762-487a-936a-ff8685c9c8b6

Header Parameters

    X-Request-ID uuidrequired

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

    Example: c66d0ad3-4089-4996-bd48-523ae3e484f7
    Digest string

    Is contained if and only if the OpenBankingGateway.Models.AccountInformationService.GetConsentStatus.GetConsentStatusRequestHeaders.Signature element is contained in the header of the request.

    Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
    Signature string

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

    TPP-Signature-Certificate int32

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

    PSU-IP-Port string

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

    Example: 1234
    PSU-IP-Address stringrequired

    The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

    Example: 192.168.8.78
    PSU-Accept string

    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

    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

    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

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

    PSU-User-Agent string

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

    PSU-Http-Method PSUHttpMethod

    Possible values: [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-ID uuid

    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.

    Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
    PSU-Geo-Location string

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

    Example: GEO:52.506931;13.144558

Responses​

Created

Response Headers

  • X-Request-ID

    string

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

Schema

    consentStatus ConsentStatus (string)required

    Possible values: [received, rejected, valid, revokedByPsu, expired, terminatedByTpp, partiallyAuthorised]

    This is the overall lifecycle status of the consent.

    psuMessage stringnullable

    Possible values: <= 500 characters

    Text to be displayed to the PSU.

Loading...