{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-inquiry-response-schema.json",
  "title": "Inquiry-Response",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-payeridinquiry-api-openapi.yml#/components/schemas/Inquiry-Response",
  "required": [
    "request_id",
    "country_code"
  ],
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "title": "request_id",
      "maxLength": 96,
      "description": "Auto-generated unique identification assigned for the incoming request."
    },
    "country_code": {
      "$ref": "#/$defs/Country-Code"
    },
    "payerid_details": {
      "$ref": "#/$defs/Payer-ID-Details-Sync-Response"
    },
    "merchant": {
      "$ref": "#/$defs/Merchant-Details-Sync-Response"
    },
    "beneficiary": {
      "title": "beneficiaries",
      "type": "array",
      "maxItems": 20,
      "items": {
        "$ref": "#/$defs/Beneficiary-Details-Sync-Response"
      }
    },
    "error_details": {
      "title": "error_details",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Error-Details"
      }
    }
  },
  "$defs": {
    "Account-Inquiry": {
      "required": [
        "client_account",
        "branch_code",
        "instruction_currencies"
      ],
      "type": "object",
      "title": "Account-Inquiry",
      "properties": {
        "client_account": {
          "title": "client_account",
          "type": "string",
          "minLength": 1,
          "maxLength": 20,
          "description": "Specifies client's account mapped to the Payer ID."
        },
        "branch_code": {
          "title": "branch_code",
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "description": "Citi Internal branch code"
        },
        "instruction_currencies": {
          "title": "instruction_currencies",
          "type": "array",
          "pattern": "^[A-Z]{3}(?:,[A-Z]{3}){0,300}$",
          "description": "The 3-character ISO currency code.",
          "items": {
            "$ref": "#/$defs/Instruction-Currency"
          }
        },
        "client_segment": {
          "title": "client_segment",
          "type": "string",
          "enum": [
            "Corporate",
            "PI",
            "Bank"
          ],
          "description": "Segmentation of clients based on 'Corporate', 'PI', 'Bank'"
        },
        "usecase_of_payerid": {
          "title": "usecase_of_payerid",
          "type": "string",
          "enum": [
            "Reconciliation",
            "Funding",
            "Sales",
            "Multi-party",
            "Sales,Funding",
            "Multi-party,Funding",
            "Sales,Multi-party",
            "Sales,Multi-party,Funding"
          ],
          "description": "Use case description of payer ID."
        }
      }
    },
    "Beneficiary-Details-Sync-Response": {
      "title": "Beneficiary-Details-Sync-Response",
      "allOf": [
        {
          "$ref": "#/$defs/Payer-ID-Address-Details-Inquiry"
        },
        {
          "type": "object",
          "title": "allOf",
          "properties": {
            "beneficiary_id": {
              "title": "beneficiary_id",
              "minLength": 1,
              "maxLength": 35,
              "type": "string",
              "description": "Unique ID given for beneficiary."
            },
            "last_name": {
              "title": "last_name",
              "minLength": 1,
              "maxLength": 300,
              "type": "string",
              "description": "Identification of beneficiary owner's last name."
            },
            "middle_name": {
              "title": "middle_name",
              "minLength": 1,
              "maxLength": 300,
              "type": "string",
              "description": "Identification of beneficiary owner's middle name."
            },
            "first_name": {
              "title": "first_name",
              "minLength": 1,
              "maxLength": 300,
              "type": "string",
              "description": "Identification of beneficiary owner's first name."
            },
            "dob": {
              "title": "dob",
              "type": "string",
              "format": "date",
              "description": "Identification of beneficiary owner's date of birth. It is in fixed 10-digit format (YYYY-MM-DD) as per ISO date format."
            },
            "tax_identifier": {
              "title": "tax_identifier",
              "minLength": 1,
              "maxLength": 200,
              "type": "string",
              "description": "The beneficiary owner's tax identifier."
            },
            "economic_id": {
              "$ref": "#/$defs/Beneficiary-Economic-Id"
            }
          }
        }
      ]
    },
    "Beneficiary-Economic-Id": {
      "title": "Beneficiary-Economic-Id",
      "minLength": 1,
      "maxLength": 50,
      "type": "string",
      "description": "Beneficiary economic id based on the beneficiary's country."
    },
    "Country-Code": {
      "title": "Country-Code",
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "description": "The ISO country code specifying which country where the account is held with. For example, if we receive a request for Germany, then the county code is 'DE', for France, the country code is 'FR'. The list of allowed country codes are: <br>'DE' - Germany<br> 'FR' - France<br> 'GB' - Great Britain<br>'IE' - Ireland<br>'NL' - Netherlands<br>'US' - United States<br>'CA' - Canada<br> 'HK' - Hong Kong<br> 'SG' - Singapore<br>'AU' - Australia<br>'NZ' - New Zealand<br>'LU' - Luxembourg<br> 'VN' - Vietnam"
    },
    "Error-Details": {
      "type": "object",
      "title": "Error-Details",
      "properties": {
        "code": {
          "type": "string",
          "title": "code",
          "description": "Error category that provides more information about error types.",
          "maxLength": 7
        },
        "issue": {
          "type": "string",
          "title": "issue",
          "description": "Information about the issue.",
          "maxLength": 200
        },
        "action": {
          "type": "string",
          "title": "action",
          "description": "The corrective action to be taken to resolve the issue.",
          "maxLength": 350
        }
      }
    },
    "Instruction-Currency": {
      "type": "string",
      "title": "Instruction-Currency",
      "pattern": "^[A-Z]{3}$",
      "description": "The 3-character ISO currency code. It is a payment currency, for example, 'EUR' or 'GBP'."
    },
    "Merchant-Details-Inquiry": {
      "title": "Merchant-Details-Inquiry",
      "allOf": [
        {
          "$ref": "#/$defs/Payer-ID-Address-Details-Inquiry"
        },
        {
          "type": "object",
          "title": "allOf",
          "properties": {
            "party_type_details": {
              "$ref": "#/$defs/Party-Type-Details"
            },
            "name_1": {
              "title": "name_1",
              "minLength": 1,
              "maxLength": 300,
              "type": "string",
              "description": "LastName Or CompanyName for 'sole trader', include the last name for 'company', include the company name."
            },
            "name_2": {
              "title": "name_2",
              "minLength": 1,
              "maxLength": 300,
              "type": "string",
              "description": "For 'sole trader', include the first name for 'company', leave blank or include second line of company name."
            },
            "date": {
              "title": "date",
              "type": "string",
              "format": "date",
              "description": "Sole trader's date of birth or a company's date of incorporation. This parameter is in fixed 10-digit format (YYYY-MM-DD) as per ISO format."
            },
            "tax_identifier": {
              "title": "tax_identifier",
              "minLength": 1,
              "maxLength": 200,
              "type": "string",
              "description": "Merchant tax identifier based on the merchant's country."
            },
            "economic_id": {
              "$ref": "#/$defs/Merchant-Economic-Id"
            },
            "website": {
              "title": "website",
              "minLength": 1,
              "maxLength": 500,
              "type": "string",
              "description": "Merchant's profile, website, or storefront."
            }
          }
        }
      ]
    },
    "Merchant-Details-Sync-Response": {
      "title": "Merchant-Details-Sync-Response",
      "allOf": [
        {
          "$ref": "#/$defs/Merchant-Details-Inquiry"
        },
        {
          "type": "object",
          "title": "allOf",
          "properties": {
            "assignee_id": {
              "title": "assignee_id",
              "type": "string",
              "description": "Assignee ID for upfront sanction screening and activation of Payer ID number.",
              "minLength": 1,
              "maxLength": 100
            },
            "assignee_id_status": {
              "title": "assignee_id_status",
              "type": "string",
              "description": "Specifies the status of assignee ID.",
              "minLength": 1,
              "maxLength": 35
            },
            "assignee_id_reason": {
              "title": "assignee_id_reason",
              "type": "string",
              "description": "Specifies the reason for the deactivation of an assignee ID.",
              "minLength": 1,
              "maxLength": 255
            }
          }
        }
      ]
    },
    "Merchant-Economic-Id": {
      "title": "Merchant-Economic-Id",
      "minLength": 1,
      "maxLength": 50,
      "type": "string",
      "description": "Merchant economic id based on the merchant's country."
    },
    "Party-Type-Details": {
      "title": "Party-Type-Details",
      "type": "string",
      "enum": [
        "C",
        "S"
      ],
      "description": "Account party type details. Allowed account part type values are:<br> <br>`S` - sole trader, which is an enterprise owned or run by a single person. <br>`C` - a company that is owned by an organization or business entity"
    },
    "Payer-ID-Address-Details-Inquiry": {
      "type": "object",
      "title": "Payer-ID-Address-Details-Inquiry",
      "properties": {
        "address": {
          "minLength": 1,
          "maxLength": 500,
          "type": "string",
          "title": "address",
          "description": "Identification of merchant/beneficiary address."
        },
        "zipcode": {
          "minLength": 1,
          "maxLength": 45,
          "type": "string",
          "title": "zipcode",
          "description": "Identification of merchant/beneficiary zip code."
        },
        "city": {
          "minLength": 1,
          "maxLength": 150,
          "type": "string",
          "title": "city",
          "description": "Identification of merchant/beneficiary city."
        },
        "state": {
          "minLength": 1,
          "maxLength": 150,
          "type": "string",
          "title": "state",
          "description": "Identification of merchant/beneficiary state."
        },
        "country_code": {
          "minLength": 1,
          "maxLength": 20,
          "title": "country_code",
          "type": "string",
          "description": "Identification of country code. Country code specifying which country the account is held with."
        }
      }
    },
    "Payer-ID-Details-Sync-Response": {
      "type": "object",
      "title": "Payer-ID-Details-Sync-Response",
      "properties": {
        "payerid_number": {
          "title": "payerid_number",
          "type": "string",
          "minLength": 1,
          "maxLength": 35,
          "description": "Unique number assigned to payers and beneficiaries to identify incoming payments."
        },
        "status": {
          "title": "status",
          "type": "string",
          "minLength": 1,
          "maxLength": 35,
          "description": "Status of the payer ID."
        },
        "reason": {
          "title": "reason",
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Payer ID status reason."
        },
        "account_details": {
          "title": "account_details",
          "type": "array",
          "maxItems": 20,
          "description": "Identification of account parameter under which the client account, branch code, and instruction currency are to be displayed. Instruction currency cannot be the same for different client account numbers in a single request.",
          "items": {
            "$ref": "#/$defs/Account-Inquiry"
          }
        }
      }
    }
  }
}