AccountVerificationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/swift/json-schema/swift-account-verification-request-schema.json",
  "title": "AccountVerificationRequest",
  "description": "Beneficiary account verification request.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/swift-payment-pre-validation-api-openapi.yml#/components/schemas/AccountVerificationRequest",
  "required": [
    "context",
    "creditor_account",
    "creditor_name"
  ],
  "type": "object",
  "properties": {
    "correlation_identifier": {
      "$ref": "#/$defs/Max50Text"
    },
    "context": {
      "$ref": "#/$defs/AccountValidationCheckContext1Code"
    },
    "uetr": {
      "$ref": "#/$defs/UUIDv4Identifier"
    },
    "creditor_account": {
      "$ref": "#/$defs/Max34Text"
    },
    "creditor_name": {
      "$ref": "#/$defs/Max140Text"
    },
    "creditor_address": {
      "$ref": "#/$defs/PostalAddress24"
    },
    "creditor_organisation_identification": {
      "$ref": "#/$defs/OrganisationIdentification8"
    },
    "creditor_agent": {
      "$ref": "#/$defs/FinancialInstitutionIdentification20"
    },
    "creditor_agent_branch_identification": {
      "$ref": "#/$defs/Max35Text"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "AccountValidationCheckContext1Code": {
      "type": "string",
      "description": ">\n*`BENR`-Request is in the scope of a beneficiary registration validation.\n*`PAYM`-Request is in the scope of the payment initiation.\n*`RFPP`-Request is in the scope of a request for a payment initiation.\n",
      "enum": [
        "BENR",
        "PAYM",
        "RFPP"
      ]
    },
    "AddressType2Code": {
      "type": "string",
      "description": "Specifies the type of address.\n\n`ADDR`-Address is the complete postal address.\n\n`PBOX`-Address is a postal office (PO) box.\n\n`HOME`-Address is the home address.\n\n`BIZZ`-Address is the business address.\n\n`MLTO`-Address is the address to which mail is sent.\n\n`DLVY`-Address is the address to which delivery is to take place.",
      "enum": [
        "ADDR",
        "PBOX",
        "HOME",
        "BIZZ",
        "MLTO",
        "DLVY"
      ]
    },
    "AddressType3Choice": {
      "type": "object",
      "properties": {
        "code": {
          "$ref": "#/$defs/AddressType2Code"
        },
        "proprietary": {
          "$ref": "#/$defs/GenericIdentification30"
        }
      },
      "additionalProperties": false,
      "description": "Choice of formats for the type of address.\n",
      "oneOf": [
        {
          "required": [
            "code"
          ]
        },
        {
          "required": [
            "proprietary"
          ]
        }
      ]
    },
    "AnyBICIdentifier": {
      "pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
      "type": "string",
      "description": "Code allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362 \"Banking - Banking\ntelecommunication messages - Business identifier code (BIC)\".\n"
    },
    "BICFIDec2014Identifier": {
      "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$",
      "type": "string",
      "description": "Code allocated to a financial institution by the ISO 9362 Registration\nAuthority as described in ISO 9362: 2014 - \"Banking - Banking telecommunication  messages - Business identifier code (BIC)\".\n"
    },
    "ClearingSystemIdentification2Choice": {
      "type": "object",
      "additionalProperties": true,
      "description": "Choice of a clearing system identifier.",
      "oneOf": [
        {
          "required": [
            "code"
          ],
          "type": "object",
          "properties": {
            "code": {
              "$ref": "#/$defs/ExternalClearingSystemIdentification1Code"
            }
          },
          "additionalProperties": false
        },
        {
          "required": [
            "proprietary"
          ],
          "type": "object",
          "properties": {
            "proprietary": {
              "$ref": "#/$defs/Max35Text"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "ClearingSystemMemberIdentification2": {
      "required": [
        "member_identification"
      ],
      "type": "object",
      "properties": {
        "clearing_system_identification": {
          "$ref": "#/$defs/ClearingSystemIdentification2Choice"
        },
        "member_identification": {
          "$ref": "#/$defs/Max35Text"
        }
      },
      "additionalProperties": false,
      "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n"
    },
    "CountryCode": {
      "pattern": "^[A-Z]{2,2}$",
      "type": "string",
      "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n"
    },
    "Exact4AlphaNumericText": {
      "pattern": "^[a-zA-Z0-9]{4}$",
      "type": "string",
      "description": "Specifies an alphanumeric string with a length of 4 characters.\n"
    },
    "ExternalClearingSystemIdentification1Code": {
      "maxLength": 5,
      "minLength": 1,
      "type": "string",
      "description": "Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.\n"
    },
    "ExternalOrganisationIdentification1Code": {
      "maxLength": 4,
      "minLength": 1,
      "type": "string",
      "description": "Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.\n"
    },
    "FinancialInstitutionIdentification20": {
      "type": "object",
      "properties": {
        "bicfi": {
          "$ref": "#/$defs/BICFIDec2014Identifier"
        },
        "clearing_system_member_identification": {
          "$ref": "#/$defs/ClearingSystemMemberIdentification2"
        }
      },
      "additionalProperties": false,
      "description": "Set of elements used to identify a financial institution."
    },
    "GenericIdentification30": {
      "required": [
        "identification",
        "issuer"
      ],
      "type": "object",
      "properties": {
        "identification": {
          "$ref": "#/$defs/Exact4AlphaNumericText"
        },
        "issuer": {
          "$ref": "#/$defs/Max35Text"
        },
        "scheme_name": {
          "$ref": "#/$defs/Max35Text"
        }
      },
      "additionalProperties": false,
      "description": "Information related to an identification, for example, party identification or account identification."
    },
    "GenericOrganisationIdentification1": {
      "required": [
        "identification"
      ],
      "type": "object",
      "properties": {
        "identification": {
          "$ref": "#/$defs/Max35Text"
        },
        "scheme_name": {
          "$ref": "#/$defs/OrganisationIdentificationSchemeName1Choice"
        },
        "issuer": {
          "$ref": "#/$defs/Max35Text"
        }
      },
      "additionalProperties": false,
      "description": "Information related to an identification of an organisation."
    },
    "Max140Text": {
      "maxLength": 140,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 140 characters."
    },
    "Max16Text": {
      "maxLength": 16,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 16 characters."
    },
    "Max34Text": {
      "maxLength": 34,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 34 characters."
    },
    "Max35Text": {
      "maxLength": 35,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 35 characters."
    },
    "Max50Text": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 50 characters."
    },
    "Max70Text": {
      "maxLength": 70,
      "minLength": 1,
      "type": "string",
      "description": "Specifies a character string with a maximum length of 70characters."
    },
    "OrganisationIdentification8": {
      "type": "object",
      "properties": {
        "any_bic": {
          "$ref": "#/$defs/AnyBICIdentifier"
        },
        "other": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/GenericOrganisationIdentification1"
          }
        }
      },
      "additionalProperties": false,
      "description": "Unique and unambiguous way to identify an organisation."
    },
    "OrganisationIdentificationSchemeName1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "$ref": "#/$defs/ExternalOrganisationIdentification1Code"
        },
        "proprietary": {
          "$ref": "#/$defs/Max35Text"
        }
      },
      "additionalProperties": false,
      "description": "Sets of elements to identify a name of the organisation identification scheme.",
      "oneOf": [
        {
          "required": [
            "code"
          ]
        },
        {
          "required": [
            "proprietary"
          ]
        }
      ]
    },
    "PostalAddress24": {
      "type": "object",
      "properties": {
        "address_type": {
          "$ref": "#/$defs/AddressType3Choice"
        },
        "department": {
          "$ref": "#/$defs/Max70Text"
        },
        "sub_department": {
          "$ref": "#/$defs/Max70Text"
        },
        "street_name": {
          "$ref": "#/$defs/Max70Text"
        },
        "building_number": {
          "$ref": "#/$defs/Max16Text"
        },
        "building_name": {
          "$ref": "#/$defs/Max35Text"
        },
        "floor": {
          "$ref": "#/$defs/Max70Text"
        },
        "post_box": {
          "$ref": "#/$defs/Max16Text"
        },
        "room": {
          "$ref": "#/$defs/Max70Text"
        },
        "post_code": {
          "$ref": "#/$defs/Max16Text"
        },
        "town_name": {
          "$ref": "#/$defs/Max35Text"
        },
        "town_location_name": {
          "$ref": "#/$defs/Max35Text"
        },
        "district_name": {
          "$ref": "#/$defs/Max35Text"
        },
        "country_sub_division": {
          "$ref": "#/$defs/Max35Text"
        },
        "country": {
          "$ref": "#/$defs/CountryCode"
        },
        "address_line": {
          "maxItems": 7,
          "type": "array",
          "items": {
            "$ref": "#/$defs/Max70Text"
          }
        }
      },
      "additionalProperties": false,
      "description": "Information that locates and identifies a specific address, as defined by postal services."
    },
    "UUIDv4Identifier": {
      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
      "type": "string",
      "description": "Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 \"Universally Unique IDentifier (UUID) URN Namespace\"."
    }
  }
}