openapi: 3.0.0
info:
  title: SAP DQM API
  description: >-
    SAP Data Quality Management for location data offers cloud-based services
    that let you embed address cleansing, geocoding, and reverse geocoding
    within any business process or application, so that you can reap the value
    of complete and accurate address data.
  version: '1'
  x-sap-version: '2205.1'
  contact:
    name: SAP Data Quality Management
    url: https://www.sap.com/products/data-quality-management.html
    email: data_quality_microservice@sap.com
security:
  - oauth2Authentication: []
externalDocs:
  description: SAP Data Quality Management, microservices for location data
  url: >-
    https://help.sap.com/viewer/d95546360fea44988eb614718ff7e959/Cloud/en-US/f62493dd5d824c748e337257c87e2459.html
paths:
  /data-curation/rest/v2/businesspartners/curate:
    post:
      summary: Curate Business Partner
      description: >
        The endpoint parses, standardizes, corrects, validates, and enhances
        address data. Address cleansing also includes geocode processing
        automatically when you request at least one geocode-related field.


        See
        https://help.sap.com/viewer/d95546360fea44988eb614718ff7e959/Cloud/en-US/0d5cdf3b816e45ddb03fe3b425886431.html
        for details.
      tags:
        - Business Partners
      parameters:
        - $ref: '#/components/parameters/headerContentType'
        - $ref: '#/components/parameters/headerAuthorization'
        - $ref: '#/components/parameters/headerAccept'
        - $ref: '#/components/parameters/headerAcceptLanguage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurationRequest'
        description: Address data and settings.
      responses:
        '200':
          description: Address cleanse results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationResponse'
              examples:
                response:
                  value:
                    std_addr_locality_full: Newtown Sq
                    addr_longitude: -75.416103
                    addr_info_code_msg: ''
                    addr_info_code: ''
                    std_addr_postcode_full: 19073-2305
                    geo_asmt_level: PRE
                    addr_asmt_level: PR
                    addr_latitude: 39.985662
                    geo_info_code: ''
                    std_addr_region_full: PA
                    std_addr_address_delivery: 3999 W Chester Pike
                    std_addr_country_2char: US
                    geo_info_code_msg: ''
            text/plain:
              schema:
                $ref: '#/components/schemas/CurationResponse'
        '400':
          description: >-
            Bad request. The user needs to change something before the request
            can be successful.
          content:
            application/json:
              schema:
                type: string
                description: Error message.
                example: ' '
            text/plain:
              schema:
                type: string
                description: Error message.
                example: ' '
              examples:
                response:
                  value: >-
                    The addressInput object has an invalid property name
                    country. Check the spelling and mapping of this property
                    name.
        '401':
          description: Unauthorized. Authorization failed.
        '403':
          description: Forbidden. You are not allowed to process the request.
        '500':
          description: >-
            Internal server error. The request could not be processed. Try
            again.
        '503':
          description: >-
            Service unavailable. The required service is not currently
            available. Try again.
  /data-curation/rest/v2/businesspartners/curate/bulks:
    post:
      summary: Bulk Curation
      description: Curate multiple business partners at a time.
      tags:
        - Business Partners
      parameters:
        - $ref: '#/components/parameters/headerContentType'
        - $ref: '#/components/parameters/headerAuthorization'
        - $ref: '#/components/parameters/headerAccept'
        - $ref: '#/components/parameters/headerAcceptLanguage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurationBulkRequest'
        description: Bulk address data and settings.
      responses:
        '200':
          description: Bulk address cleanse results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationBulkResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/CurationBulkResponse'
        '400':
          description: >-
            Bad request. The user needs to change something before the request
            can be successful.
          content:
            application/json:
              schema:
                type: string
                description: Error message.
                example: Bad Request
            text/plain:
              schema:
                type: string
                description: Error message.
                example: Bad Request
              examples:
                response:
                  value: >-
                    The addressInput object has an invalid property name
                    country. Check the spelling and mapping of this property
                    name.
        '401':
          description: Unauthorized. Authorization failed.
        '403':
          description: Forbidden. You are not allowed to process the request.
        '500':
          description: >-
            Internal server error. The request could not be processed. Try
            again.
        '503':
          description: >-
            Service unavailable. The required service is not currently
            available. Try again.
x-sap-shortText: Embed data quality services to validate addresses and enrich with geocodes.
servers:
  - url: https://api.cdq.com/sapdqm/v1
