# Curate Business Partner

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.


Endpoint: POST /data-curation/rest/v2/businesspartners/curate
Version: 1
Security: oauth2Authentication

## Header parameters:

  - `Content-Type` (string, required)
    Media type

  - `Authorization` (string)
    Access Token

  - `Accept` (string)
    Media type to use for the response.

  - `Accept-Language` (string)
    Language to use for informational messages in the response.

## Request fields (application/json):

  - `addressInput` (object)
    Address data.
    Example: {"country":"US","mixed":"3999 WEST CHESTER PIKE","locality":"NEWTOWN","region":"PENNSYLVANIA","postcode":""}

  - `addressInput.CITY1` (string)
    Primary city name.
    Example: "Newtown"

  - `addressInput.CITY2` (string)
    Secondary city name.
    Example: "Chester"

  - `addressInput.HOME_CITY` (string)
    Home city name.
    Example: "Newtown"

  - `addressInput.REGION` (string)
    Primary region name.
    Example: "Pennsylvania"

  - `addressInput.REGION2` (string)
    Secondary region name.
    Example: "Delaware"

  - `addressInput.POST_CODE1` (string)
    Primary address postcode.
    Example: "19073"

  - `addressInput.COUNTRY` (string)
    Country name.
    Example: "United States"

  - `addressInput.mixed` (string)
    Address line 1.
    Example: "3999 WEST CHESTER PIKE"

  - `addressInput.mixed2` (string)
    Address line 2.
    Example: " "

  - `addressInput.mixed3` (string)
    Address line 3.
    Example: " "

  - `addressInput.mixed4` (string)
    Address line 4.
    Example: " "

  - `addressInput.mixed5` (string)
    Address line 5.
    Example: " "

  - `addressInput.mixed6` (string)
    Address line 6.
    Example: " "

  - `addressInput.mixed7` (string)
    Address line 7.
    Example: " "

  - `addressInput.mixed8` (string)
    Address line 8.
    Example: " "

  - `addressInput.mixed9` (string)
    Address line 9.
    Example: " "

  - `addressInput.mixed10` (string)
    Address line 10.
    Example: " "

  - `addressInput.mixed11` (string)
    Address line 11.
    Example: " "

  - `addressInput.STREET` (string)
    Street name.
    Example: "West Chester Pike"

  - `addressInput.HOUSE_NUM1` (string)
    Primary house number.
    Example: "3999"

  - `addressInput.HOUSE_NUM2` (string)
    Secondary house number.
    Example: " "

  - `addressInput.FLOOR` (string)
    Floor number.
    Example: "2"

  - `addressInput.ROOMNUMBER` (string)
    Room number.
    Example: "34"

  - `addressInput.BUILDING` (string)
    Building name.
    Example: " "

  - `addressInput.STR_SUPPL1` (string)
    Delivery address 1.
    Example: " "

  - `addressInput.STR_SUPPL2` (string)
    Delivery address 2.
    Example: " "

  - `addressInput.STR_SUPPL3` (string)
    Delivery address 3.
    Example: " "

  - `addressInput.LOCATION` (string)
    Location name.
    Example: " "

  - `addressInput.PO_BOX` (string)
    Post office box number.
    Example: " "

  - `addressInput.PO_BOX_LOC` (string)
    Post office box location.
    Example: " "

  - `addressInput.PO_BOX_REG` (string)
    Post office box region.
    Example: " "

  - `addressInput.PO_BOX_REG2` (string)
    Post office box secondary region.
    Example: " "

  - `addressInput.PO_BOX_LOBBY` (string)
    Post office box lobby.
    Example: " "

  - `addressInput.POST_CODE2` (string)
    Secondary address postcode.
    Example: "2305"

  - `addressInput.PO_BOX_CTY` (string)
    Post office box city.
    Example: " "

  - `addressSettings` (object)
    Address settings.
    Example: {"casing":"mixed","diacritics":"include","streetFormat":"countryCommonStyle","postalFormat":"countryCommonStyle","regionFormat":"countryCommonStyle","scriptConversion":"none"}

  - `addressSettings.casing` (string)
    Casing of the address.
    Enum: "mixed", "upper"

  - `addressSettings.diacritics` (string)
    Diacritics of the address.
    Enum: "include", "remove"

  - `addressSettings.scriptConversion` (string)
    Script conversion of the address.
    Enum: "none", "convertToLatin"

  - `addressSettings.streetFormat` (string)
    Street format of the address.
    Enum: "countryCommonStyle", "abbreviateNoPunctuation", "abbreviateWithPunctuation", "expand", "expandPrimaryAbbreviateSecondaryNoPunctuation", "expandPrimaryAbbreviateSecondaryWithPunctuation"

  - `addressSettings.postalFormat` (string)
    Postal format of the address.
    Enum: "countryCommonStyle", "abbreviateNoPunctuation", "abbreviateWithPunctuation", "expand"

  - `addressSettings.regionFormat` (string)
    Region format of the address.
    Enum: "countryCommonStyle", "abbreviate", "expand"

  - `addressSettings.processingMode` (string)
    Processing mode of the address.
    Enum: "both", "addressOnly", "geoOnly"

  - `addressSettings.geoAssign` (string)
    Geocode assignment of the address.
    Enum: "best", "houseNumberOnly"

  - `addressSettings.suggestionSuppressLevel` (string)
    Suggestion suppress level of the address.
    Enum: "none", "secondary"

  - `outputFields` (array)
    Output fields of the address.
    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"

  - `configurationName` (string)
    Deprecated. Please use configurationId instead.
    Example: " "

  - `configurationId` (string)
    Configuration ID.
    Example: "123456789"

  - `generateSuggestionList` (boolean)
    Generate suggestion list.
    Example: "false"

  - `generateCountrySuggestionList` (boolean)
    Generate country suggestion list.
    Example: "false"

  - `generateTypeAheadSuggestionList` (boolean)
    Generate type-ahead suggestion list.
    Example: "false"

  - `suggestionReply` (array)
    Suggestion reply.
    Example: [" "]

