Data Clinic API (1)

Download OpenAPI specification:Download

This API provides services for Data Clinic

Augmented Business Partners

Represent entities enhanced with supplementary data derived from many distinct data sources, providing a comprehensive view of the Business Partner's information.

Read a Page of Augmented Business Partners

Read a page of Augmented Business Partners from a given storage.

SecurityapiKey
Request
path Parameters
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
query Parameters
countryShortNames
Array of strings (CountryShortNameParam)

List of iso-2 country codes (see possible values here: Country - CDQ) for filtering Business Partners by country.

Items Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AP" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BU" "BV" "BW" "BX" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CP" "CQ" "CR" "CS" "CT" "CU" "CV" "CW" "CX" "CY" "CZ" "DD" "DE" "DG" "DJ" "DK" "DM" "DO" "DY" "DZ" "EA" "EC" "EE" "EF" "EG" "EH" "EM" "EP" "ER" "ES" "ET" "EU" "EV" "EW" "EZ" "FI" "FJ" "FK" "FL" "FM" "FO" "FQ" "FR" "FX" "GA" "GB" "GC" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "HV" "IB" "IC" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JA" "JE" "JM" "JO" "JP" "JT" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LF" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MI" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NH" "NI" "NL" "NO" "NP" "NQ" "NR" "NT" "NU" "NZ" "OA" "OM" "PA" "PC" "PE" "PF" "PG" "PH" "PI" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PU" "PW" "PY" "PZ" "QA" "RA" "RB" "RC" "RE" "RH" "RI" "RL" "RM" "RN" "RO" "RP" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SF" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SU" "SV" "SX" "SY" "SZ" "TA" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TP" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UK" "UM" "UN" "US" "UY" "UZ" "VA" "VC" "VD" "VE" "VG" "VI" "VN" "VU" "WF" "WG" "WK" "WL" "WO" "WORLD" "WS" "WV" "XI" "XK" "YD" "YE" "YT" "YU" "YV" "ZA" "ZM" "ZR" "ZW"
Example: countryShortNames=DE
dataSourceId
string (BusinessPartnerStorageDataSourceId)

The ID of a Data Source of the Data Mirror for filtering only Business Partners that are managed in this source.

Example: dataSourceId=648824a691d8d2503d65103e
externalIds
Array of strings (BusinessPartnerExternalId)

List of External IDs for filtering by a specific selection of Business Partners managed in the Data Mirror.

Example: externalIds=The ID managed in the customer's SAP systems.
featuresOff
Array of strings (ReadAugmentedBusinessPartnersFeatureParam)

Features to be deactivated during the read augmented Business Partners.

Items Enum: Description
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default, turned off.

FILTER_BY_ENABLED_AUGMENTATION_MONITORS

Filters out results by enabled, existing data sources of augmentation monitors. By default, turned on.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: featuresOff=FETCH_RAW_UPDATES
featuresOn
Array of strings (ReadAugmentedBusinessPartnersFeatureParam)

Features to be activated during the read augmented Business Partners.

Items Enum: Description
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default, turned off.

FILTER_BY_ENABLED_AUGMENTATION_MONITORS

Filters out results by enabled, existing data sources of augmentation monitors. By default, turned on.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: featuresOn=FETCH_RAW_UPDATES
from
string

Filter records that were modified since the given date. Provide date in ISO format: RRRR-MM-DDTHH:MM:SSZ.

Example: from=2024-07-11T07:22:25Z
identifierCreated
boolean

Indicates whether the identifier value was ADDED.

Example: identifierCreated=true
identifierTypeTechnicalKeysCreated
Array of strings (IdentifierTypeTechnicalKey)

All identifier types for which the identifier value was ADDED.

Example: identifierTypeTechnicalKeysCreated=CH_VAT_ID
identifierTypeTechnicalKeysUpdated
Array of strings (IdentifierTypeTechnicalKey)

All identifier types for which the identifier value was MODIFIED.

Example: identifierTypeTechnicalKeysUpdated=CH_VAT_ID
identifierUpdated
boolean

Indicates whether the identifier value was MODIFIED.

Example: identifierUpdated=true
legalFormCreated
boolean

Indicates whether the legal form was ADDED.