components:
  parameters:
    headerContentType:
      name: Content-Type
      description: Media type
      in: header
      required: true
      schema:
        type: string
        default: application/json
    headerAuthorization:
      name: Authorization
      description: Access Token
      in: header
      required: false
      schema:
        type: string
        default: Contains the OAuth token when using OAuth client.
    headerAccept:
      name: Accept
      description: Media type to use for the response.
      in: header
      required: false
      schema:
        type: string
        default: text/tab-separated-values
    headerAcceptLanguage:
      name: Accept-Language
      description: Language to use for informational messages in the response.
      in: header
      required: false
      schema:
        type: string
        default: ''
  securitySchemes:
    oauth2Authentication:
      type: oauth2
      description: REST API supports OAUTH2 Authentication
      flows:
        clientCredentials:
          tokenUrl: >-
            https://{cf-subaccount-subdomain}.authentication.eu10.hana.ondemand.com/oauth/token
          scopes:
            DQMMICRO_POWERUSER: allows processing
  schemas:
    CurationRequest:
      type: object
      description: Address data and settings.
      properties:
        addressInput:
          $ref: '#/components/schemas/CurationRequestAddressInput'
        addressSettings:
          $ref: '#/components/schemas/CurationRequestAddressSettings'
        outputFields:
          $ref: '#/components/schemas/CurationRequestOutputFields'
        configurationName:
          type: string
          description: Deprecated. Please use configurationId instead.
          example: ' '
        configurationId:
          type: string
          description: Configuration ID.
          example: '123456789'
        generateSuggestionList:
          type: boolean
          description: Generate suggestion list.
          example: 'false'
          default: false
        generateCountrySuggestionList:
          type: boolean
          description: Generate country suggestion list.
          example: 'false'
          default: false
        generateTypeAheadSuggestionList:
          type: boolean
          description: Generate type-ahead suggestion list.
          example: 'false'
          default: false
        suggestionReply:
          type: array
          description: Suggestion reply.
          items:
            type: string
            description: Suggestion reply.
            example: ' '
      example:
        addressInput:
          country: US
          mixed: 3999 WEST CHESTER PIKE
          locality: NEWTOWN
          region: PENNSYLVANIA
          postcode: ''
        outputFields:
          - std_addr_address_delivery
          - std_addr_locality_full
          - std_addr_region_full
          - std_addr_postcode_full
          - std_addr_country_2char
          - addr_latitude
          - addr_longitude
          - addr_asmt_level
          - addr_info_code
          - addr_info_code_msg
          - geo_asmt_level
          - geo_info_code
          - geo_info_code_msg
        addressSettings:
          casing: mixed
          diacritics: include
          streetFormat: countryCommonStyle
          postalFormat: countryCommonStyle
          regionFormat: countryCommonStyle
          scriptConversion: none
    CurationRequestAddressInput:
      type: object
      description: Address data.
      properties:
        CITY1:
          type: string
          maxLength: 256
          x-contentType: LOCALITY
          description: Primary city name.
          example: Newtown
        CITY2:
          type: string
          maxLength: 256
          x-contentType: LOCALITY
          description: Secondary city name.
          example: Chester
        HOME_CITY:
          type: string
          maxLength: 256
          x-contentType: LOCALITY
          description: Home city name.
          example: Newtown
        REGION:
          type: string
          maxLength: 256
          x-contentType: REGION
          description: Primary region name.
          example: Pennsylvania
        REGION2:
          type: string
          maxLength: 256
          x-contentType: REGION
          description: Secondary region name.
          example: Delaware
        POST_CODE1:
          type: string
          maxLength: 256
          x-contentType: POSTCODE
          description: Primary address postcode.
          example: '19073'
        COUNTRY:
          type: string
          maxLength: 256
          x-contentType: COUNTRY
          description: Country name.
          example: United States
        mixed:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 1.
          example: ' '
        mixed2:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 2.
          example: ' '
        mixed3:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 3.
          example: ' '
        mixed4:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 4.
          example: ' '
        mixed5:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 5.
          example: ' '
        mixed6:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 6.
          example: ' '
        mixed7:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 7.
          example: ' '
        mixed8:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 8.
          example: ' '
        mixed9:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 9.
          example: ' '
        mixed10:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 10.
          example: ' '
        mixed11:
          type: string
          maxLength: 256
          x-contentType: ADDRESS
          description: Address line 11.
          example: ' '
        STREET:
          type: string
          maxLength: 256
          description: Street name.
          example: West Chester Pike
        HOUSE_NUM1:
          type: string
          maxLength: 256
          description: Primary house number.
          example: '3999'
        HOUSE_NUM2:
          type: string
          maxLength: 256
          description: Secondary house number.
          example: ' '
        FLOOR:
          type: string
          maxLength: 256
          description: Floor number.
          example: '2'
        ROOMNUMBER:
          type: string
          maxLength: 256
          description: Room number.
          example: '34'
        BUILDING:
          type: string
          maxLength: 256
          description: Building name.
          example: ' '
        STR_SUPPL1:
          type: string
          maxLength: 256
          description: Delivery address 1.
          example: ' '
        STR_SUPPL2:
          type: string
          maxLength: 256
          description: Delivery address 2.
          example: ' '
        STR_SUPPL3:
          type: string
          maxLength: 256
          description: Delivery address 3.
          example: ' '
        LOCATION:
          type: string
          maxLength: 256
          description: Location name.
          example: ' '
        PO_BOX:
          type: string
          maxLength: 256
          description: Post office box number.
          example: ' '
        PO_BOX_LOC:
          type: string
          maxLength: 256
          description: Post office box location.
          example: ' '
        PO_BOX_REG:
          type: string
          maxLength: 256
          description: Post office box region.
          example: ' '
        PO_BOX_REG2:
          type: string
          maxLength: 256
          description: Post office box secondary region.
          example: ' '
        PO_BOX_LOBBY:
          type: string
          maxLength: 256
          description: Post office box lobby.
          example: ' '
        POST_CODE2:
          type: string
          maxLength: 256
          description: Secondary address postcode.
          example: '2305'
        PO_BOX_CTY:
          type: string
          maxLength: 256
          description: Post office box city.
          example: ' '
    CurationRequestAddressSettings:
      type: object
      description: Address settings.
      properties:
        casing:
          type: string
          description: Casing of the address.
          example: mixed
          default: mixed
          enum:
            - mixed
            - upper
          x-enumDescriptions:
            mixed: Mixed case.
            upper: Uppercase.
        diacritics:
          type: string
          description: Diacritics of the address.
          example: include
          default: include
          enum:
            - include
            - remove
          x-enumDEscriptions:
            include: Include diacritics.
            remove: Remove diacritics.
        scriptConversion:
          type: string
          description: Script conversion of the address.
          example: none
          default: none
          enum:
            - none
            - convertToLatin
          x-enumDescriptions:
            none: No script conversion.
            convertToLatin: Convert to Latin script.
        streetFormat:
          type: string
          description: Street format of the address.
          example: countryCommonStyle
          default: countryCommonStyle
          enum:
            - countryCommonStyle
            - abbreviateNoPunctuation
            - abbreviateWithPunctuation
            - expand
            - expandPrimaryAbbreviateSecondaryNoPunctuation
            - expandPrimaryAbbreviateSecondaryWithPunctuation
          x-enumDescriptions:
            countryCommonStyle: Country common style.
            abbreviateNoPunctuation: Abbreviate without punctuation.
            abbreviateWithPunctuation: Abbreviate with punctuation.
            expand: Expand.
            expandPrimaryAbbreviateSecondaryNoPunctuation: Expand primary, abbreviate secondary without punctuation.
            expandPrimaryAbbreviateSecondaryWithPunctuation: Expand primary, abbreviate secondary with punctuation.
        postalFormat:
          type: string
          description: Postal format of the address.
          example: countryCommonStyle
          default: countryCommonStyle
          enum:
            - countryCommonStyle
            - abbreviateNoPunctuation
            - abbreviateWithPunctuation
            - expand
          x-enumDescriptions:
            countryCommonStyle: Country common style.
            abbreviateNoPunctuation: Abbreviate without punctuation.
            abbreviateWithPunctuation: Abbreviate with punctuation.
            expand: Expand.
        regionFormat:
          type: string
          description: Region format of the address.
          example: countryCommonStyle
          default: countryCommonStyle
          enum:
            - countryCommonStyle
            - abbreviate
            - expand
          x-enumDescriptions:
            countryCommonStyle: Country common style.
            abbreviate: Abbreviate.
            expand: Expand.
        processingMode:
          type: string
          description: Processing mode of the address.
          example: both
          default: both
          enum:
            - both
            - addressOnly
            - geoOnly
          x-enumDescriptions:
            both: Both address and geocode.
            addressOnly: Address only.
            geoOnly: Geocode only.
        geoAssign:
          type: string
          description: Geocode assignment of the address.
          example: best
          default: best
          enum:
            - best
            - houseNumberOnly
          x-enumDescriptions:
            best: Best geocode.
            houseNumberOnly: House number only.
        suggestionSuppressLevel:
          type: string
          description: Suggestion suppress level of the address.
          example: none
          default: none
          enum:
            - none
            - secondary
          x-enumDescriptions:
            none: No suggestion suppress.
            secondary: Suppress secondary suggestions.
    CurationRequestOutputFields:
      type: array
      description: Output fields of the address.
      items:
        type: string
        description: Output field of the address.
        example: std_addr_locality_full
        default: std_addr_locality_full
        enum:
          - std_addr_country_name
          - std_addr_country_2char
          - std_addr_country_3char
          - std_addr_country_3digit
          - std_addr_locality
          - std_addr_locality_desc
          - std_addr_locality_full
          - std_addr_locality_official
          - std_addr_locality2
          - std_addr_locality2_desc
          - std_addr_locality2_full
          - std_addr_locality3
          - std_addr_locality3_desc
          - std_addr_locality3_full
          - std_addr_locality4
          - std_addr_locality4_desc
          - std_addr_locality4_full
          - std_addr_locality1_4
          - std_addr_locality1_4_full
          - std_addr_locality1_2
          - std_addr_locality1_2_full
          - std_addr_locality3_4
          - std_addr_locality3_4_full
          - std_addr_locality2_4
          - std_addr_locality2_4_full
          - std_addr_delinst_full
          - std_addr_region
          - std_addr_region_full
          - std_addr_region_code
          - std_addr_region2
          - std_addr_region2_code
          - std_addr_region2_full
          - std_addr_region1_2
          - std_addr_region1_2_full
          - std_addr_postcode_full
          - std_addr_postcode1
          - std_addr_postcode2
          - sap_formatted_postcode
          - sap_in_fmt_postcode
          - std_addr_address_delivery
          - std_addr_address_dual
          - std_addr_addr_deldual
          - std_addr_addr_deldual_bldg
          - std_addr_primaddr_deldual
          - std_addr_primaddr_deldual_bldg
          - std_addr_building_name
          - std_addr_building_name2
          - std_addr_building_name1_2
          - std_addr_prim_address
          - std_addr_sec_address
          - std_addr_pname_secaddr
          - std_addr_point_of_ref
          - std_addr_point_of_ref2
          - std_addr_point_of_ref1_2
          - std_addr_area_name
          - std_addr_firm
          - std_addr_prim_name
          - std_addr_prim_name_full
          - std_addr_prim_name2
          - std_addr_prim_name2_full
          - std_addr_prim_name3
          - std_addr_prim_name3_full
          - std_addr_prim_name4
          - std_addr_prim_name4_full
          - std_addr_prim_name1_2
          - std_addr_prim_name3_4
          - std_addr_prim_name1_4
          - std_addr_prim_type
          - std_addr_prim_type2
          - std_addr_prim_type3
          - std_addr_prim_type4
          - std_addr_prim_prefix
          - std_addr_prim_postfix
          - std_addr_prim_number
          - std_addr_prim_number_desc
          - std_addr_prim_number_extra
          - std_addr_prim_number_full
          - std_addr_block_number
          - std_addr_block_desc
          - std_addr_block_full
          - std_addr_wing_name
          - std_addr_wing_desc
          - std_addr_wing_full
          - std_addr_stairwell_name
          - std_addr_stairwell_desc
          - std_addr_stairwell_full
          - std_addr_floor_number
          - std_addr_floor_desc
          - std_addr_floor_qual
          - std_addr_floor_full
          - std_addr_unit_number
          - std_addr_unit_desc
          - std_addr_unit_qual
          - std_addr_unit_full
          - std_addr_room_number
          - std_addr_room_full
          - std_addr_pmb_full
          - std_addr_secaddr_no_room
          - std_addr_secaddr_no_floor
          - std_addr_secaddr_no_floor_room
          - std_addr_single_address
          - std_addr_full_address
          - std_addr_lastline
          - std_addr_additional_info
          - std_addr_additional_info2
          - std_addr_additional_info3
          - std_addr_additional_info4
          - std_addr_additional_info5
          - std_addr_additional_info6
          - std_addr_additional_info7
          - std_addr_delivery_point
          - addr_address_rem
          - addr_address_rem2
          - addr_address_rem3
          - addr_address_rem4
          - addr_remainder_full
          - addr_extra
          - addr_extra2
          - addr_extra3
          - addr_extra4
          - addr_extra_full
          - addr_remainder_extra_full
          - addr_remainder_extra_pmb_full
          - addr_info_code
          - addr_info_code_msg
          - addr_asmt_info
          - addr_asmt_type
          - addr_asmt_level
          - addr_change_sig
          - addr_language
          - std_addr_po_box_country_2char
          - std_addr_po_box_locality_full
          - std_addr_po_box_delinst_full
          - std_addr_po_box_region
          - std_addr_po_box_region_full
          - std_addr_po_box_region_code
          - std_addr_po_box_region2
          - std_addr_po_box_region2_full
          - std_addr_po_box_region2_code
          - std_addr_po_box_postcode_full
          - sap_formatted_po_box_postcode
          - sap_in_fmt_po_box_postcode
          - std_addr_po_box_number
          - std_addr_po_box_full
          - addr_po_box_info_code
          - addr_po_box_info_code_msg
          - addr_po_box_asmt_info
          - addr_po_box_asmt_type
          - addr_po_box_asmt_level
          - addr_po_box_change_sig
          - addr_latitude
          - addr_longitude
          - geo_info_code
          - geo_info_code_msg
          - geo_asmt_level
          - match_addr_country
          - match_addr_postcode1
          - match_addr_region
          - match_addr_locality
          - match_addr_locality2
          - match_addr_building
          - match_addr_prim_name
          - match_addr_prim_name2
          - match_addr_prim_type
          - match_addr_prim_dir
          - match_addr_prim_number
          - match_addr_block
          - match_addr_stairwell
          - match_addr_wing
          - match_addr_floor
          - match_addr_unit
          - addr_script_code
          - match_addr2_country
          - match_addr2_postcode1
          - match_addr2_region
          - match_addr2_locality
          - match_addr2_locality2
          - match_addr2_building
          - match_addr2_prim_name
          - match_addr2_prim_name2
          - match_addr2_prim_type
          - match_addr2_prim_dir
          - match_addr2_prim_number
          - match_addr2_block
          - match_addr2_stairwell
          - match_addr2_wing
          - match_addr2_floor
          - match_addr2_unit
          - addr2_script_code
          - addr2_asmt_level
          - addr2_asmt_type
          - addr_sugg_count
          - addr_sugg_error
          - addr_sugg_list
          - addr_sugg_more_suggs_available
          - addr_sugg_status
          - addr_status_code_old
          - addr_po_box_status_code_old
      x-enumDescriptions:
        std_addr_country_name: Country name.
        std_addr_country_2char: Country 2-character code.
        std_addr_country_3char: Country 3-character code.
        std_addr_country_3digit: Country 3-digit code.
        std_addr_locality: Locality name.
        std_addr_locality_desc: Locality description.
        std_addr_locality_full: Full locality name.
        std_addr_locality_official: Official locality name.
        std_addr_locality2: Secondary locality name.
        std_addr_locality2_desc: Secondary locality description.
        std_addr_locality2_full: Full secondary locality name.
        std_addr_locality3: Tertiary locality name.
        std_addr_locality3_desc: Tertiary locality description.
        std_addr_locality3_full: Full tertiary locality name.
        std_addr_locality4: Quaternary locality name.
        std_addr_locality4_desc: Quaternary locality description.
        std_addr_locality4_full: Full quaternary locality name.
        std_addr_locality1_4: Locality 1-4.
        std_addr_locality1_4_full: Full locality 1-4.
        std_addr_locality1_2: Locality 1-2.
        std_addr_locality1_2_full: Full locality 1-2.
        std_addr_locality3_4: Locality 3-4.
        std_addr_locality3_4_full: Full locality 3-4.
        std_addr_locality2_4: Locality 2-4.
        std_addr_locality2_4_full: Full locality 2-4.
        std_addr_delinst_full: Full delivery instruction.
        std_addr_region: Region name.
        std_addr_region_full: Full region name.
        std_addr_region_code: Region code.
        std_addr_region2: Secondary region name.
        std_addr_region2_code: Secondary region code.
        std_addr_region2_full: Full secondary region name.
        std_addr_region1_2: Region 1-2.
        std_addr_region1_2_full: Full region 1-2.
        std_addr_postcode_full: Full postcode.
        std_addr_postcode1: Primary postcode.
        std_addr_postcode2: Secondary postcode.
        sap_formatted_postcode: Formatted postcode.
        sap_in_fmt_postcode: In formatted postcode.
        std_addr_address_delivery: Address delivery.
        std_addr_address_dual: Dual address.
        std_addr_addr_deldual: Address delivery dual.
        std_addr_addr_deldual_bldg: Address delivery dual building.
        std_addr_primaddr_deldual: Primary address delivery dual.
        std_addr_primaddr_deldual_bldg: Primary address delivery dual building.
        std_addr_building_name: Building name.
        std_addr_building_name2: Building name 2.
        std_addr_building_name1_2: Building name 1-2.
        std_addr_prim_address: Primary address.
        std_addr_sec_address: Secondary address.
        std_addr_pname_secaddr: Primary name secondary address.
        std_addr_point_of_ref: Point of reference.
        std_addr_point_of_ref2: Point of reference 2.
        std_addr_point_of_ref1_2: Point of reference 1-2.
        std_addr_area_name: Area name.
        std_addr_firm: Firm name.
        std_addr_prim_name: Primary name.
        std_addr_prim_name_full: Full primary name.
        std_addr_prim_name2: Primary name 2.
        std_addr_prim_name2_full: Full primary name 2.
        std_addr_prim_name3: Primary name 3.
        std_addr_prim_name3_full: Full primary name 3.
        std_addr_prim_name4: Primary name 4.
        std_addr_prim_name4_full: Full primary name 4.
        std_addr_prim_name1_2: Primary name 1-2.
        std_addr_prim_name3_4: Primary name 3-4.
        std_addr_prim_name1_4: Primary name 1-4.
        std_addr_prim_type: Primary type.
        std_addr_prim_type2: Primary type 2.
        std_addr_prim_type3: Primary type 3.
        std_addr_prim_type4: Primary type 4.
        std_addr_prim_prefix: Primary prefix.
        std_addr_prim_postfix: Primary postfix.
        std_addr_prim_number: Primary number.
        std_addr_prim_number_desc: Primary number description.
        std_addr_prim_number_extra: Primary number extra.
        std_addr_prim_number_full: Full primary number.
        std_addr_block_number: Block number.
        std_addr_block_desc: Block description.
        std_addr_block_full: Full block.
        std_addr_wing_name: Wing name.
        std_addr_wing_desc: Wing description.
        std_addr_wing_full: Full wing.
        std_addr_stairwell_name: Stairwell name.
        std_addr_stairwell_desc: Stairwell description.
        std_addr_stairwell_full: Full stairwell.
        std_addr_floor_number: Floor number.
        std_addr_floor_desc: Floor description.
        std_addr_floor_qual: Floor qualifier.
        std_addr_floor_full: Full floor.
        std_addr_unit_number: Unit number.
        std_addr_unit_desc: Unit description.
        std_addr_unit_qual: Unit qualifier.
        std_addr_unit_full: Full unit.
        std_addr_room_number: Room number.
        std_addr_room_full: Full room.
        std_addr_pmb_full: Full PMB.
        std_addr_secaddr_no_room: Secondary address no room.
        std_addr_secaddr_no_floor: Secondary address no floor.
        std_addr_secaddr_no_floor_room: Secondary address no floor room.
        std_addr_single_address: Single address.
        std_addr_full_address: Full address.
        std_addr_lastline: Last line.
        std_addr_additional_info: Additional info.
        std_addr_additional_info2: Additional info 2.
        std_addr_additional_info3: Additional info 3.
        std_addr_additional_info4: Additional info 4.
        std_addr_additional_info5: Additional info 5.
        std_addr_additional_info6: Additional info 6.
        std_addr_additional_info7: Additional info 7.
        std_addr_delivery_point: Delivery point.
        addr_address_rem: Address remainder.
        addr_address_rem2: Address remainder 2.
        addr_address_rem3: Address remainder 3.
        addr_address_rem4: Address remainder 4.
        addr_remainder_full: Full remainder.
        addr_extra: Extra.
        addr_extra2: Extra 2.
        addr_extra3: Extra 3.
        addr_extra4: Extra 4.
        addr_extra_full: Full extra.
        addr_remainder_extra_full: Full remainder extra.
        addr_remainder_extra_pmb_full: Full remainder extra PMB.
        addr_info_code: Address information code.
        addr_info_code_msg: Address information code message.
        addr_asmt_info: Address assignment information.
        addr_asmt_type: Address assignment type.
        addr_asmt_level: Address assignment level.
        addr_change_sig: Address change signature.
        addr_language: Address language.
        std_addr_po_box_country_2char: Post office box country 2-character code.
        std_addr_po_box_locality_full: Full post office box locality.
        std_addr_po_box_delinst_full: Full post office box delivery instruction.
        std_addr_po_box_region: Post office box region.
        std_addr_po_box_region_full: Full post office box region.
        std_addr_po_box_region_code: Post office box region code.
        std_addr_po_box_region2: Secondary post office box region.
        std_addr_po_box_region2_full: Full secondary post office box region.
        std_addr_po_box_region2_code: Secondary post office box region code.
        std_addr_po_box_postcode_full: Full post office box postcode.
        sap_formatted_po_box_postcode: Formatted post office box postcode.
        sap_in_fmt_po_box_postcode: In formatted post office box postcode.
        std_addr_po_box_number: Post office box number.
        std_addr_po_box_full: Full post office box.
        addr_po_box_info_code: Post office box information code.
        addr_po_box_info_code_msg: Post office box information code message.
        addr_po_box_asmt_info: Post office box assignment information.
        addr_po_box_asmt_type: Post office box assignment type.
        addr_po_box_asmt_level: Post office box assignment level.
        addr_po_box_change_sig: Post office box change signature.
        addr_latitude: Address latitude.
        addr_longitude: Address longitude.
        geo_info_code: Geocode information code.
        geo_info_code_msg: Geocode information code message.
        geo_asmt_level: Geocode assignment level.
        match_addr_country: Matched address country.
        match_addr_postcode1: Matched address postcode 1.
        match_addr_region: Matched address region.
        match_addr_locality: Matched address locality.
        match_addr_locality2: Matched address locality 2.
        match_addr_building: Matched address building.
        match_addr_prim_name: Matched address primary name.
        match_addr_prim_name2: Matched address primary name 2.
        match_addr_prim_type: Matched address primary type.
        match_addr_prim_dir: Matched address primary direction.
        match_addr_prim_number: Matched address primary number.
        match_addr_block: Matched address block.
        match_addr_stairwell: Matched address stairwell.
        match_addr_wing: Matched address wing.
        match_addr_floor: Matched address floor.
        match_addr_unit: Matched address unit.
        addr_script_code: Address script code.
        match_addr2_country: Matched address 2 country.
        match_addr2_postcode1: Matched address 2 postcode 1.
        match_addr2_region: Matched address 2 region.
        match_addr2_locality: Matched address 2 locality.
        match_addr2_locality2: Matched address 2 locality 2.
        match_addr2_building: Matched address 2 building.
        match_addr2_prim_name: Matched address 2 primary name.
        match_addr2_prim_name2: Matched address 2 primary name 2.
        match_addr2_prim_type: Matched address 2 primary type.
        match_addr2_prim_dir: Matched address 2 primary direction.
        match_addr2_prim_number: Matched address 2 primary number.
        match_addr2_block: Matched address 2 block.
        match_addr2_stairwell: Matched address 2 stairwell.
        match_addr2_wing: Matched address 2 wing.
        match_addr2_floor: Matched address 2 floor.
        match_addr2_unit: Matched address 2 unit.
        addr2_script_code: Address 2 script code.
        addr2_asmt_level: Address 2 assignment level.
        addr2_asmt_type: Address 2 assignment type.
        addr_sugg_count: Address suggestion count.
        addr_sugg_error: Address suggestion error.
        addr_sugg_list: Address suggestion list.
        addr_sugg_more_suggs_available: Address suggestion more suggestions available.
        addr_sugg_status: Address suggestion status.
        addr_status_code_old: Address status code old.
        addr_po_box_status_code_old: Post office box status code old.
    CurationResponse:
      type: object
      description: Address cleanse results.
      properties:
        ADDR_SUGG_STATUS:
          type: string
          description: Status of the address suggestion.
          example: ' '
          maxLength: 2
        ADDR_SUGG_ERROR:
          type: string
          description: Error message for the address suggestion.
          example: ' '
          maxLength: 2
        ADDR_SUGG_COUNT:
          type: integer
          format: int32
          description: Number of address suggestions.
          example: '0'
        ADDR_SUGG_LIST:
          type: array
          description: List of address suggestions.
          items:
            type: object
            description: Address suggestion list.
            properties:
              SUGG_ADDR_SELECTION:
                type: integer
                format: int32
                description: Address suggestion selection.
                example: '1'
              SUGG_ADDR_ADDRESS_DELIVERY:
                type: string
                description: Address delivery.
                example: 3999 W Chester Pike
                maxLength: 256
              SUGG_ADDR_LASTLINE:
                type: string
                maxLength: 256
                description: Last line of the address.
                example: ' '
              SUGG_ADDR_SINGLE_ADDRESS:
                type: string
                maxLength: 256
                description: Single address.
                example: ' '
              SUGG_ADDR_PRIM_SIDE_INDICATOR:
                type: string
                maxLength: 1
                description: Primary side indicator.
                example: ' '
              SUGG_ADDR_SEC_SIDE_INDICATOR:
                type: string
                maxLength: 1
                description: Secondary side indicator.
                example: ' '
              SUGG_ADDR_PRIM_NUMBER_LOW:
                type: string
                maxLength: 20
                description: Primary number low.
                example: ' '
              SUGG_ADDR_PRIM_NUMBER_HIGH:
                type: string
                maxLength: 20
                description: Primary number high.
                example: ' '
              SUGG_ADDR_UNIT_NUMBER_LOW:
                type: string
                maxLength: 20
                description: Unit number low.
                example: ' '
              SUGG_ADDR_UNIT_NUMBER_HIGH:
                type: string
                maxLength: 20
                description: Unit number high.
                example: ' '
              SUGG_ADDR_FLOOR_NUMBER_LOW:
                type: string
                maxLength: 20
                description: Floor number low.
                example: ' '
              SUGG_ADDR_FLOOR_NUMBER_HIGH:
                type: string
                maxLength: 20
                description: Floor number high.
                example: ' '
        PO_BOX_LOC:
          type: string
          description: Post office box location.
          example: ' '
        INFO_CODE_PO:
          type: string
          description: Information code for post office.
          example: ' '
        FLOOR:
          type: string
          description: Floor number.
          example: '2'
        INFO_CODE_MSG:
          type: string
          description: Information code message.
          example: ' '
        COUNTRY:
          type: string
          description: Country name.
          example: United States
        POST_CODE1:
          type: string
          description: Primary address postcode.
          example: '19073'
        POST_CODE2:
          type: string
          description: Secondary address postcode.
          example: '2305'
        ASGMT_TYPE:
          type: string
          description: Assignment type.
          example: ' '
        HOUSE_NUM2:
          type: string
          description: Secondary house number.
          example: ' '
        HOUSE_NUM1:
          type: string
          description: Primary house number.
          example: '3999'
        ROOMNUMBER:
          type: string
          description: Room number.
          example: '34'
        ASGMT_LEVEL:
          type: string
          description: Assignment level.
          example: PR
        ASGMT_LEVEL_PO:
          type: string
          description: Assignment level for post office.
          example: PR
        REGION:
          type: string
          description: Primary region name.
          example: Pennsylvania
        REGION2:
          type: string
          description: Secondary region name.
          example: Delaware
        PO_BOX_REG2:
          type: string
          description: Post office box secondary region.
          example: ' '
        LOCATION:
          type: string
          description: Location name.
          example: ' '
        HOME_CITY:
          type: string
          description: Home city name.
          example: Newtown
        PO_BOX:
          type: string
          description: Post office box number.
          example: ' '
        INFO_CODE:
          type: string
          description: Information code.
          example: ' '
        ADDR_SUGG_MORE_SUGGS_AVAILABLE:
          type: string
          description: More address suggestions available.
          example: ' '
        STREET:
          type: string
          description: Street name.
          example: West Chester Pike
        INFO_CODE_PO_MSG:
          type: string
          description: Information code message for post office.
          example: ' '
        PO_BOX_REG:
          type: string
          description: Post office box region.
          example: ' '
        PO_BOX_LOBBY:
          type: string
          description: Post office box lobby.
          example: ' '
        CITY1:
          type: string
          description: Primary city name.
          example: Newtown Sq
        CITY2:
          type: string
          description: Secondary city name.
          example: ' '
        ASGMT_TYPE_PO:
          type: string
          description: Assignment type for post office.
          example: ' '
        PO_BOX_CTY:
          type: string
          description: Post office box city.
          example: ' '
        STR_SUPPL2:
          type: string
          description: Delivery address 2.
          example: ' '
        STR_SUPPL3:
          type: string
          description: Delivery address 3.
          example: ' '
        STR_SUPPL1:
          type: string
          description: Delivery address 1.
          example: ' '
        STATUS_CODE_PO:
          type: string
          description: Status code for post office.
          example: ' '
        STATUS_CODE:
          type: string
          description: Status code.
          example: ' '
    CurationBulkRequest:
      type: object
      description: Address data and settings.
      properties:
        addressInput:
          type: array
          items:
            $ref: '#/components/schemas/CurationRequestAddressInput'
        addressSettings:
          $ref: '#/components/schemas/CurationRequestAddressSettings'
        outputFields:
          $ref: '#/components/schemas/CurationRequestOutputFields'
        configurationId:
          type: string
          description: Configuration ID.
          example: '123456789'
    CurationBulkResponse:
      type: object
      description: Address cleanse results.
      properties:
        addressOutput:
          type: array
          description: List of address cleanse results.
          items:
            $ref: '#/components/schemas/CurationResponse'
