Precisely APIs Address Verification Service API

openapi: 3.2.0
info:
  contact:
    name: Precisely APIs Support
    url: https://support.precisely.com
  description: '

    Demographics. Audience Enrichment. Add local demographics and lifestyle

    segmentation to your audience profiles. The Demographics API returns

    household demographics and lifestyle characteristics with the input of an

    address, location coordinate, or geographic boundary. This service covers

    select countries.'
  license:
    name: Apache 2.0
    url: http://springdoc.org
  termsOfService: http://swagger.io/terms/
  title: Precisely Address  Verification  Service API
  version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
  - ''
tags:
- name: Address  Verification  Service
paths:
  /addressverification/v1/getpostalcodes/results.json:
    post:
      deprecated: false
      description: GetPostalCodes takes a city and state as input for U.S. addresses and returns the postal codes for that city.
      operationId: GetPostalCodes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPostalCodesAPIRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostalCodesAPIResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: GetPostalCodes
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
  /addressverification/v1/getcitystateprovince/results.json:
    post:
      deprecated: false
      description: GetCityStateProvince returns a city and state/province for a given input postal code for U.S. and Canadian addresses.
      operationId: GetCityStateProvince
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCityStateProvinceAPIRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCityStateProvinceAPIResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: GetCityStateProvince
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
  /addressverification/v1/validatemailingaddressuscan/results.json:
    post:
      deprecated: false
      description: ValidateMailingAddressUSCAN analyses and compares the input addresses against the known address databases around the world to output a standardized detail for US and CANADAIt gives RDI and DPV also along with other US/CAN specific functionalities.
      operationId: ValidateMailingAddressUSCAN
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMailingAddressUSCANAPIRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateMailingAddressUSCANAPIResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: ValidateMailingAddressUSCAN
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
  /addressverification/v1/validatemailingaddress/results.json:
    post:
      deprecated: false
      description: ValidateMailingAddress analyses and compares the input addresses against the known address databases around the world to output a standardized detail.
      operationId: ValidateMailingAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMailingAddressRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateMailingAddressResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: ValidateMailingAddress
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
  /addressverification/v1/validatemailingaddresspro/results.json:
    post:
      deprecated: false
      description: ValidateMailingAddressPro builds upon the ValidateMailingAddress service by using additional address databases so it can provide enhanced detail.
      operationId: ValidateMailingAddressPro
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMailingAddressProRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateMailingAddressProResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: ValidateMailingAddressPro
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
  /addressverification/v1/validatemailingaddresspremium/results.json:
    post:
      deprecated: false
      description: ValidateMailing AddressPremium expands on the ValidateMailingAddressPro service by adding premium address data sources to get the best address validation result possible.
      operationId: ValidateMailingAddressPremium
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMailingAddressPremiumRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateMailingAddressPremiumResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: ValidateMailingAddressPremium
      tags:
      - Address  Verification  Service
      x-codegen-request-body-name: InputAddress
      x-contentType: application/json
      x-accepts: application/json
