Curate Business PartnerWSDL

Curate Business Partner or address.

SecurityapiKey
Request
Request Body schema: application/json
required

CurationRequest

addressCurationLevelThreshold
string (CurationLevel)

Indicator for curation quality. Defines how good curation was.

Additional documentation can be found here.

Enum: Description
UNKNOWN

No possibility to determine curation level.

LEVEL_1

The address was not found by the CDQ in the employed external data sources.

LEVEL_2

The address was found, but there were significant changes in critical fields.

LEVEL_3

The address was found and there are minor changes in highly important fields.

LEVEL_4

The address was found by the CDQ. There were only changes in less critical fields such as the address/premise or address/thoroughfare/number.

LEVEL_5

The address was found by the CDQ, but no major changes have been made as the address was correct.

LEVEL_6

The address was found in the shared CDQ data pool. This means another company uses the same address which is a very reliable indicator that the address is correct (only in a alpha version)

Example: "LEVEL_1"
object (AddressDataSources)

Preferred data sources for curation. Default PrimaryAddressDataSource is HERE. Default SecondaryAddressDataSource is CDQ.

object

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

featuresOff
Array of strings (Feature)

List of features to be deactivated.

Items Enum: "ACTIVATE_DATASOURCE_BVD" "ACTIVATE_DATASOURCE_DNB" "ALL_ADDRESS_VERSIONS" "CAPITALIZE_ADDRESS" "CONFIRM_IDENTIFIERS" "DETECT_INDUSTRIAL_ZONE" "ENABLE_FUZZY_ENRICHMENTS" "ENABLE_SETTINGS" "ENABLE_UNALLOWED_NAME_VALUE_VALIDATION" "ENRICH_ADDRESS" "ENRICH_ADDRESS_TYPE" "ENRICH_ADMINISTRATIVE_AREA_ISO" "ENRICH_CATEGORY" "ENRICH_CLASSIFICATIONS" "ENRICH_COMPANY_STATUS" "ENRICH_GEOGRAPHIC_COORDINATES" "ENRICH_GOOGLE_PLACES_INFORMATION" "ENRICH_IDENTIFIERS" "ENRICH_LEGAL_ADDRESS" "ENRICH_LOCAL_ADDRESS" "ENRICH_LEGAL_FORM" "ENRICH_MINORITY_INDICATOR" "ENRICH_POST_CODE" "ENRICH_POST_CODE_TYPE" "ENRICH_REGISTERED_NAME" "ENRICH_VAT_REGISTERED_INFORMATION" "EXTRACT_ADDRESS_CONTEXT" "EXTRACT_CARE_OF" "EXTRACT_DOING_BUSINESS_AS" "HARMONIZE_IDENTIFIERS" "HARMONIZE_NAME" "JOIN_THOROUGHFARE_NUMBER_POSTFIX" "JOIN_THOROUGHFARE_NUMBER_PREFIX" "NORMALIZE_ADDRESS" "NORMALIZE_BUSINESS_PARTNER" "PARSE_ADDRESS" "PARSE_LEGAL_FORM" "PARSE_LEGAL_FORM_WORLDWIDE" "PARSE_NAMES" "PREFER_COUNTY" "PREFER_THOROUGHFARE_NAME" "PREFER_THOROUGHFARE_SHORTNAME" "PREPROCESS_ADDRESS" "PREPROCESS_BUSINESS_PARTNER" "REMOVE_CONTACT_INFORMATION" "REMOVE_INVALID_IDENTIFIERS" "SHARING_PRIMARY" "SHOW_DEBUG_INFO" "SHOW_FORMATTED_ADDRESS" "SHOW_FORMATTED_SAP_RECORD" "SHOW_SETTINGS" "STANDARDIZE_REGISTERED_ADDRESS" "STANDARDIZE_VAT_REGISTERED_ADDRESS" "TRANSLATE_ADDRESS" "TRANSLATE_NAMES" "USE_ADDRESS_INDEX_KR" "LAB_ALLOW_LONG_LOOKUP_CALLS" "LAB_QUERY_CLIENT" "LAB_QUERY_GOOGLE_WITH_COMPANY" "LAB_QUERY_PELIAS_WITH_COMPANY" "LAB_USE_GOOGLE_MAPS" "LAB_USE_LOOKUP_CLASSIFICATION_ONLY" "LAB_USE_PELIAS" "LAB_USE_QUEUES" "USE_LOCALITY_SHORTNAME_REFERENCE"
Example: ["ENRICH_ADDRESS"]
featuresOn
Array of strings (Feature)

