BeneficiaryValidationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-beneficiary-validation-response-schema.json",
  "title": "BeneficiaryValidationResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-beneficiary-validation-api-openapi.yml#/components/schemas/BeneficiaryValidationResponse",
  "type": "object",
  "properties": {
    "debtor": {
      "title": "debtor",
      "allOf": [
        {
          "$ref": "#/$defs/AccountInfo"
        }
      ]
    },
    "creditor": {
      "title": "creditor",
      "allOf": [
        {
          "$ref": "#/$defs/AccountInfo"
        }
      ]
    },
    "additional_information": {
      "title": "additional_information",
      "allOf": [
        {
          "$ref": "#/$defs/AdditionalInformation"
        }
      ]
    },
    "lookup_status_information": {
      "title": "lookup_status_information",
      "allOf": [
        {
          "$ref": "#/$defs/LookupStatusInformation"
        }
      ]
    }
  },
  "$defs": {
    "AccountInfo": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name by which a party is known and which is usually used to identify that party",
          "maxLength": 140
        },
        "alias": {
          "title": "alias",
          "type": "string",
          "description": "Alias name of the party used for identification.",
          "maxLength": 140
        },
        "resolved_name": {
          "type": "string",
          "description": "Actual account name of the party resolved by backend system.",
          "maxLength": 140
        },
        "owner_type": {
          "type": "string",
          "description": "Describes the type of party who owns the respective proxy/alias, either an Individual(NATURAL_PERSON) or Corporate(LEGAL_PERSON)\n",
          "maxLength": 30
        },
        "tax_id": {
          "type": "string",
          "description": "Tax identification number of the party.\n",
          "minLength": 8,
          "maxLength": 16
        },
        "country_code": {
          "type": "string",
          "description": "Country where the request is initiated for beneficiary account search/validation in ISO 3166-1 alpha-2 format",
          "maxLength": 2
        },
        "bank_code": {
          "type": "string",
          "description": "Bank identification code of the party used for identification of a financial institution\n",
          "maxLength": 10
        },
        "branch_id": {
          "title": "branch_id",
          "type": "string",
          "description": "Branch identification identification code of the party used for identification of a financial institution\n",
          "maxLength": 10
        },
        "account_id": {
          "title": "account_id",
          "type": "string",
          "description": "Account number of the party as provided in the Input API request",
          "maxLength": 35
        },
        "proxy_type": {
          "title": "proxy_type",
          "type": "string",
          "description": "Type of the proxy value used for validation/search\n",
          "maxLength": 35
        },
        "proxy_value": {
          "title": "proxy_value",
          "type": "string",
          "description": "Actual proxy value related to the proxy type used for validation/search",
          "maxLength": 70
        },
        "account_type": {
          "title": "account_type",
          "type": "string",
          "description": "Account type of the party.\"\n",
          "maxLength": 20
        },
        "account_currency": {
          "title": "account_currency",
          "type": "string",
          "description": "Identification of the currency in which the account is held.\n\nSingle & mMltiple account currency is supported which are seperated by comma.\n",
          "pattern": "^[A-Z]{3}(,[A-Z]{3})*$"
        },
        "account_opening_date": {
          "title": "account_opening_date",
          "type": "string",
          "maxLength": 8,
          "description": "Date to identify when the Account is Operationally available for business transactions in business date format YYYYMMDD\n"
        },
        "trade_name": {
          "title": "trade_name",
          "type": "string",
          "description": "Describes the trade name of the party who owns the respective proxy/alias\n",
          "maxLength": 100
        },
        "document_type": {
          "title": "document_type",
          "type": "string",
          "description": "Name of Tax ID based on the country\n\nExample - Tax ID for Peru is 'RUC'.\n",
          "maxLength": 10
        },
        "document_number": {
          "title": "document_number",
          "type": "string",
          "description": "Unique Tax Identification number of the party.\n",
          "maxLength": 25
        },
        "account_verification_status": {
          "title": "account_verification_status",
          "type": "string",
          "description": "Account status details received from Early Warning Systems (EWS). \n",
          "maxLength": 20
        },
        "account_verification_description": {
          "title": "account_verification_description",
          "type": "string",
          "description": "Account status description details received from Early Warning Systems (EWS). \n",
          "maxLength": 200
        },
        "account_owner_status": {
          "title": "account_owner_status",
          "type": "string",
          "description": "Account status details received from Early Warning Systems (EWS). \n",
          "maxLength": 20
        },
        "account_owner_description": {
          "title": "account_owner_description",
          "type": "string",
          "description": "Account status description details received from Early Warning Systems (EWS). \n",
          "maxLength": 200
        },
        "firstname": {
          "title": "firstname",
          "type": "string",
          "description": "Beneficiary First Name verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "lastname": {
          "title": "lastname",
          "type": "string",
          "description": "Beneficiary Last Name verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "dob": {
          "title": "dob",
          "type": "string",
          "description": "Beneficiary date of birth verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "address_line1": {
          "title": "address_line1",
          "type": "string",
          "description": "Beneficiary Address line1 verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "address_line2": {
          "title": "address_line2",
          "type": "string",
          "description": "Beneficiary Address line2 verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "city": {
          "title": "city",
          "type": "string",
          "description": "Beneficiary city verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "state": {
          "title": "state",
          "type": "string",
          "description": "Beneficiary city verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "zip": {
          "title": "zip",
          "type": "string",
          "description": "Beneficiary zipcode verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "home_phone": {
          "title": "home_phone",
          "type": "string",
          "description": "Beneficiary home phone number verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "work_phone": {
          "title": "work_phone",
          "type": "string",
          "description": "Beneficiary work phone number verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "id_type": {
          "title": "id_type",
          "type": "string",
          "description": "Beneficiary identification type verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "id_no": {
          "title": "id_no",
          "type": "string",
          "description": "Beneficiary identification number verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "id_issuanceplace": {
          "title": "id_issuanceplace",
          "type": "string",
          "description": "Beneficiary identification issuance place verification response received from Early Warning Systems (EWS). \n",
          "maxLength": 6
        },
        "additional_information": {
          "title": "additional_information",
          "type": "string",
          "description": "Additional information received in the payload request for Early Warning Systems (EWS). \n",
          "maxLength": 255
        },
        "creditor_name": {
          "title": "creditor_name",
          "type": "string",
          "description": "Account name of the creditor intended for search/validation whose payment amount will be credited.\nFor early warning system (EWS), if the verification_type = (BANKOWN or BASICVR) either creditor_firstname & creditor_lastname or creditor_name (Business Name) should be passed. Business name maximum allowed length 87 characters. \n",
          "maxLength": 140,
          "minLength": 3
        }
      }
    },
    "AdditionalInformation": {
      "type": "object",
      "properties": {
        "end_to_end_id": {
          "type": "string",
          "description": "Unique identification assigned by the initiating party to unambiguously identify the transaction which can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.\n",
          "maxLength": 32
        },
        "value_date": {
          "type": "string",
          "description": "Requested execution date post alias resolution when the payment needs to be processed for settlement, format would be YYYYMMDD.\n",
          "maxLength": 8
        },
        "proxy_status": {
          "type": "string",
          "description": "Describes the status of Alias/Proxy - whether Active, Inactive or Deleted\n",
          "maxLength": 20
        },
        "banelco_flag": {
          "type": "string",
          "description": "Flag will be 'Y' for successfull search/validation & 'N' for failure case.\n",
          "maxLength": 1
        },
        "clearing_system_id": {
          "title": "clearing_system_id",
          "type": "string",
          "description": "Unique reference, as assigned by a clearing system.\n",
          "maxLength": 16
        }
      }
    },
    "LookupStatusInformation": {
      "type": "object",
      "properties": {
        "lookup_reference": {
          "type": "string",
          "description": "unique reference number of the request.This is e2e tracking reference from CCD. It will be provided by Concord.",
          "maxLength": 35
        },
        "lookup_response_status": {
          "type": "string",
          "description": "status(SUCCESS / FAILURE) of the request and get processed successfully. If account exist then status is SUCCESS else FAILURE.",
          "maxLength": 10
        },
        "status_code": {
          "type": "string",
          "description": "Response status of validation-Complete with data from Status Validation.",
          "maxLength": 3
        },
        "status_message": {
          "type": "string",
          "description": "Response message of validation-Complete with data from Message Validation.",
          "maxLength": 100
        }
      }
    }
  }
}