Inquiry-Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-inquiry-request-schema.json",
  "title": "Inquiry-Request",
  "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-Request",
  "required": [
    "country_code"
  ],
  "type": "object",
  "properties": {
    "country_code": {
      "type": "string",
      "title": "country_code",
      "pattern": "^[A-Z]{2}$",
      "description": "The ISO country code specifying which country 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<br> 'BR' - Brazil<br> 'JP' - Japan"
    },
    "payerid_number": {
      "title": "payerid_number",
      "type": "string",
      "minLength": 1,
      "maxLength": 35,
      "description": "Unique number assigned for payers and beneficiaries to identify incoming payments. Please provide either the `payerid_number` or the `assignee_id`."
    },
    "assignee_id": {
      "type": "string",
      "title": "assignee_id",
      "minLength": 1,
      "maxLength": 100,
      "description": "Assignee ID expected from client for upfront sanction screening and activation of Payer ID number. Please provide either payerid_number or assignee_id."
    },
    "merchant": {
      "$ref": "#/$defs/Merchant-Details-Inquiry"
    }
  },
  "$defs": {
    "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-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."
        }
      }
    }
  }
}