SAP DQM API (1)

Download OpenAPI specification:Download

SAP Data Quality Management: data_quality_microservice@sap.com URL: https://www.sap.com/products/data-quality-management.html

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.

SAP Data Quality Management, microservices for location data

Business Partners

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.

Securityoauth2Authentication
Request
header Parameters
Accept
string
Default: text/tab-separated-values

Media type to use for the response.

Accept-Language
string
Default:

Language to use for informational messages in the response.

Authorization
string
Default: Contains the OAuth token when using OAuth client.

Access Token

Content-Type
required
string
Default: application/json

Media type

Request Body schema: application/json

Address data and settings.

object

Address data.

Example: {"country":"US","mixed":"3999 WEST CHESTER PIKE","locality":"NEWTOWN","region":"PENNSYLVANIA","postcode":""}
object

Address settings.

Example: {"casing":"mixed","diacritics":"include","streetFormat":"countryCommonStyle","postalFormat":"countryCommonStyle","regionFormat":"countryCommonStyle","scriptConversion":"none"}
configurationId
string

Configuration ID.

Example: "123456789"
configurationName
string

Deprecated. Please use configurationId instead.

Example: " "
generateCountrySuggestionList
boolean
Default: false

Generate country suggestion list.

Example: "false"
generateSuggestionList
boolean
Default: false

Generate suggestion list.

Example: "false"
generateTypeAheadSuggestionList
boolean
Default: false

Generate type-ahead suggestion list.

Example: "false"
outputFields
Array of strings

Output fields of the address.

Items 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"
Example: ["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"]
suggestionReply
Array of strings

Suggestion reply.

Example: [" "]
Responses
200

Address cleanse results.

400

Bad request. The user needs to change something before the request can be successful.

401

Unauthorized. Authorization failed.

403

Forbidden. You are not allowed to process the request.

500

Internal server error. The request could not be processed. Try again.

503

Service unavailable. The required service is not currently available. Try again.

post/data-curation/rest/v2/businesspartners/curate
Request samples
application/json
{
  • "addressInput": {
    },
  • "outputFields": [
    ],
  • "addressSettings": {
    }
}
Response samples
{
  • "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": ""
}