{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/currencycloud/main/json-schema/currencycloud-beneficiary-schema.json",
  "title": "Beneficiary",
  "description": "Beneficiary",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/currencycloud-beneficiaries-api-openapi.yml#/components/schemas/Beneficiary",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Beneficiary UUID"
    },
    "bank_account_holder_name": {
      "type": "string",
      "description": "Bank account holder's name."
    },
    "name": {
      "type": "string",
      "description": "Beneficiary's name"
    },
    "email": {
      "type": "string",
      "description": "Beneficiary's email address"
    },
    "payment_types": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "The payment type - regular (local) or priority (Swift).",
        "enum": [
          "priority",
          "regular"
        ]
      }
    },
    "beneficiary_address": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Line of address."
      }
    },
    "beneficiary_country": {
      "type": "string",
      "description": "Two-letter ISO country code."
    },
    "beneficiary_entity_type": {
      "type": "string",
      "description": "Beneficiary legal entity type - company or individual.",
      "enum": [
        "company",
        "individual"
      ]
    },
    "beneficiary_company_name": {
      "type": "string",
      "description": "For companies"
    },
    "beneficiary_first_name": {
      "type": "string",
      "description": "For individuals"
    },
    "beneficiary_last_name": {
      "type": "string",
      "description": "For individuals"
    },
    "beneficiary_city": {
      "type": "string",
      "description": "City"
    },
    "beneficiary_postcode": {
      "type": "string",
      "description": "Postal code"
    },
    "beneficiary_state_or_province": {
      "type": "string",
      "description": "State or province."
    },
    "beneficiary_date_of_birth": {
      "type": "string",
      "description": "For companies, this is the foundation date of the company. For individuals, it is their date of birth."
    },
    "beneficiary_identification_type": {
      "type": "string",
      "description": "A legal document that verifies the identity of the beneficiary."
    },
    "beneficiary_identification_value": {
      "type": "string",
      "description": "A unique reference code for the identification document, such as a passport number."
    },
    "bank_country": {
      "type": "string",
      "description": "Two-letter ISO code for the country in which the beneficiary's bank account is held."
    },
    "bank_name": {
      "type": "string",
      "description": "Bank name"
    },
    "bank_account_type": {
      "type": "string",
      "description": "Bank account type.",
      "enum": [
        "checking",
        "savings"
      ]
    },
    "currency": {
      "type": "string",
      "description": "Currency in which money is held in the beneficiary's bank account. Three-digit currency code."
    },
    "account_number": {
      "type": "string",
      "description": "Bank account number."
    },
    "routing_code_type_1": {
      "type": "string",
      "description": "Local payment routing system."
    },
    "routing_code_value_1": {
      "type": "string",
      "description": "Value for \"routing_code_type_1\"."
    },
    "routing_code_type_2": {
      "type": "string",
      "description": "Local payment routing system."
    },
    "routing_code_value_2": {
      "type": "string",
      "description": "Value for \"routing_code_type_2\"."
    },
    "bic_swift": {
      "type": "string",
      "description": "BIC/Swift code"
    },
    "iban": {
      "type": "string",
      "description": "IBAN code"
    },
    "default_beneficiary": {
      "type": "string",
      "description": "Payments are made automatically to default beneficiaries when a beneficiary is not specified.",
      "enum": [
        "true",
        "false"
      ]
    },
    "creator_contact_id": {
      "type": "string",
      "description": "Contact UUID of beneficiary creator."
    },
    "bank_address": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Line of address."
      }
    },
    "created_at": {
      "type": "string",
      "description": "Date the beneficiary record was created.",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "description": "Date the beneficiary record was last updated.",
      "format": "date-time"
    },
    "beneficiary_external_reference": {
      "type": "string",
      "description": "Beneficiary external reference."
    },
    "business_nature": {
      "type": "string",
      "description": "Beneficiary nature of business."
    },
    "company_website": {
      "type": "string",
      "description": "Beneficiary company website."
    }
  }
}