## Response 200 fields (application/json):

  - `ADDR_SUGG_STATUS` (string)
    Status of the address suggestion.
    Example: " "

  - `ADDR_SUGG_ERROR` (string)
    Error message for the address suggestion.
    Example: " "

  - `ADDR_SUGG_COUNT` (integer)
    Number of address suggestions.
    Example: "0"

  - `ADDR_SUGG_LIST` (array)
    List of address suggestions.

  - `ADDR_SUGG_LIST.SUGG_ADDR_SELECTION` (integer)
    Address suggestion selection.
    Example: "1"

  - `ADDR_SUGG_LIST.SUGG_ADDR_ADDRESS_DELIVERY` (string)
    Address delivery.
    Example: "3999 W Chester Pike"

  - `ADDR_SUGG_LIST.SUGG_ADDR_LASTLINE` (string)
    Last line of the address.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_SINGLE_ADDRESS` (string)
    Single address.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_PRIM_SIDE_INDICATOR` (string)
    Primary side indicator.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_SEC_SIDE_INDICATOR` (string)
    Secondary side indicator.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_PRIM_NUMBER_LOW` (string)
    Primary number low.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_PRIM_NUMBER_HIGH` (string)
    Primary number high.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_UNIT_NUMBER_LOW` (string)
    Unit number low.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_UNIT_NUMBER_HIGH` (string)
    Unit number high.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_FLOOR_NUMBER_LOW` (string)
    Floor number low.
    Example: " "

  - `ADDR_SUGG_LIST.SUGG_ADDR_FLOOR_NUMBER_HIGH` (string)
    Floor number high.
    Example: " "

  - `PO_BOX_LOC` (string)
    Post office box location.
    Example: " "

  - `INFO_CODE_PO` (string)
    Information code for post office.
    Example: " "

  - `FLOOR` (string)
    Floor number.
    Example: "2"

  - `INFO_CODE_MSG` (string)
    Information code message.
    Example: " "

  - `COUNTRY` (string)
    Country name.
    Example: "United States"

  - `POST_CODE1` (string)
    Primary address postcode.
    Example: "19073"

  - `POST_CODE2` (string)
    Secondary address postcode.
    Example: "2305"

  - `ASGMT_TYPE` (string)
    Assignment type.
    Example: " "

  - `HOUSE_NUM2` (string)
    Secondary house number.
    Example: " "

  - `HOUSE_NUM1` (string)
    Primary house number.
    Example: "3999"

  - `ROOMNUMBER` (string)
    Room number.
    Example: "34"

  - `ASGMT_LEVEL` (string)
    Assignment level.
    Example: "PR"

  - `ASGMT_LEVEL_PO` (string)
    Assignment level for post office.
    Example: "PR"

  - `REGION` (string)
    Primary region name.
    Example: "Pennsylvania"

  - `REGION2` (string)
    Secondary region name.
    Example: "Delaware"

  - `PO_BOX_REG2` (string)
    Post office box secondary region.
    Example: " "

  - `LOCATION` (string)
    Location name.
    Example: " "

  - `HOME_CITY` (string)
    Home city name.
    Example: "Newtown"

  - `PO_BOX` (string)
    Post office box number.
    Example: " "

  - `INFO_CODE` (string)
    Information code.
    Example: " "

  - `ADDR_SUGG_MORE_SUGGS_AVAILABLE` (string)
    More address suggestions available.
    Example: " "

  - `STREET` (string)
    Street name.
    Example: "West Chester Pike"

  - `INFO_CODE_PO_MSG` (string)
    Information code message for post office.
    Example: " "

  - `PO_BOX_REG` (string)
    Post office box region.
    Example: " "

  - `PO_BOX_LOBBY` (string)
    Post office box lobby.
    Example: " "

  - `CITY1` (string)
    Primary city name.
    Example: "Newtown Sq"

  - `CITY2` (string)
    Secondary city name.
    Example: " "

  - `ASGMT_TYPE_PO` (string)
    Assignment type for post office.
    Example: " "

  - `PO_BOX_CTY` (string)
    Post office box city.
    Example: " "

  - `STR_SUPPL2` (string)
    Delivery address 2.
    Example: " "

  - `STR_SUPPL3` (string)
    Delivery address 3.
    Example: " "

  - `STR_SUPPL1` (string)
    Delivery address 1.
    Example: " "

  - `STATUS_CODE_PO` (string)
    Status code for post office.
    Example: " "

  - `STATUS_CODE` (string)
    Status code.
    Example: " "