ValidateMailingAddressPremiumRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/precisely-apis/main/json-schema/precisely-apis-validate-mailing-address-premium-request-schema.json",
  "title": "ValidateMailingAddressPremiumRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/precisely-apis-validatemailingaddresspremium-api-openapi.yml#/components/schemas/ValidateMailingAddressPremiumRequest",
  "properties": {
    "options": {
      "$ref": "#/$defs/ValidateMailingAddressPremiumOptions"
    },
    "Input": {
      "$ref": "#/$defs/ValidateMailingAddressPremiumInput"
    }
  },
  "type": "object",
  "$defs": {
    "GetPostalCodesAPIOutput_user_fields": {
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressPremiumInput": {
      "properties": {
        "Row": {
          "items": {
            "$ref": "#/$defs/ValidateMailingAddressPremiumInputRow"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressPremiumInputRow": {
      "properties": {
        "user_fields": {
          "description": "These fields are returned, unmodified, in the user_fields section of the response.",
          "items": {
            "$ref": "#/$defs/GetPostalCodesAPIOutput_user_fields"
          },
          "type": "array"
        },
        "AddressLine1": {
          "description": "The first address line.",
          "type": "string"
        },
        "AddressLine2": {
          "description": "The second address line.",
          "type": "string"
        },
        "AddressLine3": {
          "description": "The third address line.",
          "type": "string"
        },
        "AddressLine4": {
          "description": "The fourth address line.",
          "type": "string"
        },
        "AddressLine5": {
          "description": "The fifth address line.",
          "type": "string"
        },
        "FirmName": {
          "description": "The company or firm name.",
          "type": "string"
        },
        "City": {
          "description": "The city name.",
          "type": "string"
        },
        "StateProvince": {
          "description": "The state or province.",
          "type": "string"
        },
        "Country": {
          "description": "The country code or name.",
          "type": "string"
        },
        "PostalCode": {
          "description": "The postal code for the address.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressPremiumOptions": {
      "properties": {
        "OutputAddressBlocks": {
          "default": "Y",
          "description": "Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece.",
          "type": "string"
        },
        "KeepMultimatch": {
          "default": "N",
          "description": "Specifies whether to return multiple address for those input addresses that have more than one possible match.",
          "type": "string"
        },
        "OutputCountryFormat": {
          "default": "E",
          "description": "Specifies the format to use for the country name returned in the Country output field.",
          "type": "string"
        },
        "OutputRecordType": {
          "default": "A",
          "description": "Specifies the type of output record you get.",
          "type": "string"
        },
        "OutputFieldLevelReturnCodes": {
          "default": "N",
          "description": "Specifies whether to include field-level result indicators.",
          "type": "string"
        },
        "OutputScript": {
          "default": "InputScript",
          "description": "Specifies the alphabet or script in which the output should be returned.",
          "type": "string"
        },
        "OutputCasing": {
          "default": "M",
          "description": "Specify the casing of the output data.",
          "type": "string"
        },
        "MaximumResults": {
          "default": "10",
          "description": "A number between 1 and 10 that indicates the maximum number of addresses to return.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}