ValidateMailingAddressUSCANAPIRequest

{
  "$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-uscanapirequest-schema.json",
  "title": "ValidateMailingAddressUSCANAPIRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/precisely-apis-validatemailingaddressuscan-api-openapi.yml#/components/schemas/ValidateMailingAddressUSCANAPIRequest",
  "properties": {
    "options": {
      "$ref": "#/$defs/ValidateMailingAddressUSCANAPIOptions"
    },
    "Input": {
      "$ref": "#/$defs/ValidateMailingAddressUSCANAPIInput"
    }
  },
  "type": "object",
  "$defs": {
    "GetPostalCodesAPIOutput_user_fields": {
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressUSCANAPIInput": {
      "properties": {
        "Row": {
          "items": {
            "$ref": "#/$defs/ValidateMailingAddressUSCANAPIInputRow"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressUSCANAPIInputRow": {
      "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"
        },
        "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"
        },
        "USUrbanName": {
          "description": "U.S. address urbanization name. Used primarily for Puerto Rico addresses.",
          "type": "string"
        },
        "CanLanguage": {
          "description": "Canadian language.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ValidateMailingAddressUSCANAPIOptions": {
      "properties": {
        "OutputAddressBlocks": {
          "default": "Y",
          "description": "Specifies whether to return a formatted version of the address.",
          "type": "string"
        },
        "PerformUSProcessing": {
          "default": "Y",
          "description": "Specifies whether or not to process U.S. addresses.",
          "type": "string"
        },
        "PerformDPV": {
          "default": "N",
          "description": "Delivery Point Validation (DPV�) validates that a specific address exists",
          "type": "string"
        },
        "OutputFormattedOnFail": {
          "default": "N",
          "description": "Specifies whether to return a formatted address when an address cannot be validated.",
          "type": "string"
        },
        "OutputPostalCodeSeparator": {
          "default": "Y",
          "description": "Specifies whether to use separators (spaces or hyphens) in ZIP\" Codes or Canadian postal codes.",
          "type": "string"
        },
        "OutputCountryFormat": {
          "default": "E",
          "description": "Specifies the format to use for the country name returned in the Country output field.",
          "type": "string"
        },
        "KeepMultimatch": {
          "default": "N",
          "description": "Indicates whether to return multiple address for input addresses that have more than one possible matches.",
          "type": "string"
        },
        "OutputCasing": {
          "default": "M",
          "description": "Specifies the casing of the output address. M for mixed case and U for upper case.",
          "type": "string"
        },
        "MaximumResults": {
          "default": "10",
          "description": "Specifies a number between 1 and 10 that indicates the maximum number of addresses to be returned.",
          "type": "string"
        },
        "OutputRecordType": {
          "default": "A",
          "description": "Specifies the type of the output record.",
          "type": "string"
        },
        "OutputFieldLevelReturnCodes": {
          "default": "N",
          "description": "Identifies which output addresses are candidate addresses as value if Y for OutputFieldLevelReturnCodes.",
          "type": "string"
        },
        "DPVDetermineNoStat": {
          "default": "N",
          "description": "Determines the no stat status of an address which means it exists but cannot receive mails.",
          "type": "string"
        },
        "StreetMatchingStrictness": {
          "default": "M",
          "description": "Specifies the algorithm to determe if an input address matches in the postal database.",
          "type": "string"
        },
        "CanFrenchApartmentLabel": {
          "default": "Appartement",
          "description": "Specifies the default apartment label for the output if there is no apartment label in the input address. This is specific to French address. ",
          "type": "string"
        },
        "OutputAbbreviatedAlias": {
          "default": "N",
          "description": "Specifies whether to use a street's abbreviated alias in the output if the output address line is longer than 31 characters.",
          "type": "string"
        },
        "DPVSuccessfulStatusCondition": {
          "default": "A",
          "description": "Selecting the match condition where a DPV result does NOT cause a record to fail.",
          "type": "string"
        },
        "StandardAddressPMBLine": {
          "default": "N",
          "description": "Specifies where Private Mailbox (PMB) information is placed.",
          "type": "string"
        },
        "FirmMatchingStrictness": {
          "default": "M",
          "description": "Specifies the algorithm to determining if an input address matches in the postal database.",
          "type": "string"
        },
        "CanRuralRouteFormat": {
          "default": "A",
          "description": "Specifies where to place rural route delivery information.",
          "type": "string"
        },
        "CanPreferHouseNum": {
          "default": "N",
          "description": "Specifies whether to select a house number of postal code in case of conflict.",
          "type": "string"
        },
        "OutputPreferredAlias": {
          "default": "N",
          "description": "Specifies whether to use a street's preferred alias in the output.",
          "type": "string"
        },
        "DirectionalMatchingStrictness": {
          "default": "M",
          "description": "Specifies the algorithm to determine if an input address matches in the postal database.",
          "type": "string"
        },
        "ExtractFirm": {
          "default": "N",
          "description": "Specifies whether to extract the firm name from AddressLine1 through AddressLine4 and place it in the FirmName output field.",
          "type": "string"
        },
        "FailOnCMRAMatch": {
          "default": "N",
          "description": "Specifies whether to consider Treat Commercial Mail Receiving Agency (CMRA) matches as failures?",
          "type": "string"
        },
        "CanNonCivicFormat": {
          "default": "A",
          "description": "Specifies whether or not non-civic keywords are abbreviated in the output. ",
          "type": "string"
        },
        "CanSSLVRFlg": {
          "default": "N",
          "description": "Changes the civic and/or suite information to match the LVR or single-single record.",
          "type": "string"
        },
        "OutputStreetNameAlias": {
          "default": "Y",
          "description": "Specifies how to handle street name aliases used in the input. This is specific to US.",
          "type": "string"
        },
        "PerformEWS": {
          "default": "N",
          "description": "Specifies the Early Warning System (EWS) that uses the USPS EWS File to validate addresses that are not in the ZIP + 4 database.",
          "type": "string"
        },
        "CanOutputCityFormat": {
          "default": "D",
          "description": "Specifies whether to use the long, medium, or short version of the city if the city has a long name.",
          "type": "string"
        },
        "DualAddressLogic": {
          "default": "N",
          "description": "Specifies how to return a match if multiple non-blank address lines are present or multiple address types are on the same address line. (U.S. addresses only.)",
          "type": "string"
        },
        "PerformSuiteLink": {
          "default": "N",
          "description": "Specifies whether to perform SuiteLink processing.",
          "type": "string"
        },
        "CanStandardAddressFormat": {
          "default": "D",
          "description": "Specifies where to place secondary address information in the output address.",
          "type": "string"
        },
        "OutputPreferredCity": {
          "default": "Z",
          "description": "Specifies whether the preferred last line city name should be stored.",
          "type": "string"
        },
        "OutputMultinationalCharacters": {
          "default": "N",
          "description": "Specifies whether to return multinational characters, including diacritical marks such as umlauts or accents.",
          "type": "string"
        },
        "CanDeliveryOfficeFormat": {
          "default": "I",
          "description": "Specifies where to place station information.",
          "type": "string"
        },
        "PerformLACSLink": {
          "default": "Y",
          "description": "Facilitates the conversion of rural route address converting into street-style address using the LACS.",
          "type": "string"
        },
        "CanDualAddressLogic": {
          "default": "D",
          "description": "Specifies whether ValidateMailingAddressUSCAN should return a street match or a PO Box/non-civic match when the address contains both civic and non-civic information.",
          "type": "string"
        },
        "ExtractUrb": {
          "default": "N",
          "description": "Specifies whether to extract the urbanization name from AddressLine1 through AddressLine4 and place it in the USUrbanName output field. ",
          "type": "string"
        },
        "StandardAddressFormat": {
          "default": "C",
          "description": "Specifies where to place secondary address information for U.S. addresses.",
          "type": "string"
        },
        "CanFrenchFormat": {
          "default": "C",
          "description": "Specifies how to determine the language (English or French) to use to format the address and directional.",
          "type": "string"
        },
        "DPVDetermineVacancy": {
          "default": "N",
          "description": "Determines if the location has been unoccupied for at least 90 days.",
          "type": "string"
        },
        "CanEnglishApartmentLabel": {
          "default": "Apt",
          "description": "Specifies the default apartment label to use in the output if there is no apartment label in the input address. rhis is specific to English addresses.",
          "type": "string"
        },
        "SuppressZplusPhantomCarrierR777": {
          "default": "N",
          "description": "Specifies whether to supress addresses with Carrier Route R777.",
          "type": "string"
        },
        "CanOutputCityAlias": {
          "default": "N",
          "description": "Specifies whether or not to return the city alias when the alias is in the input address.",
          "type": "string"
        },
        "OutputShortCityName": {
          "default": "N",
          "description": "Specifies how to format city names that have short city name or non-mailing city name alternatives.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}