Access

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/groupe-bpce/main/json-schema/groupe-bpce-access-schema.json",
  "title": "Access",
  "description": "Requested access services.",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/groupe-bpce-psd2-accounts-openapi.yml#/components/schemas/Access",
  "type": "object",
  "properties": {
    "owners": {
      "$ref": "#/$defs/AccessibleAccounts"
    },
    "balances": {
      "$ref": "#/$defs/AccessibleAccounts"
    },
    "transactions": {
      "$ref": "#/$defs/AccessibleAccounts"
    },
    "overdrafts": {
      "$ref": "#/$defs/AccessibleAccounts"
    },
    "trustedBeneficiaries": {
      "description": "Indicator that access to the trusted beneficiaries list was granted or not to the AISP by the PSU\n- true: the access was granted\n- false: the access was not granted\n",
      "type": "boolean"
    },
    "trustedWorkspaceBeneficiaries": {
      "description": "Indicator, for each given workspace, that access to the trusted beneficiaries list was granted or not to the AISP by the PSU \n",
      "type": "array",
      "items": {
        "$ref": "#/$defs/AccessibleTrustedBeneficiaries"
      }
    },
    "psuIdentity": {
      "description": "Indicator that access to the PSU identity, first name and last name, was granted or not to the AISP by the PSU\n- true: the access was granted\n- false: the access was not granted\n",
      "type": "boolean"
    }
  },
  "required": [
    "owners",
    "balances",
    "transactions",
    "psuIdentity"
  ],
  "$defs": {
    "AccessibleAccounts": {
      "description": "List of accessible accounts for one given functionality",
      "type": "array",
      "items": {
        "$ref": "#/$defs/AccountIdentification"
      }
    },
    "AccessibleTrustedBeneficiaries": {
      "description": "list of workspaces for which the PSU has given consent to the access by the AISP",
      "type": "object",
      "properties": {
        "workspace": {
          "description": "Identification of the workspace.\nIf not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.\n",
          "type": "string",
          "maxLength": 32
        },
        "access": {
          "description": "Indicator that access to the trusted beneficiaries list was granted or not to the AISP by the PSU for the default workspace\n- true: the access was granted\n- false: the access was not granted\n",
          "type": "boolean"
        }
      }
    },
    "AccountIdentification": {
      "description": "Unique and unambiguous identification for the account between the account owner and the account servicer.\nCard accounts must provide the identification of the card through the \"other\" substructure by giving, for instance, the masked PAN (MPAN).\nThe currency used for the account, when needed, can be specified through the [currency] field.\n",
      "type": "object",
      "properties": {
        "workspace": {
          "description": "Workspace to which the account is linked.\nThis workspace might be specified by the AISP when forwarding the consent on accounts.\nIf not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.\n",
          "type": "string",
          "maxLength": 32
        },
        "iban": {
          "description": "ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.\n\nFurther specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n",
          "type": "string",
          "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$"
        },
        "other": {
          "$ref": "#/$defs/GenericIdentification"
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        }
      }
    },
    "CurrencyCode": {
      "description": "Specifies the currency of the amount or of the account.\nA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n",
      "type": "string",
      "pattern": "^[A-Z]{3,3}$"
    },
    "GenericIdentification": {
      "description": "ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.\nAPI: The ASPSP will document which account reference type it will support.\n",
      "type": "object",
      "properties": {
        "identification": {
          "description": "API: Identifier\n",
          "type": "string",
          "maxLength": 70
        },
        "schemeName": {
          "description": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. |\n| BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. |\n| SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field |\n| TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
          "type": "string",
          "maxLength": 70
        },
        "issuer": {
          "description": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n",
          "type": "string",
          "maxLength": 35
        }
      },
      "required": [
        "identification",
        "schemeName"
      ]
    }
  }
}