Example: legalFormCreated=true
legalFormUpdated
boolean

Indicates whether the legal form was MODIFIED.

Example: legalFormUpdated=true
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Define the maximum page size of the response.
See also CDQ - Developer Guidelines.

Example: limit=100
localAddressConceptsUpdated
Array of strings

All concepts of the local address that were MODIFIED or ADDED compared to the input address.

Example: localAddressConceptsUpdated=LOCALITY
localAddressCreated
boolean

Indicates whether given local address was ADDED.

Example: localAddressCreated=true
localAddressUpdated
boolean

The given address that was not of type registered or VAT address comprises differences compared to the generated local address (value of one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED).

Example: localAddressUpdated=true
localNameCreated
boolean

Indicates whether the local name was ADDED.

Example: localNameCreated=true
localNameUpdated
boolean

Indicates whether the local name was MODIFIED.

Example: localNameUpdated=true
overallClassifications
Array of strings (PropertyChangeClassification)

Filter Business Partners by the overall classification.

Example: overallClassifications=MAJOR
registeredAddressConceptsUpdated
Array of strings

All concepts of the registered address that were MODIFIED or ADDED.

Example: registeredAddressConceptsUpdated=LOCALITY
registeredAddressCreated
boolean

Indicates whether given registered address was ADDED.

Example: registeredAddressCreated=true
registeredAddressUpdated
boolean

Indicates whether given registered address was updated (one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED).

Example: registeredAddressUpdated=true
registeredNameCreated
boolean

Indicates whether the registered name was ADDED.

Example: registeredNameCreated=true
registeredNameUpdated
boolean

Indicates whether the registered name was MODIFIED.

Example: registeredNameUpdated=true
startAfter
string

Start after the provided pagination ID. Leave empty for the first query. The response will contain a property nextStartAfter which need to be used for any subsequent queries until nextStartAfter is empty. See CDQ - Developer Guidelines.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
triggerProvenanceTechnicalKeys
Array of strings (ProvenanceTechnicalKeyParam)

Filter Business Partners by the Data Sources that triggered the generation of a new version of the Business Partner.

Items Enum: Description
AR_NRC

Argentina - National Registry of Companies

AT_CR

Austria - Company Register

AT_FON

Austria - Financial Online

AU_BR

Australia - Business Register

BR_RF

Brazil - Receita Federal

BZST

Germany - Federal Central Tax Office

CA_CR

Canada - Company Register

CDQ_AA

CDQ - Address Augmentation

CDQ_BANKPOOL

CDQ - Bank Pool

CDQ_CRS

CDQ - Company Register Service

CDQ_CTRY

CDQ - Country Service

CDQ_IDS

CDQ - Identification Service

CDQ_LF

CDQ - Legal Form Service

CDQ_POOL

CDQ - Pool

CH_MEDREG

Switzerland - Medical Register

CH_UIDR

Switzerland - UID Register

CX_BPN

CDQ - Business Partner Network

CX_POOL

CDQ - Pool

CZ_REE

Czech Republic - Register of Economic Entities

DE_RC

Germany - Company Register

DK_CR

Denmark - Company Register

DNB

Dun & Bradstreet

DNB_LINKAGE_LNKELI

Dun & Bradstreet - Linkage - Linkage Eligibility

DNB_MASTER_DATA_BASIC

Dun & Bradstreet - Master Data - Basic

DNB_MASTER_DATA_EXTENDED

Dun & Bradstreet - Master Data - Extended

EE_CR

Estonia - Company Register

FR_RC

France - Company Register

GB_EAW_CR

United Kingdom - Companies House

GEON

Geonames

GMAPS

Google Maps

GOOGLEPLACES

Google Places

GTRANSLATE

Google Translate

HERE

Here

HK_CR

Hong Kong - Company Register

IE_CR

Ireland - Company Register

IL_CR

Israel - Company Register

IRS

Internal Revenue Service

JP_CR

Japan - Company Register

LEI

Legal Entity Identifier

NL_BR

Netherlands - Business Register

NZ_CR

New Zealand - Company Register

OSM

OpenStreetMap

ORGANIZATION

Organization

PL_NOBR

