DocumentReq

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-document-req-schema.json",
  "title": "DocumentReq",
  "description": "Payment initiation request body.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-pacs-00800108-api-openapi.yml#/components/schemas/DocumentReq",
  "required": [
    "FIToFICstmrCdtTrf"
  ],
  "properties": {
    "FIToFICstmrCdtTrf": {
      "$ref": "#/$defs/FIToFICustomerCreditTransferV08"
    }
  },
  "$defs": {
    "AccountIdentification4Choice": {
      "type": "object",
      "properties": {
        "IBAN": {
          "$ref": "#/$defs/IBAN2007Identifier"
        },
        "Othr": {
          "$ref": "#/$defs/GenericAccountIdentification1"
        }
      },
      "description": "Unique identification for the account between the account owner and the account servicer. Either the`iban` or the `Othr` parameter should be passed in the request ."
    },
    "ActiveCurrencyAndAmount": {
      "type": "object",
      "properties": {
        "Ccy": {
          "type": "object",
          "description": "Currency code. Passed as the tag attribute.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
            }
          ]
        },
        "Value": {
          "$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount_SimpleType"
        }
      }
    },
    "ActiveOrHistoricCurrencyAndAmount": {
      "type": "object",
      "properties": {
        "Ccy": {
          "type": "object",
          "description": "Currency code. Passed as the tag attribute.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
            }
          ]
        },
        "Value": {
          "$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount_SimpleType"
        }
      }
    },
    "ActiveOrHistoricCurrencyAndAmount_SimpleType": {
      "maxLength": 18,
      "type": "string",
      "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. The number of fractional digits in the amount should not be more than 5."
    },
    "ActiveOrHistoricCurrencyCode": {
      "pattern": "[A-Z]{3,3}",
      "type": "string"
    },
    "AddressType3Choice": {
      "type": "object",
      "properties": {
        "Cd": {
          "type": "string",
          "description": "Specifies the type of address.<br><br><b>ADDR</b>: Address is the complete postal address. <br><br><b>PBOX</b>: Address is a postal office (PO) box. <br><br><b>HOME</b>: Address is the home address. <br><br><b>BIZZ</b>: Address is the business address.<br><br><b>MLTO</b>: Address is the address to which mail is sent.<br><br><b>DLVY</b>: Address is the address to which delivery is to take place.",
          "enum": [
            "ADDR",
            "PBOX",
            "HOME",
            "BIZZ",
            "MLTO",
            "DLVY"
          ]
        },
        "Prtry": {
          "$ref": "#/$defs/GenericIdentification30"
        }
      },
      "description": "Identifies the nature of the postal address. Either Code or Proprietary parameter should be passed in the request ."
    },
    "BaseOneRate": {
      "maxLength": 11,
      "type": "string",
      "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. The number of fractional digits in the rate should not be more than 10."
    },
    "BranchAndFinancialInstitutionIdentification6": {
      "required": [
        "FinInstnId"
      ],
      "type": "object",
      "properties": {
        "BrnchId": {
          "$ref": "#/$defs/BranchData3"
        },
        "FinInstnId": {
          "$ref": "#/$defs/FinancialInstitutionIdentification18"
        }
      }
    },
    "BranchData3": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "object",
          "description": "Unique identification of a branch of a financial institution.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "LEI": {
          "pattern": "[A-Z0-9]{18,18}[0-9]{2,2}",
          "type": "string",
          "description": "Legal entity identifier of the financial institution."
        },
        "Nm": {
          "type": "object",
          "description": "Name by which an agent is known and which is usually used to identify that agent.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "PstlAdr": {
          "$ref": "#/$defs/PostalAddress24"
        }
      },
      "description": "Identifies a specific branch of a financial institution."
    },
    "CashAccount38": {
      "required": [
        "Id"
      ],
      "type": "object",
      "properties": {
        "Ccy": {
          "type": "object",
          "description": "Identification of the currency in which the account is held.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
            }
          ]
        },
        "Id": {
          "$ref": "#/$defs/AccountIdentification4Choice"
        },
        "Nm": {
          "type": "object",
          "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "Tp": {
          "$ref": "#/$defs/CashAccountType2Choice"
        },
        "Prxy": {
          "$ref": "#/$defs/ProxyAccountIdentification1"
        }
      }
    },
    "CashAccountType2Choice": {
      "type": "object",
      "properties": {
        "Cd": {
          "maxLength": 4,
          "minLength": 1,
          "type": "string",
          "description": "Specifies the nature, or use, of the cash account 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."
        },
        "Prtry": {
          "type": "object",
          "description": "Name of the cash account, in a free text form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specifies the nature, or use of the account. Either the `code` or the `proprietary` parameter should be passed in the request."
    },
    "CategoryPurpose1Choice": {
      "type": "object",
      "properties": {
        "Cd": {
          "maxLength": 4,
          "minLength": 1,
          "type": "string",
          "description": "Category purpose, as published in an external category purpose code list."
        },
        "Prtry": {
          "type": "object",
          "description": "Category purpose, in a proprietary form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories. Either the `code` or the `proprietary` parameter should be passed in the request ."
    },
    "ChargeBearerType1Code": {
      "type": "string",
      "description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction. <br><br><b>DEBT</b>: All transaction charges are to be borne by the debtor. <br><br><b>CRED</b>: All transaction charges are to be borne by the creditor. <br><br><b>SHAR</b>: In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. <br><br><b>SLEV</b>: Charges are to be applied following the rules agreed in the service level and/or scheme.",
      "enum": [
        "DEBT",
        "CRED",
        "SHAR",
        "SLEV"
      ]
    },
    "Charges7": {
      "type": "object",
      "properties": {
        "Amt": {
          "type": "object",
          "description": "Transaction charges to be paid by the charge bearer.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
            }
          ]
        },
        "Agt": {
          "type": "object",
          "description": "Agent that takes the transaction charges or to which the transaction charges are due.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        }
      }
    },
    "ClearingChannel2Code": {
      "type": "string",
      "description": "Specifies the clearing channel to be used to process the payment instruction. <br><br><b>RTGS</b>: Clearing channel is a real-time gross settlement system. <br><br><b>RTNS</b>: Clearing channel is a real-time net settlement system. <br><br><b>MPNS</b>: Clearing channel is a mass payment net settlement system. <br><br><b>BOOK</b>: Payment through internal book transfer.",
      "enum": [
        "RTGS",
        "RTNS",
        "MPNS",
        "BOOK"
      ]
    },
    "ClearingSystemIdentification3Choice": {
      "type": "object",
      "properties": {
        "Cd": {
          "maxLength": 3,
          "minLength": 1,
          "type": "string",
          "description": "Infrastructure through which the payment instruction is processed, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org."
        },
        "Prtry": {
          "type": "object",
          "description": "Clearing system identification in a proprietary form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Either the `code` or the `proprietary` parameter should be passed in the request ."
    },
    "ClearingSystemMemberIdentification2": {
      "required": [
        "MmbId"
      ],
      "type": "object",
      "properties": {
        "ClrSysId": {
          "type": "object",
          "properties": {
            "Cd": {
              "maxLength": 5,
              "minLength": 1,
              "type": "string",
              "description": "Identification of a clearing system, in a coded form as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org."
            },
            "Prtry": {
              "type": "object",
              "description": "Identification code for a clearing system, that has not yet been identified in the list of clearing systems.",
              "allOf": [
                {
                  "$ref": "#/$defs/Max35Text"
                }
              ]
            }
          },
          "description": "Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Either the `code` or the `proprietary` parameter should be passed in the request ."
        },
        "MmbId": {
          "type": "object",
          "description": "Identification of a member of a clearing system.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Information used to identify a member within a clearing system."
    },
    "Contact4": {
      "type": "object",
      "properties": {
        "NmPrfx": {
          "$ref": "#/$defs/NamePrefix2Code"
        },
        "Nm": {
          "type": "object",
          "description": "Name by which a party is known and which is usually used to identify that party.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "PhneNb": {
          "type": "object",
          "description": "Collection of information that identifies a phone number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "MobNb": {
          "type": "object",
          "description": "Collection of information that identifies a mobile phone number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "FaxNb": {
          "type": "object",
          "description": "Collection of information that identifies a FAX number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "EmailAdr": {
          "type": "object",
          "description": "Address for electronic mail (e-mail).",
          "allOf": [
            {
              "$ref": "#/$defs/Max2048Text"
            }
          ]
        },
        "EmailPurp": {
          "type": "object",
          "description": "Purpose for which an email address may be used.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "JobTitl": {
          "type": "object",
          "description": "Title of the function.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "Rspnsblty": {
          "type": "object",
          "description": "Role of a person in an organization.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "Dept": {
          "type": "object",
          "description": "Identification of a division of a large organization or building.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "Othr": {
          "type": "array",
          "description": "Contact details in another form.",
          "items": {
            "$ref": "#/$defs/OtherContact1"
          }
        },
        "PrefrdMtd": {
          "$ref": "#/$defs/PreferredContactMethod1Code"
        }
      },
      "description": "Set of elements used to indicate how to contact the party."
    },
    "CountryCode": {
      "pattern": "[A-Z]{2,2}",
      "type": "string",
      "description": "Nation with its own government. The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code)."
    },
    "CreditDebitCode": {
      "type": "string",
      "description": "Specifies whether the adjustment must be subtracted or added to the total amount.<br><br><b>CRDT</b>: Operation is an increase. <br><br><b>DBIT</b>: Operation is a decrease.",
      "enum": [
        "CRDT",
        "DBIT"
      ]
    },
    "CreditTransferTransaction39": {
      "required": [
        "Cdtr",
        "CdtrAgt",
        "ChrgBr",
        "Dbtr",
        "DbtrAgt",
        "IntrBkSttlmAmt",
        "PmtId"
      ],
      "type": "object",
      "properties": {
        "PmtId": {
          "$ref": "#/$defs/PaymentIdentification7"
        },
        "PmtTpInf": {
          "$ref": "#/$defs/PaymentTypeInformation28"
        },
        "IntrBkSttlmAmt": {
          "type": "object",
          "description": "Amount of money moved between the instructing agent and the instructed agent.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveCurrencyAndAmount"
            }
          ]
        },
        "IntrBkSttlmDt": {
          "type": "string",
          "description": "Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.",
          "format": "date"
        },
        "SttlmPrty": {
          "type": "object",
          "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the settlement instruction.",
          "allOf": [
            {
              "$ref": "#/$defs/Priority3Code"
            }
          ]
        },
        "SttlmTmIndctn": {
          "type": "object",
          "properties": {
            "DbtDtTm": {
              "type": "string",
              "description": "Date and time at which a payment has been debited at the transaction administrator. In the case of TARGET, the date and time at which the payment has been debited at the central bank, expressed in Central European Time (CET).",
              "format": "date-time"
            },
            "CdtDtTm": {
              "type": "string",
              "description": "Date and time at which a payment has been credited at the transaction administrator. In the case of TARGET, the date and time at which the payment has been credited at the receiving central bank, expressed in Central European Time (CET).",
              "format": "date-time"
            }
          },
          "description": "Provides information on the occurred settlement time(s) of the payment transaction."
        },
        "SttlmTmReq": {
          "type": "object",
          "properties": {
            "CLSTm": {
              "type": "string",
              "description": "Time by which the amount of money must be credited, with confirmation, to the CLS Bank's account at the central bank.",
              "format": "partial-time"
            },
            "TillTm": {
              "type": "string",
              "description": "Time until when the payment may be settled.",
              "format": "partial-time"
            },
            "FrTm": {
              "type": "string",
              "description": "Time as from when the payment may be settled.",
              "format": "partial-time"
            },
            "RjctTm": {
              "type": "string",
              "description": "Time by when the payment must be settled to avoid rejection.",
              "format": "partial-time"
            }
          },
          "description": "Provides information on the requested settlement time(s) of the payment instruction."
        },
        "AccptncDtTm": {
          "type": "string",
          "description": "Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds.",
          "format": "date-time"
        },
        "PoolgAdjstmntDt": {
          "type": "object",
          "description": "Date used for the correction of the value date of a cash pool movement that has been posted with a different value date.",
          "allOf": [
            {
              "$ref": "#/$defs/ISODate"
            }
          ]
        },
        "InstdAmt": {
          "type": "object",
          "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
            }
          ]
        },
        "XchgRate": {
          "$ref": "#/$defs/BaseOneRate"
        },
        "ChrgBr": {
          "$ref": "#/$defs/ChargeBearerType1Code"
        },
        "ChrgsInf": {
          "type": "array",
          "description": "Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction.",
          "items": {
            "$ref": "#/$defs/Charges7"
          }
        },
        "PrvsInstgAgt1": {
          "type": "object",
          "description": "Agent immediately prior to the instructing agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "PrvsInstgAgt1Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "PrvsInstgAgt2": {
          "type": "object",
          "description": "Agent immediately prior to the instructing agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "PrvsInstgAgt2Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "PrvsInstgAgt3": {
          "type": "object",
          "description": "Agent immediately prior to the instructing agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "PrvsInstgAgt3Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "InstgAgt": {
          "type": "object",
          "description": "Agent that instructs the next party in the chain to carry out the (set of) instruction(s).",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "InstdAgt": {
          "type": "object",
          "description": "Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s).",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "IntrmyAgt1": {
          "type": "object",
          "description": "Agent between the debtor's agent and the creditor's agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "IntrmyAgt1Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the intermediary agent 1 at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "IntrmyAgt2": {
          "type": "object",
          "description": "Agent between the debtor's agent and the creditor's agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "IntrmyAgt2Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the intermediary agent 2 at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "IntrmyAgt3": {
          "type": "object",
          "description": "Agent between the debtor's agent and the creditor's agent.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "IntrmyAgt3Acct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "UltmtDbtr": {
          "type": "object",
          "description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "InitgPty": {
          "type": "object",
          "description": "Party that initiates the payment.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "Dbtr": {
          "type": "object",
          "description": "Party that owes an amount of money to the creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "DbtrAcct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "DbtrAgt": {
          "type": "object",
          "description": "Financial institution servicing an account for the debtor.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "DbtrAgtAcct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "Cdtr": {
          "type": "object",
          "description": "Party to which an amount of money is due.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "CdtrAcct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "CdtrAgt": {
          "type": "object",
          "description": "Financial institution servicing an account for the creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "CdtrAgtAcct": {
          "type": "object",
          "description": "Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "UltmtCdtr": {
          "type": "object",
          "description": "Ultimate party to which an amount of money is due.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "InstrForCdtrAgt": {
          "type": "array",
          "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.",
          "items": {
            "$ref": "#/$defs/InstructionForCreditorAgent1"
          }
        },
        "InstrForNxtAgt": {
          "type": "array",
          "description": "Further information related to the processing of the payment instruction that may need to be acted upon by the next agent.",
          "items": {
            "$ref": "#/$defs/InstructionForNextAgent1"
          }
        },
        "Purp": {
          "$ref": "#/$defs/Purpose2Choice"
        },
        "RgltryRptg": {
          "maxItems": 10,
          "type": "array",
          "description": "Information needed due to regulatory and statutory requirements.",
          "items": {
            "$ref": "#/$defs/RegulatoryReporting3"
          }
        },
        "Tax": {
          "$ref": "#/$defs/TaxInformation8"
        },
        "RltdRmtInf": {
          "maxItems": 10,
          "type": "array",
          "description": "Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.",
          "items": {
            "$ref": "#/$defs/RemittanceLocation7"
          }
        },
        "RmtInf": {
          "type": "object",
          "description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.",
          "allOf": [
            {
              "$ref": "#/$defs/RemittanceInformation16"
            }
          ]
        },
        "SplmtryData": {
          "type": "array",
          "description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
          "items": {
            "$ref": "#/$defs/SupplementaryData1"
          }
        }
      }
    },
    "CreditorReferenceInformation2": {
      "type": "object",
      "properties": {
        "Ref": {
          "type": "object",
          "description": "Unique reference, as assigned by the creditor, to  refer to the payment transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "Tp": {
          "$ref": "#/$defs/CreditorReferenceType2"
        }
      },
      "description": "Reference information provided by the creditor to allow the identification of the underlying documents."
    },
    "CreditorReferenceType1Choice": {
      "type": "object",
      "properties": {
        "Cd": {
          "$ref": "#/$defs/DocumentType3Code"
        },
        "Prtry": {
          "type": "object",
          "description": "Creditor reference type, in a proprietary form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Coded or proprietary format creditor reference type. Either Code or Proprietary field value should be passed on request."
    },
    "CreditorReferenceType2": {
      "required": [
        "CdOrPrtry"
      ],
      "type": "object",
      "properties": {
        "CdOrPrtry": {
          "$ref": "#/$defs/CreditorReferenceType1Choice"
        },
        "Issr": {
          "type": "object",
          "description": "Entity that assigns the credit reference type.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specifies the type of creditor reference."
    },
    "DateAndPlaceOfBirth": {
      "required": [
        "BirthDt",
        "CityOfBirth",
        "CtryOfBirth"
      ],
      "type": "object",
      "properties": {
        "BirthDt": {
          "type": "object",
          "description": "Date on which a person is born.",
          "allOf": [
            {
              "$ref": "#/$defs/ISODate"
            }
          ]
        },
        "PrvcOfBirth": {
          "type": "object",
          "description": "Province where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "CityOfBirth": {
          "type": "object",
          "description": "City where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "CtryOfBirth": {
          "type": "object",
          "description": "Country where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/CountryCode"
            }
          ]
        }
      },
      "description": "Date and place of birth of a person."
    },
    "DatePeriodDetails": {
      "required": [
        "FrDt",
        "ToDt"
      ],
      "type": "object",
      "properties": {
        "FrDt": {

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/json-schema/citi-document-req-schema.json