components:
  schemas:
    GetPostalCodesAPIInput:
      example:
        Row:
        - user_fields:
          - name: name
            value: value
          - name: name
            value: value
          StateProvince: StateProvince
          City: City
        - user_fields:
          - name: name
            value: value
          - name: name
            value: value
          StateProvince: StateProvince
          City: City
      properties:
        Row:
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIInputRow'
          type: array
      type: object
    ValidateMailingAddressProInputRow:
      example:
        AddressLine2: AddressLine2
        AddressLine1: AddressLine1
        user_fields:
        - name: name
          value: value
        - name: name
          value: value
        FirmName: FirmName
        StateProvince: StateProvince
        Country: Country
        PostalCode: PostalCode
        City: City
      properties:
        user_fields:
          description: These fields are returned, unmodified, in the user_fields section of the response.
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput_user_fields'
          type: array
        AddressLine1:
          description: The first address line.
          type: string
        AddressLine2:
          description: The second 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
    ErrorInfo:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ErrorCode'
          type: array
          xml:
            name: error
      type: object
      xml:
        name: errors
    GetCityStateProvinceAPIOutput:
      example:
        Status: Status
        user_fields:
        - name: name
          value: value
        - name: name
          value: value
        StateProvince: StateProvince
        PostalCode: PostalCode
        Status.Description: Status.Description
        City: City
        Status.Code: Status.Code
        City.Type: City.Type
      properties:
        user_fields:
          description: These fields are returned, unmodified, in the user_fields section of the response.
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput_user_fields'
          type: array
        PostalCode:
          description: The validated ZIP Code or postal code.
          type: string
        City:
          description: City
          type: string
        City.Type:
          description: City.Type
          type: string
        StateProvince:
          description: The state or province.
          type: string
        Status:
          description: Reports the success or failure of the match attempt.
          type: string
        Status.Code:
          description: Reason for failure, if there is one.
          type: string
        Status.Description:
          description: Description of the problem, if there is one.
          type: string
      type: object
    ValidateMailingAddressProOutput:
      example:
        Status: Status
        BlockAddress: BlockAddress
        FirmName: FirmName
        Suburb: Suburb
        Locality: Locality
        StateProvince: StateProvince
        AddressQuality: AddressQuality
        PostalCode: PostalCode
        City: City
        Status.Code: Status.Code
        CouldNotValidate: CouldNotValidate
        Deliverability: Deliverability
        AdditionalInputData: AdditionalInputData
        AddressLine2: AddressLine2
        AddressLine1: AddressLine1
        PostalCode.Base: PostalCode.Base
        user_fields:
        - name: name
          value: value
        - name: name
          value: value
        ChangeScore: ChangeScore
        Country: Country
        Status.Description: Status.Description
        AddressType: AddressType
        PostalCode.AddOn: PostalCode.AddOn
      properties:
        user_fields:
          description: These fields are returned, unmodified, in the user_fields section of the response.
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput_user_fields'
          type: array
        AddressLine1:
          description: The first line of the validated address.
          type: string
        AddressLine2:
          description: The second line of the validated address.
          type: string
        FirmName:
          description: The validated firm or company name.
          type: string
        ChangeScore:
          description: A value of 0 and 100 that reflects how much the address has changed to make it valid.
          type: string
        Locality:
          description: Generally a locality is a village in rural areas or it may be a suburb in urban areas.
          type: string
        Suburb:
          description: The suburb name.
          type: string
        AddressType:
          description: A single letter code that indicates the type of address.
          type: string
        Deliverability:
          description: An estimate of confidence that an item mailed or shipped to this address would be successfully delivered.
          type: string
        AddressQuality:
          description: A two character code indicating overall quality of the resulting address.
          type: string
        CouldNotValidate:
          description: Mentions the address component that could not be validated, in case no match is found.
          type: string
        City:
          description: The validated city name.
          type: string
        PostalCode:
          description: The validated ZIP Code or postal code.
          type: string
        Country:
          description: The country in the format determined by what you selected.
          type: string
        StateProvince:
          description: The validated state or province abbreviation.
          type: string
        BlockAddress:
          description: The formatted address, as it would appear on a physical mail piece.
          type: string
        AdditionalInputData:
          description: Input data that could not be matched to a particular address component.
          type: string
        PostalCode.Base:
          description: The 5-digit ZIP Code.
          type: string
        PostalCode.AddOn:
          description: The 4-digit add-on part of the ZIP Code.
          type: string
        Status:
          description: Reports the success or failure of the match attempt.
          type: string
        Status.Code:
          description: Reason for failure, if there is one.
          type: string
        Status.Description:
          description: Description of the problem, if there is one.
          type: string
      type: object
    ValidateMailingAddressProRequest:
      example:
        Input:
          Row:
          - AddressLine2: AddressLine2
            AddressLine1: AddressLine1
            user_fields:
            - name: name
              value: value
            - name: name
              value: value
            FirmName: FirmName
            StateProvince: StateProvince
            Country: Country
            PostalCode: PostalCode
            City: City
          - AddressLine2: AddressLine2
            AddressLine1: AddressLine1
            user_fields:
            - name: name
              value: value
            - name: name
              value: value
            FirmName: FirmName
            StateProvince: StateProvince
            Country: Country
            PostalCode: PostalCode
            City: City
        options:
          OutputCasing: M
          OutputAddressBlocks: Y
          OutputCountryFormat: E
          OutputScript: InputScript
          KeepMultimatch: N
          MaximumResults: '10'
      properties:
        options:
          $ref: '#/components/schemas/ValidateMailingAddressProOptions'
        Input:
          $ref: '#/components/schemas/ValidateMailingAddressProInput'
      type: object
    GetPostalCodesAPIResponse:
      example:
        Output:
        - Status: Status
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          PostalCode: PostalCode
          Status.Description: Status.Description
          Status.Code: Status.Code
          City.Type: City.Type
        - Status: Status
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          PostalCode: PostalCode
          Status.Description: Status.Description
          Status.Code: Status.Code
          City.Type: City.Type
      properties:
        Output:
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput'
          type: array
      type: object
    ValidateMailingAddressPremiumInput:
      example:
        Row:
        - AddressLine3: AddressLine3
          AddressLine2: AddressLine2
          AddressLine1: AddressLine1
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          FirmName: FirmName
          AddressLine5: AddressLine5
          StateProvince: StateProvince
          AddressLine4: AddressLine4
          Country: Country
          PostalCode: PostalCode
          City: City
        - AddressLine3: AddressLine3
          AddressLine2: AddressLine2
          AddressLine1: AddressLine1
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          FirmName: FirmName
          AddressLine5: AddressLine5
          StateProvince: StateProvince
          AddressLine4: AddressLine4
          Country: Country
          PostalCode: PostalCode
          City: City
      properties:
        Row:
          items:
            $ref: '#/components/schemas/ValidateMailingAddressPremiumInputRow'
          type: array
      type: object
    ValidateMailingAddressResponse:
      example:
        Output:
        - Status: Status
          BlockAddress: BlockAddress
          FirmName: FirmName
          StateProvince: StateProvince
          PostalCode: PostalCode
          City: City
          Status.Code: Status.Code
          AdditionalInputData: AdditionalInputData
          AddressLine2: AddressLine2
          AddressLine1: AddressLine1
          PostalCode.Base: PostalCode.Base
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          Country: Country
          Status.Description: Status.Description
          PostalCode.AddOn: PostalCode.AddOn
        - Status: Status
          BlockAddress: BlockAddress
          FirmName: FirmName
          StateProvince: StateProvince
          PostalCode: PostalCode
          City: City
          Status.Code: Status.Code
          AdditionalInputData: AdditionalInputData
          AddressLine2: AddressLine2
          AddressLine1: AddressLine1
          PostalCode.Base: PostalCode.Base
          user_fields:
          - name: name
            value: value
          - name: name
            value: value
          Country: Country
          Status.Description: Status.Description
          PostalCode.AddOn: PostalCode.AddOn
      properties:
        Output:
          items:
            $ref: '#/components/schemas/ValidateMailingAddressOutput'
          type: array
      type: object
    GetCityStateProvinceAPIInput:
      example:
        Row:
        - user_fields:
          - name: name
            value: value
          - name: name
            value: value
          PostalCode: PostalCode
        - user_fields:
          - name: name
            value: value
          - name: name
            value: value
          PostalCode: PostalCode
      properties:
        Row:
          items:
            $ref: '#/components/schemas/GetCityStateProvinceAPIInputRow'
          type: array
      type: object
    GetPostalCodesAPIOutput:
      example:
        Status: Status
        user_fields:
        - name: name
          value: value
        - name: name
          value: value
        PostalCode: PostalCode
        Status.Description: Status.Description
        Status.Code: Status.Code
        City.Type: City.Type
      properties:
        user_fields:
          description: These fields are returned, unmodified, in the user_fields section of the response.
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput_user_fields'
          type: array
        PostalCode:
          description: The validated ZIP Code or postal code.
          type: string
        City.Type:
          description: City.Type
          type: string
        Status:
          description: Reports the success or failure of the match attempt.
          type: string
        Status.Code:
          description: Reason for failure, if there is one.
          type: string
        Status.Description:
          description: Description of the problem, if there is one.
          type: string
      type: object
    GetPostalCodesAPIOptions:
      example:
        OutputVanityCity: N
        OutputCityType: N
      properties:
        OutputCityType:
          default: N
          description: Output CityType.
          type: string
        OutputVanityCity:
          default: N
          description: Output VanityCity.
          type: string
      type: object
    ValidateMailingAddressPremiumOutput:
      example:
        StreetName: StreetName
        ApartmentLabel2.Result: ApartmentLabel2.Result
        POBox.Input: POBox.Input
        Suburb: Suburb
        Country.Input: Country.Input
        RRHC.Input: RRHC.Input
        TrailingDirectional: TrailingDirectional
        Latitude: Latitude
        Street.Result: Street.Result
        PrivateMailbox: PrivateMailbox
        PrivateMailbox.Input: PrivateMailbox.Input
        StreetSuffix: StreetSuffix
        PostalCode.Base: PostalCode.Base
        user_fields:
        - name: name
          value: value
        - name: name
          value: value
        Confidence: Confidence
        StreetName.Input: StreetName.Input
        LeadingDirectional: LeadingDirectional
        FirmName.Input: FirmName.Input
        RRHC: RRHC
        Status: Status
        PostalCode.Result: PostalCode.Result
        StateProvince.Input: StateProvince.Input
        FirmName: FirmName
        Country.Result: Country.Result
        StreetName.Alias.Type: StreetName.Alias.Type
        ApartmentLabel.Result: ApartmentLabel.Result
        Locality: Locality
        StateProvince: StateProvince
        LeadingDirectional.Input: LeadingDirectional.Input
        CountryLevel: CountryLevel
        AddressQuality: AddressQuality
        City: City
        CouldNotValidate: CouldNotValidate
        Longitude: Longitude
        PostalCode.Type: PostalCode.Type
        AddressLine3: AddressLine3
        StateProvince.Result: StateProvince.Result
        AddressLine2: AddressLine2
        AddressLine1: AddressLine1
        TrailingDirectional.Result: TrailingDirectional.Result
        AddressLine5: AddressLine5
        AddressLine4: AddressLine4
        HouseNumber.Input: HouseNumber.Input
        Country: Country
        HouseNumber.Result: HouseNumber.Result
        ChangeScore: ChangeScore
        Status.Description: Status.Description
        ApartmentNumber2: ApartmentNumber2
        LeadingDirectional.Result: LeadingDirectional.Result
        PostalCode.AddOn: PostalCode.AddOn
        POBox: POBox
        TrailingDirectional.Input: TrailingDirectional.Input
        StreetSuffix.Result: StreetSuffix.Result
        ApartmentNumber2.Result: ApartmentNumber2.Result
        HouseNumber: HouseNumber
        StreetName.Result: StreetName.Result
        FirmName.Result: FirmName.Result
        BlockAddress: BlockAddress
        ApartmentLabel: ApartmentLabel
        ApartmentLabel.Input: ApartmentLabel.Input
        PostalCode: PostalCode
        ApartmentNumber: ApartmentNumber
        AdditionalInputData: AdditionalInputData
        POBox.Result: POBox.Result
        PrivateMailbox.Type.Input: PrivateMailbox.Type.Input
        PostalCodeCity.Result: PostalCodeCity.Result
        RecordType: RecordType
        PrivateMailbox.Type: PrivateMailbox.Type
        ApartmentNumber.Result: ApartmentNumber.Result
        RRHC.Result: RRHC.Result
        StreetNamePreferredAlias.Result: StreetNamePreferredAlias.Result
        ApartmentNumber.Input: ApartmentNumber.Input
        AddressRecord.Result: AddressRecord.Result
        City.Input: City.Input
        ApartmentLabel2: ApartmentLabel2
        StreetSuffix.Input: StreetSuffix.Input
        PostalCode.Input: PostalCode.Input
        AddressFormat: AddressFormat
        PostalCode.Source: PostalCode.Source
        Status.Code: Status.Code
        Deliverability: Deliverability
        StreetNameAbbreviatedAlias.Result: StreetNameAbbreviatedAlias.Result
        RRHC.Type: RRHC.Type
        City.Result: City.Result
        AddressType: AddressType
        RecordType.Default: RecordType.Default
        MultipleMatches: MultipleMatches
      properties:
        user_fields:
          description: These fields are returned, unmodified, in the user_fields section of the response.
          items:
            $ref: '#/components/schemas/GetPostalCodesAPIOutput_user_fields'
          type: array
        Status:
          description: Reports the success or failure of the match attempt.
          type: string
        Status.Code:
          description: Reason for failure, if there is one.
          type: string
        Status.Description:
          description: Description of the problem, if there is one.
          type: string
        Confidence:
          description: The level of confidence assigned to the address being returned.
          type: string
        RecordType:
          description: Type of address record.
          type: string
        RecordType.Default:
          description: Code indicating the default match.
          type: string
        MultipleMatches:
          description: Indicates which address component had multiple matches.
          type: string
        CouldNotValidate:
          description: Mentions the address component that could not be validated, in case no match is found.
          type: string
        CountryLevel:
          description: The category of address matching available.
          type: string
        AddressFormat:
          description: The type of address data being returned.
          type: string
        AddressLine1:
          description: The first line of the validated address.
          type: string
        AddressLine2:
          description: The second line of the validated address.
          type: string
        AddressLine3:
          description: The third line of the validated address.
          type: string
        AddressLine4:
          description: The fourth line of the validated address.
          type: string
        City:
          description: The validated city name.
          type: string
        StateProvince:
          description: The validated state or province abbreviation.
          type: string
        PostalCode:
          description: The validated ZIP Code or postal code.
          type: string
        PostalCode.Base:
          description: The 5-digit ZIP Code.
          type: string
        PostalCode.AddOn:
          description: The 4-digit add-on part of the ZIP Code.
          type: string
        Country:
          description: The country in the format determined by what you selected.
          type: string
        AdditionalInputData:
          description: Input data that could not be matched to a particular address component.
          type: string
        FirmName:
          description: The validated firm or company name.
          type: string
        HouseNumber:
          description: House number.
          type: string
        LeadingDirectional:
          description: Leading directional.
          type: string
        StreetName:
          description: Street name.
          type: string
        StreetSuffix:
          description: Street suffix.
          type: string
        TrailingDirectional:
          description: Trailing directional.
          type: string
        ApartmentLabel:
          description: Apartment designator (such as STE or APT).
          type: string
        ApartmentNumber:
          description: Apartment number.
          type: string
        ApartmentLabel2:
          description: Secondary apartment designator.
          type: string
        ApartmentNumber2:
          description: Secondary apartment number.
          type: string
        RRHC:
          description: Rural Route/Highway Contract indicator.
          type: string
        POBox:
          description: Post office box number.
          type: string
        PrivateMailbox:
          description: Private mailbox indicator.
          type: string
        PrivateMailbox.Type:
          description: The type of private mailbox.
          type: string
        HouseNumber.Input:
          description: House number.
          type: string
        LeadingDirectional.Input:
          description: Leading directional.
          type: string
        StreetName.Input:
          description: Street name.
          type: string
        StreetSuffix.Input:
          description: Street suffix.
          type: string
        TrailingDirectional.Input:
          description: Trailing directional.
          type: string
        ApartmentLabel.Input:
          description: Apartment designator (such as STE or APT).
          type: string
        ApartmentNumber.Input:
          description: Apartment number.
          type: string
        RRHC.Input:
          description: Rural Route/Highway Contract indicator.
          type: string
        POBox.Input:
          description: Post office box number.
          type: string
        PrivateMailbox.Input:
          description: Private mailbox indicator.
          type: string
        PrivateMailbox.Type.Input:
          description: The type of private mailbox.
          type: string
        City.Input:
          description: Validated city name.
          type: string
        StateProvince.Input:
          description: Validated state or province name.
          type: string
        PostalCode.Input:
          description: Validated postal code.
          type: string
        Country.Input:
          description: Country. Format is determined by what you selected in OutputCountryFormat.
          type: string
        FirmName.Input:
          description: The validated firm or company name.
          type:

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/precisely-apis/refs/heads/main/openapi/precisely-apis-address-verification-service-api-openapi.yml