List of features to be activated.

Items Enum: "ACTIVATE_DATASOURCE_BVD" "ACTIVATE_DATASOURCE_DNB" "ALL_ADDRESS_VERSIONS" "CAPITALIZE_ADDRESS" "CONFIRM_IDENTIFIERS" "DETECT_INDUSTRIAL_ZONE" "ENABLE_FUZZY_ENRICHMENTS" "ENABLE_SETTINGS" "ENABLE_UNALLOWED_NAME_VALUE_VALIDATION" "ENRICH_ADDRESS" "ENRICH_ADDRESS_TYPE" "ENRICH_ADMINISTRATIVE_AREA_ISO" "ENRICH_CATEGORY" "ENRICH_CLASSIFICATIONS" "ENRICH_COMPANY_STATUS" "ENRICH_GEOGRAPHIC_COORDINATES" "ENRICH_GOOGLE_PLACES_INFORMATION" "ENRICH_IDENTIFIERS" "ENRICH_LEGAL_ADDRESS" "ENRICH_LOCAL_ADDRESS" "ENRICH_LEGAL_FORM" "ENRICH_MINORITY_INDICATOR" "ENRICH_POST_CODE" "ENRICH_POST_CODE_TYPE" "ENRICH_REGISTERED_NAME" "ENRICH_VAT_REGISTERED_INFORMATION" "EXTRACT_ADDRESS_CONTEXT" "EXTRACT_CARE_OF" "EXTRACT_DOING_BUSINESS_AS" "HARMONIZE_IDENTIFIERS" "HARMONIZE_NAME" "JOIN_THOROUGHFARE_NUMBER_POSTFIX" "JOIN_THOROUGHFARE_NUMBER_PREFIX" "NORMALIZE_ADDRESS" "NORMALIZE_BUSINESS_PARTNER" "PARSE_ADDRESS" "PARSE_LEGAL_FORM" "PARSE_LEGAL_FORM_WORLDWIDE" "PARSE_NAMES" "PREFER_COUNTY" "PREFER_THOROUGHFARE_NAME" "PREFER_THOROUGHFARE_SHORTNAME" "PREPROCESS_ADDRESS" "PREPROCESS_BUSINESS_PARTNER" "REMOVE_CONTACT_INFORMATION" "REMOVE_INVALID_IDENTIFIERS" "SHARING_PRIMARY" "SHOW_DEBUG_INFO" "SHOW_FORMATTED_ADDRESS" "SHOW_FORMATTED_SAP_RECORD" "SHOW_SETTINGS" "STANDARDIZE_REGISTERED_ADDRESS" "STANDARDIZE_VAT_REGISTERED_ADDRESS" "TRANSLATE_ADDRESS" "TRANSLATE_NAMES" "USE_ADDRESS_INDEX_KR" "LAB_ALLOW_LONG_LOOKUP_CALLS" "LAB_QUERY_CLIENT" "LAB_QUERY_GOOGLE_WITH_COMPANY" "LAB_QUERY_PELIAS_WITH_COMPANY" "LAB_USE_GOOGLE_MAPS" "LAB_USE_LOOKUP_CLASSIFICATION_ONLY" "LAB_USE_PELIAS" "LAB_USE_QUEUES" "USE_LOCALITY_SHORTNAME_REFERENCE"
Example: ["ENRICH_ADDRESS"]
inputLanguage
string

ISO 639-1 code of the language of provided data (if known).

Example: "CH"
Array of objects (OutputCharset)

List of requested output charsets of the curation result.

outputLanguage
string

ISO 639-1 code of requested language of the curation result.

Example: "CH"
profile
string (Profile)
Enum: "STANDARD" "ADDRESS_ONLY" "STANDARD_ADDRESS_CURATION_AND_ENRICHMENT" "ADDRESS_STANDARDIZATION" "ADDRESS_TRANSLATION" "BUSINESS_PARTNER_ONLY" "FEATURES_OFF" "NATURAL_PERSON_SCREENING" "PRECURATION" "GOLDEN_RECORD"
Example: "STANDARD"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartners/curate
Request samples
application/json
{
  • "businessPartner": {
    },
  • "inputLanguage": "CH",
  • "outputLanguage": "CH",
  • "outputCharsets": [
    ],
  • "addressDataSources": {
    },
  • "addressCurationLevelThreshold": "LEVEL_1",
  • "profile": "STANDARD",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
application/json
{
  • "businessPartnerCurationResult": {
    },
  • "addressCurationResult": {
    },
  • "settings": {
    }
}