OBReadBeneficiary3

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/revolut/main/json-schema/revolut-obread-beneficiary3-schema.json",
  "title": "OBReadBeneficiary3",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/revolut-accounts-api-openapi.yml#/components/schemas/OBReadBeneficiary3",
  "required": [
    "Data",
    "Links",
    "Meta"
  ],
  "type": "object",
  "properties": {
    "Data": {
      "type": "object",
      "properties": {
        "Beneficiary": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OBBeneficiary3"
          }
        }
      },
      "description": "A list of beneficiaries."
    },
    "Links": {
      "$ref": "#/$defs/Links"
    },
    "Meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "$defs": {
    "AccountId": {
      "maxLength": 40,
      "minLength": 1,
      "type": "string",
      "description": "The unique and immutable ID to identify the account resource.\nThis ID has no meaning to the account owner."
    },
    "Links": {
      "required": [
        "Self"
      ],
      "type": "object",
      "properties": {
        "Self": {
          "type": "string",
          "description": "The absolute URI to the resource.",
          "format": "uri"
        },
        "Next": {
          "type": "string",
          "description": "The absolute URI to the next pagination resource.",
          "format": "uri"
        },
        "Prev": {
          "type": "string",
          "description": "The absolute URI to the previous pagination resource.",
          "format": "uri"
        }
      },
      "description": "Links relevant to the payload."
    },
    "Meta": {
      "title": "MetaData",
      "type": "object",
      "properties": {
        "TotalPages": {
          "type": "integer",
          "description": "Used for pagination. Indicates how many pages of results are available.",
          "format": "int32"
        }
      },
      "description": "Meta data relevant to the payload."
    },
    "OBBeneficiary3": {
      "type": "object",
      "properties": {
        "AccountId": {
          "$ref": "#/$defs/AccountId"
        },
        "BeneficiaryId": {
          "maxLength": 40,
          "minLength": 1,
          "type": "string",
          "description": "The unique and immutable ID to identify the beneficiary resource.\nThis ID has no meaning to the account owner."
        },
        "CreditorAccount": {
          "$ref": "#/$defs/OBCashAccount5"
        }
      }
    },
    "OBCashAccount5": {
      "required": [
        "Identification",
        "SchemeName"
      ],
      "type": "object",
      "properties": {
        "SchemeName": {
          "$ref": "#/$defs/OBRevolutAccountIdentificationCode"
        },
        "Identification": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The identification of the account.\n\n:::warning[Unique account identifier]\nThis field will typically contain an account number or an IBAN which must not be considered as a unique identifier for the account. Several currency subacounts can share this same identifier.\n\nIf you need a unique identifier for each account, ensure you use the `Data.Account.AccountId` instead.\n:::\n"
        },
        "Name": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The account name that the account servicing institution assigns.\n\nThe account name is the name or names of the account owner(s) represented at an account level.\n\nThe account name is not the product name or the nickname of the account."
        },
        "SecondaryIdentification": {
          "maxLength": 34,
          "minLength": 1,
          "type": "string",
          "description": "The secondary account ID that the account servicing institution assigns.\n\nBuilding societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination."
        }
      },
      "description": "The details to identify the account."
    },
    "OBRevolutAccountIdentificationCode": {
      "type": "string",
      "description": "The name of the identification scheme.\n\nNote the scheme `UK.Revolut.InternalAccountId` is an internal account identifier for those accounts which don't have externally available identifiers.\nIt cannot be used to send or receive funds.\n",
      "enum": [
        "UK.OBIE.IBAN",
        "UK.OBIE.SortCodeAccountNumber",
        "US.RoutingNumberAccountNumber",
        "US.BranchCodeAccountNumber",
        "UK.Revolut.InternalAccountId"
      ]
    }
  }
}