Skip to main content

Get consent.

GET 

/api/v1/consents/:consentId

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.

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.GetConsent.GetConsentRequestHeaders.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

    access

    object

    required

    Requested access services for a consent.

    accounts

    object[]

    nullable

    Is asking for detailed account information.

    If the array is empty in a request, the TPP is asking for an accessible account list.

    This may be restricted in a PSU/ASPSP authorization dialogue.

    If the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.

  • Array [

  • iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullable

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullable

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullable

    Possible values: <= 35 characters

    Mobile phone number.

    other

    object

    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.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringnullable

    Possible values: <= 35 characters

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullable

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullable

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    ExternalCashAccountType1Code from ISO 20022.

  • ]

  • balances

    object[]

    nullable

    Is asking for balances of the addressed accounts.

    If the array is empty in the request, the TPP is asking for the balances of all accessible account lists.

    This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts,

    additionalInformation sub attributes or transactions shall be empty, if used.

  • Array [

  • iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullable

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullable

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullable

    Possible values: <= 35 characters

    Mobile phone number.

    other

    object

    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.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringnullable

    Possible values: <= 35 characters

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullable

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullable

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    ExternalCashAccountType1Code from ISO 20022.

  • ]

  • transactions

    object[]

    nullable

    Is asking for transactions of the addressed accounts.

    If the array is empty in the request, the TPP is asking for the balances of all accessible account lists.

    This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts,

    additionalInformation sub attributes or transactions shall be empty, if used.

  • Array [

  • iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullable

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullable

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullable

    Possible values: <= 35 characters

    Mobile phone number.

    other

    object

    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.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringnullable

    Possible values: <= 35 characters

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullable

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullable

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    ExternalCashAccountType1Code from ISO 20022.

  • ]

  • additionalInformation

    object

    Optional if supported by API provider.

    Is asking for additional information as added within this structured object.

    The usage of this data element requires at least one of the entries "accounts", "transactions" or "balances" also to be contained in the object.

    If detailed accounts are referenced, it is required in addition that any account addressed within the additionalInformation attribute

    is also addressed by at least one of the attributes "accounts", "transactions" or "balances".

    ownerName

    object[]

    nullable

    Is asking for account owner name of the accounts referenced within.

    If the array is empty in the request, the TPP is asking for the account owner name of all accessible accounts.

    This may be restricted in a PSU/ASPSP authorization dialogue.

    If the array is empty, also the arrays for accounts, balances or transactions shall be empty, if used.

    The ASPSP will indicate in the consent resource after a successful authorisation,

    whether the ownerName consent can be accepted by providing the accounts on which the ownerName will be delivered. This array can be empty.

  • Array [

  • iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullable

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullable

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullable

    Possible values: <= 35 characters

    Mobile phone number.

    other

    object

    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.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringnullable

    Possible values: <= 35 characters

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullable

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullable

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    ExternalCashAccountType1Code from ISO 20022.

  • ]

  • trustedBeneficiaries

    object[]

    nullable

    Optional if supported by API provider.

    Is asking for the trusted beneficiaries related to the accounts referenced within and related to the PSU.

    If the array is empty in the request, the TPP is asking for the lists of trusted beneficiaries of all accessible accounts.

    This may be restricted in a PSU/ASPSP authorization dialogue by the PSU if also the account lists addressed by the tags “accounts”, “balances” or “transactions” are empty.

    The ASPSP will indicate in the consent resource after a successful authorisation,

    whether the trustedBeneficiaries consent can be accepted by providing the accounts on which the list of trusted beneficiaries will be delivered.

    This array can be empty.

  • Array [

  • iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullable

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullable

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullable

    Possible values: <= 35 characters

    Mobile phone number.

    other

    object

    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.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringnullable

    Possible values: <= 35 characters

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullable

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullable

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullable

    Possible values: Value must match regular expression [A-Z]{3}

    ExternalCashAccountType1Code from ISO 20022.

  • ]

  • availableAccounts AvailableAccounts (string)

    Possible values: [allAccounts, allAccountsWithOwnerName]

    availableAccountsWithBalance AvailableAccounts (string)

    Possible values: [allAccounts, allAccountsWithOwnerName]

    allPsd2 AvailableAccounts (string)

    Possible values: [allAccounts, allAccountsWithOwnerName]

    restrictedTo AvailableAccounts (string)

    Possible values: [allAccounts, allAccountsWithOwnerName]

    recurringIndicator booleanrequired

    "true", if the consent is for recurring access to the account data.

    "false", if the consent is for one access to the account data.

    validUntil daterequired

    This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISO-Date format, e.g. 2017-10-30.

    Future dates might get adjusted by ASPSP.

    If a maximal available date is requested, a date in far future is to be used: "9999-12-31".

    In both cases the consent object to be retrieved by the get consent request will contain the adjusted date.

    frequencyPerDay int32required

    Possible values: >= 1 and <= 2147483647

    This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1".

    The frequency needs to be greater equal to one.

    If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.

    lastActionDate daterequired

    This date is containing the date of the last action on the consent object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.

    consentStatus ConsentStatus (string)required

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

    This is the overall lifecycle status of the consent.

    _links

    object

    A list of hyperlinks to be recognised by the TPP.

    Links of type "account" and/or "cardAccount", depending on the nature of the consent.

    account

    object

    Link to a resource.

    href stringnullable

    href Entry.

    card-account

    object

    Link to a resource.

    href stringnullable

    href Entry.

Loading...