Skip to content

SAP DQM API (1)

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
Download OpenAPI description
api-v1.json
api-v1.yaml
Overview
URL

https://www.sap.com/products/data-quality-management.html

SAP Data Quality Management

data_quality_microservice@sap.com

Languages
Servers

https://api.cdq.com/sap-dqm/v1/

Business Partners

Operations

Curate Business Partner

Request

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.

Security
oauth2Authentication
Headers
Content-Typestringrequired

Media type

Default application/json
Authorizationstring

Access Token

Default Contains the OAuth token when using OAuth client.
Acceptstring

Media type to use for the response.

Default text/tab-separated-values
Accept-Languagestring

Language to use for informational messages in the response.

Default
Bodyapplication/json

Address data and settings.

addressInputobject

Address data.

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

Address settings.

Example: {"casing":"mixed","diacritics":"include","streetFormat":"countryCommonStyle","postalFormat":"countryCommonStyle","regionFormat":"countryCommonStyle","scriptConversion":"none"}
outputFieldsArray 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"
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"]
configurationNamestring

Deprecated. Please use configurationId instead.

Example: " "
configurationIdstring

Configuration ID.

Example: "123456789"
generateSuggestionListboolean

Generate suggestion list.

Default false
Example: "false"
generateCountrySuggestionListboolean

Generate country suggestion list.

Default false
Example: "false"
generateTypeAheadSuggestionListboolean

Generate type-ahead suggestion list.

Default false
Example: "false"
suggestionReplyArray of strings

Suggestion reply.

Example: [" "]
curl -i -X POST \
  https://api.cdq.com/sap-dqm/v1/data-curation/rest/v2/businesspartners/curate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
    }
  }'

Responses

Address cleanse results.

Body
ADDR_SUGG_STATUSstring<= 2 characters

Status of the address suggestion.

Example: " "
ADDR_SUGG_ERRORstring<= 2 characters

Error message for the address suggestion.

Example: " "
ADDR_SUGG_COUNTinteger(int32)

Number of address suggestions.

Example: "0"
ADDR_SUGG_LISTArray of objects

List of address suggestions.

PO_BOX_LOCstring

Post office box location.

Example: " "
INFO_CODE_POstring

Information code for post office.

Example: " "
FLOORstring

Floor number.

Example: "2"
INFO_CODE_MSGstring

Information code message.

Example: " "
COUNTRYstring

Country name.

Example: "United States"
POST_CODE1string

Primary address postcode.

Example: "19073"
POST_CODE2string

Secondary address postcode.

Example: "2305"
ASGMT_TYPEstring

Assignment type.

Example: " "
HOUSE_NUM2string

Secondary house number.

Example: " "
HOUSE_NUM1string

Primary house number.

Example: "3999"
ROOMNUMBERstring

Room number.

Example: "34"
ASGMT_LEVELstring

Assignment level.

Example: "PR"
ASGMT_LEVEL_POstring

Assignment level for post office.

Example: "PR"
REGIONstring

Primary region name.

Example: "Pennsylvania"
REGION2string

Secondary region name.

Example: "Delaware"
PO_BOX_REG2string

Post office box secondary region.

Example: " "
LOCATIONstring

Location name.

Example: " "
HOME_CITYstring

Home city name.

Example: "Newtown"
PO_BOXstring

Post office box number.

Example: " "
INFO_CODEstring

Information code.

Example: " "
ADDR_SUGG_MORE_SUGGS_AVAILABLEstring

More address suggestions available.

Example: " "
STREETstring

Street name.

Example: "West Chester Pike"
INFO_CODE_PO_MSGstring

Information code message for post office.

Example: " "
PO_BOX_REGstring

Post office box region.

Example: " "
PO_BOX_LOBBYstring

Post office box lobby.

Example: " "
CITY1string

Primary city name.

Example: "Newtown Sq"
CITY2string

Secondary city name.

Example: " "
ASGMT_TYPE_POstring

Assignment type for post office.

Example: " "
PO_BOX_CTYstring

Post office box city.

Example: " "
STR_SUPPL2string

Delivery address 2.

Example: " "
STR_SUPPL3string

Delivery address 3.

Example: " "
STR_SUPPL1string

Delivery address 1.

Example: " "
STATUS_CODE_POstring

Status code for post office.

Example: " "
STATUS_CODEstring

Status code.

Example: " "
Response
{
  "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": ""
}