Get consent request

{
  "type": "object",
  "description": "Body of the JSON response for a successfull get consent request.",
  "required": [
    "access",
    "consentStatus",
    "frequencyPerDay",
    "lastActionDate",
    "recurringIndicator",
    "validUntil"
  ],
  "properties": {
    "_links": {
      "type": "object",
      "description": "A list of hyperlinks to be recognised by the TPP.\n\nLinks of type \"account\" and/or \"cardAccount\", depending on the nature of the consent.\n",
      "properties": {
        "account": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "card-account": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        }
      }
    },
    "access": {
      "type": "object",
      "description": "Requested access services for a consent.\n",
      "properties": {
        "accounts": {
          "type": "array",
          "description": "Is asking for detailed account information. \n\nIf the array is empty in a request, the TPP is asking for an accessible account list. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.\n",
          "items": {
            "type": "object",
            "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
            "properties": {
              "cashAccountType": {
                "type": "string",
                "description": "ExternalCashAccountType1Code from ISO 20022.\n"
              },
              "currency": {
                "type": "string",
                "description": "ISO 4217 Alpha 3 currency code.\n"
              },
              "iban": {
                "type": "string",
                "description": "IBAN of an account."
              },
              "otherAccountIdentification": {
                "type": "string",
                "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
              }
            }
          }
        },
        "additionalInformation": {
          "type": "object",
          "description": "Optional if supported by API provider.\n\nIs asking for additional information as added within this structured object.\nThe usage of this data element requires at least one of the entries \"accounts\", \n\"transactions\" or \"balances\" also to be contained in the object. \nIf detailed accounts are referenced, it is required in addition that any account addressed within \nthe additionalInformation attribute is also addressed by at least one of the attributes \"accounts\", \n\"transactions\" or \"balances\".\n",
          "properties": {
            "ownerName": {
              "type": "array",
              "description": "Is asking for account owner name of the accounts referenced within. \nIf the array is empty in the request, the TPP is asking for the account \nowner name of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, balances or transactions shall be empty, if used.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the ownerName consent can be accepted by providing the accounts on which the ownerName will \nbe delivered. \nThis array can be empty.\n",
              "items": {
                "type": "object",
                "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
                "properties": {
                  "cashAccountType": {
                    "type": "string",
                    "description": "ExternalCashAccountType1Code from ISO 20022.\n"
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217 Alpha 3 currency code.\n"
                  },
                  "iban": {
                    "type": "string",
                    "description": "IBAN of an account."
                  },
                  "otherAccountIdentification": {
                    "type": "string",
                    "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
                  }
                }
              }
            },
            "trustedBeneficiaries": {
              "type": "array",
              "description": "Optional if supported by API provider.\nIs asking for the trusted beneficiaries related to the accounts referenced within and related to the PSU.\nIf the array is empty in the request, the TPP is asking for the lists of trusted beneficiaries of all accessible accounts. \nThis may be restricted in a PSU/ASPSP authorization dialogue by the PSU if also the account lists addressed \nby the tags “accounts”, “balances” or “transactions” are empty.\nThe ASPSP will indicate in the consent resource after a successful authorisation, \nwhether the trustedBeneficiaries consent can be accepted by providing the accounts on which the list of trusted beneficiaries will be delivered. \nThis array can be empty.\n",
              "items": {
                "type": "object",
                "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
                "properties": {
                  "cashAccountType": {
                    "type": "string",
                    "description": "ExternalCashAccountType1Code from ISO 20022.\n"
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217 Alpha 3 currency code.\n"
                  },
                  "iban": {
                    "type": "string",
                    "description": "IBAN of an account."
                  },
                  "otherAccountIdentification": {
                    "type": "string",
                    "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
                  }
                }
              }
            }
          }
        },
        "allPsd2": {
          "type": "string",
          "description": "Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n",
          "enum": [
            "allAccounts",
            "allAccountsWithOwnerName"
          ]
        },
        "availableAccounts": {
          "type": "string",
          "description": "Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n",
          "enum": [
            "allAccounts",
            "allAccountsWithOwnerName"
          ]
        },
        "availableAccountsWithBalance": {
          "type": "string",
          "description": "Optional if supported by API provider.\n\nThe values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. \nThe support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.\n",
          "enum": [
            "allAccounts",
            "allAccountsWithOwnerName"
          ]
        },
        "balances": {
          "type": "array",
          "description": "Is asking for balances of the addressed accounts.\n\nIf the array is empty in the request, the TPP is asking for the balances of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.\n",
          "items": {
            "type": "object",
            "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
            "properties": {
              "cashAccountType": {
                "type": "string",
                "description": "ExternalCashAccountType1Code from ISO 20022.\n"
              },
              "currency": {
                "type": "string",
                "description": "ISO 4217 Alpha 3 currency code.\n"
              },
              "iban": {
                "type": "string",
                "description": "IBAN of an account."
              },
              "otherAccountIdentification": {
                "type": "string",
                "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
              }
            }
          }
        },
        "restrictedTo": {
          "type": "array",
          "description": "If the TPP requests access to accounts via availableAccounts (List of available accounts), global \nor bank driven consents, the TPP may include this element to restrict access to the referred \naccount types. Absence of the element is interpreted as \"no restriction\" (therefore access to \naccounts of all types is requested). The element may only occur, if each of the elements \n  - accounts \n  - balances \n  - transactions \nis either not present or contains an empty array. \n",
          "items": {
            "type": "string",
            "description": "ExternalCashAccountType1Code from ISO 20022.\n"
          }
        },
        "transactions": {
          "type": "array",
          "description": "Is asking for transactions of the addressed accounts. \n\nIf the array is empty in the request, the TPP is asking for the transactions of all accessible account lists. \nThis may be restricted in a PSU/ASPSP authorization dialogue. \nIf the array is empty, also the arrays for accounts, additionalInformation sub attributes or balances shall be empty, if used.\n",
          "items": {
            "type": "object",
            "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
            "properties": {
              "cashAccountType": {
                "type": "string",
                "description": "ExternalCashAccountType1Code from ISO 20022.\n"
              },
              "currency": {
                "type": "string",
                "description": "ISO 4217 Alpha 3 currency code.\n"
              },
              "iban": {
                "type": "string",
                "description": "IBAN of an account."
              },
              "otherAccountIdentification": {
                "type": "string",
                "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
              }
            }
          }
        }
      }
    },
    "consentStatus": {
      "type": "string",
      "description": "This is the overall lifecycle status of the consent.\n\nValid values are:\n  - 'received': The consent data have been received and are technically correct.\n    The data is not authorised yet.\n  - 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.\n  - 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.\n  - 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.\n  - 'expired': The consent expired.\n  - 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.\n  - 'partiallyAuthorised': The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.\n\nThe ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface \nand has to be added to this API definition as well.\n",
      "enum": [
        "received",
        "rejected",
        "valid",
        "revokedByPsu",
        "expired",
        "terminatedByTpp",
        "partiallyAuthorised"
      ]
    },
    "frequencyPerDay": {
      "type": "integer",
      "description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one.\n\nIf not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.\n"
    },
    "lastActionDate": {
      "type": "string",
      "format": "date",
      "description": "This date is containing the date of the last action on the consent object either through\nthe XS2A interface or the PSU/ASPSP interface having an impact on the status.\n"
    },
    "recurringIndicator": {
      "type": "boolean",
      "description": "\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.\n"
    },
    "validUntil": {
      "type": "string",
      "format": "date",
      "description": "This parameter is defining a valid until date (including the mentioned date) for the requested consent. \nThe content is the local ASPSP date in ISO-Date format, e.g. 2017-10-30.\n\nFuture dates might get adjusted by ASPSP. \n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\". \n\nIn both cases the consent object to be retrieved by the get consent request will contain the adjusted date.\n"
    }
  }
}