Poland - National Official Business Register

RO_TR

Romania - Trade Register

SAP

SAP

SG_BR

Singapore - Business Register

SK_FS

Slovakia - Financial Statements

UK_VAT

United Kingdom - VAT Register

USPS

United States Postal Service

US_AK_BER

United States - Alaska - Business Entity Register

US_CO_BER

United States - Colorado - Business Entity Register

US_EDU

United States - Education

US_FL_BER

United States - Florida - Business Entity Register

US_IO_BER

United States - Iowa - Business Entity Register

US_LA_BER

United States - Louisiana - Business Entity Register

US_NY_BER

United States - New York - Business Entity Register

US_OR_BER

United States - Oregon - Business Entity Register

US_SEC

United States - Securities and Exchange Commission

US_SF_BER

United States - South Dakota - Business Entity Register

US_WA_BER

United States - Washington - Business Entity Register

VIES

VIES

WIKIDATA

Wikidata

Example: triggerProvenanceTechnicalKeys=CDQ_POOL
triggerTypeTechnicalKeys
Array of strings (TriggerTypeTechnicalKeyParam)

Filter by the type of trigger for the generation of a new version of the Business Partner.

Items Enum: Description
CREATED

Business Partners that were newly created in the data mirror by the user and thus were considered the first time.

UPDATED

Business Partners that were modified in the data mirror by the user.

REFERENCE_DATA_CHANGED

Business Partners in the data mirror for which an update in activated data sources was identified resulting in the generation of a new version of the Business Partner.

JOB

Business Partners that were created or updated by a job.

Example: triggerTypeTechnicalKeys=CREATED
typeTechnicalKeys
Array of strings (BusinessPartnerTypeTechnicalKeyParam)

List of types used to filter the result of business partners returned.

Items Enum: "BP_ADDRESS" "BRAND" "LEGAL_ENTITY" "ORGANIZATIONAL_UNIT" "UNKNOWN"
Example: typeTechnicalKeys=BP_ADDRESS
vatAddressConceptsUpdated
Array of strings

All concepts of the VAT address that were MODIFIED or ADDED.

Example: vatAddressConceptsUpdated=LOCALITY
vatAddressCreated
boolean

Indicates whether given VAT address was ADDED.

Example: vatAddressCreated=true
vatAddressUpdated
boolean

Indicates whether given VAT address was updated (one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED).

Example: vatAddressUpdated=true
vatNameCreated
boolean

Indicates whether the VAT name was ADDED.

Example: vatNameCreated=true
vatNameUpdated
boolean

Indicates whether the VAT name was MODIFIED.

Example: vatNameUpdated=true
Responses
200

OK

get/storages/{storageId}/augmentedbusinesspartners
Request samples
Response samples
application/json
{
  • "limit": "100",
  • "total": "67",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ]
}

Read an Augmented Business Partner

Read an Augmented Business Partner from a given data source.

SecurityapiKey
Request
path Parameters
dataSourceId
required
string (BusinessPartnerStorageDataSourceId)

Unique identifier of the Data Source.

Example: 648824a691d8d2503d65103e
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Request Body schema: application/json
required
externalId
required
string non-empty

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."
featuresOn
Array of strings (FetchAugmentedBusinessPartnerFeatureParam)

List of feature to be used during the fetch Augmented Business Partner.

Items Enum: Description
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.updates in the result object. By default, turned off.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: ["FETCH_RAW_UPDATES"]
from
string

Filter updates by date.

Example: "2024-07-11T07:22:25Z"
Responses
200

OK

post/storages/{storageId}/datasources/{dataSourceId}/augmentedbusinesspartners/fetch
Request samples
application/json
{
  • "externalId": "The ID managed in the customer's SAP systems.",
  • "from": "2024-07-11T07:22:25Z",
  • "featuresOn": [
    ]
}
Response samples
application/json
{
  • "augmentedBusinessPartner": {},
  • "augmentedChanges": [
    ],
  • "requestSimilarity": {
    },
  • "updates": [
    ],
  • "executedAt": "2024-07-11T07:22:25Z",
  • "metadata": {
    },
  • "resultSummary": {
    },
  • "originalBusinessPartner": {}
}