Business Partners

Business Partners

Create Supplier Gateway Record

Creates a new Supplier Gateway record by providing the necessary information and returns the created record.

SecurityapiKey
Request
Request Body schema: application/json
required
object (SupplierGatewayCreateBody)

Complete body of the Supplier Gateway Record.

Responses
200

successful operation

post/sgw/businesspartners
Request samples
application/json
{
  • "supplierGateway": {
    }
}
Response samples
{
  • "Code": "200",
  • "Message": "Supplier gateway successfully created",
  • "Supplier": {
    }
}

Fetch Batch Business PartnersWSDL

Retrieves the Business Partners based on the Lookup and returning the result of the multiple records.

SecurityapiKey
Request
header Parameters
X-DNB-PASSWORD
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

Example: dnb_consumer_secret
X-DNB-USER
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

Example: dnb_consumer_key
Request Body schema: application/json
required
cdqIds
Array of strings

List of CDQ IDs for Business Partner and address.

Example: ["VIES:DE123456789"]
featuresOff
Array of strings (BusinessPartnerFetchFeaturesDesc)

List of features to be deactivated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found. By default turned on.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_MASTER_DATA_MGMT

Use DNB Master Data Lnkg to fetch record.

ACTIVATE_MASTER_DATA_LNKG

Use DNB Master Data Mgmt to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_MASTER_DATA_BASIC_BVD

Returns Master Data Basic from BvD

ACTIVATE_MASTER_DATA_EXTENDED_BVD

Returns Master Data Extended from BvD

ACTIVATE_FINANCIAL_RISK_DATA_BVD

Returns Financial Risk Data from BvD

ACTIVATE_OWNERSHIP_DATA_BVD

Returns Ownership Data from BvD

Example: ["ENABLE_SETTINGS"]
featuresOn
Array of strings (BusinessPartnerFetchFeaturesDesc)

List of features to be activated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found. By default turned on.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_MASTER_DATA_MGMT

Use DNB Master Data Lnkg to fetch record.

ACTIVATE_MASTER_DATA_LNKG

Use DNB Master Data Mgmt to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_MASTER_DATA_BASIC_BVD

Returns Master Data Basic from BvD

ACTIVATE_MASTER_DATA_EXTENDED_BVD

Returns Master Data Extended from BvD

ACTIVATE_FINANCIAL_RISK_DATA_BVD

Returns Financial Risk Data from BvD

ACTIVATE_OWNERSHIP_DATA_BVD

Returns Ownership Data from BvD

Example: ["ENABLE_SETTINGS"]
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch-batch
Request samples
application/json
{
  • "cdqIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Fetch Business Partner

Retrieves the Business Partner based on the Lookup and returning the result of the single record.

Read more about Golden Record here.

SecurityapiKey
Request
Request Body schema: application/json
required
object (BusinessPartnerParam)

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

cdqId
string

CDQ ID for Business Partner and address.

Example: "VIES:DE123456789"
configurationId
string (ReferenceDataFetchConfigurationId)

Configuration ID used to set up fetch. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

  • screeningMatchingThreshold
  • featuresOn
  • featuresOff
Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
featuresOff
Array of strings (BusinessPartnerFetchFeatureEnum)

List of features to be deactivated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use mgmt set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use lnkg set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

USE_FETCH_STRATEGY_GOLDEN_RECORD

Use golden record fetch strategy.

Example: ["SHOW_RAW_DATA"]
featuresOn
Array of strings (BusinessPartnerFetchFeatureEnum)

List of features to be activated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use mgmt set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use lnkg set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

USE_FETCH_STRATEGY_GOLDEN_RECORD

Use golden record fetch strategy.

Example: ["SHOW_RAW_DATA"]
screeningMatchingThreshold
number

The matching threshold. When not set then all entries are taken into consideration.

Example: "0.8"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "VIES:CZ46981691"
}
Response samples
application/json
{
  • "cdqId": "VIES:CZ46981691",
  • "dataSource": {
    },
  • "businessPartner": {
    }
}

Fetch Business Partner RelationsWSDL

Retrieves the Business Partner Relations based on the Lookup and returning the result of the single record.

SecurityapiKey
Request
Request Body schema: application/json
required
cdqId
string

CDQ ID for Business Partner and address.

Example: "VIES:DE123456789"
classTechnicalKey
string

Filter by class technical key.

Example: "BUSINESS_PARTNER_RELATION_CLASS_LEI_HIERARCHY"
endedAfter
string

Find relations which endedAt is after given date.

Example: "2024-12-21T01:35:22Z"
endedBefore
string

Find relations which endedAt is before given date.

Example: "2024-12-21T01:35:22Z"
limit
integer (Limit)

Number of items per page.

Example: "100"
startAfter
string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
startedAfter
string

Find relations which startedAt is after given date.

Example: "2024-12-21T01:35:22Z"
startedBefore
string

Find relations which startedAt is before given date.

Example: "2024-12-21T01:35:22Z"
typeTechnicalKey
string

Filter by type.

Example: "LEI_DIRECT_PARENT"
Responses
200

OK

post/v3/businesspartners/fetchrelations
Request samples
application/json
{
  • "cdqId": "LEI:CZ46981691"
}
Response samples
application/json
{
  • "nextStartAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ]
}

Fetch DNB RecordWSDLDeprecated

Fetch D&B record by CDQ-ID. It is possible to read:

  • legacy CMPELK data
  • Data Blocks defined here

Fetch CMPELK

To fetch the CMPELK object no features have to be activated.

POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789"
}

Fetch Data Blocks

It is possible to read pre-defined Data Blocks

Fetch pre-defined Data Blocks

There are 2 features with pre-defined data blocks:

  • ACTIVATE_MASTER_DATA_BASIC uses following data blocks:
    • COMPANYINFO_L1_V1
  • ACTIVATE_MASTER_DATA_EXTENDED uses following data blocks:
    • COMPANYINFO_L1_V1
    • COMPANYINFO_L2_V1
    • HIERARCHYCONNECTIONS_L1_V1
    • PRINCIPALSCONTACTS_L2_V2
POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789",
  "featuresOn": [
    "ACTIVATE_MASTER_DATA_BASIC"
  ]
}

Fetch LNKELI

It is possible to fetch LNKELI data:

POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789",
  "featuresOn": [
    "ACTIVATE_LINKAGE_LNKELI"
  ]
}
SecurityapiKey
Request
header Parameters
X-DNB-PASSWORD
string

Dnb Consumer Secret.

Example: dnb_consumer_key
X-DNB-USER
string

Dnb Consumer Key.

Example: dnb_consumer_key
Request Body schema:
required
cdqId
string

Unique identifier for the Business Partner.

Example: "VIES:PL8660001429"
featuresOff
Array of strings (DnbFetchFeature)

List of features to be deactivated.

Items Enum: Description
ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use management set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use linkage set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ENRICH_COMMERCIAL_ULTIMATE

Uses additional cmpelk calls to load whole organization hierarchy and detect global ultimate.

ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_CDQ_RECORD

Return also Dnb record mapped to cdq model.

DETECT_LEGAL_ENTITY

Finds out whether requested DUNS is a branch or headquarter.

ENRICH_DOMESTIC_COMMERCIAL_ULTIMATE

Calculates Domestic Ultimate hierarchy.

Example: ["ACTIVATE_MASTER_DATA_BASIC"]
featuresOn
Array of strings (DnbFetchFeature)

List of features to be activated.

Items Enum: Description
ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use management set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use linkage set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ENRICH_COMMERCIAL_ULTIMATE

Uses additional cmpelk calls to load whole organization hierarchy and detect global ultimate.

ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_CDQ_RECORD

Return also Dnb record mapped to cdq model.

DETECT_LEGAL_ENTITY

Finds out whether requested DUNS is a branch or headquarter.

ENRICH_DOMESTIC_COMMERCIAL_ULTIMATE

Calculates Domestic Ultimate hierarchy.

Example: ["ACTIVATE_MASTER_DATA_BASIC"]
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/dnb/businesspartners/fetch
Request samples
{
  • "cdqId": "VIES:PL8660001429",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
{
  • "cmpelkV2": {
    },
  • "dataBlock": {
    },
  • "lnkeli": {
    },
  • "commercialUltimate": {
    },
  • "cdqRecord": {
    },
  • "cdqCommercialUltimate": {
    },
  • "legalEntity": {
    },
  • "status": "OK",
  • "message": "Service returned a correct response"
}

Fetch Supplier Gateway Record

Fetches a Supplier Gateway record by providing the necessary information and returns the fetched record.

SecurityapiKey
Request
Request Body schema: application/json
required
cdqId
string

CDQ ID of the supplier gateway record to fetch.

Example: "VIES:DE119267630"
featuresOn
Array of strings

List of features to be activated.

Items Value: Description
ENRICH_MINORITY_INDICATOR

Enrich the supplier gateway record with the minority indicator.

Example: ["ENRICH_MINORITY_INDICATOR"]
supplierNumber
string

Supplier Number to fetch the Record.

Example: "SUP12345"
Responses
200

successful operation

post/sgw/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "VIES:DE119267630",
  • "supplierNumber": "SUP12345",
  • "featuresOn": [
    ]
}
Response samples
{
  • "cdqId": "VIES:DE119267630",
  • "supplierGateway": {
    },
  • "minorityIndicator": {
    }
}

Generate Golden Record

Create a Business Partner's golden record by computing the matching score using data completeness. The golden record generated has the highest matching score.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

cdqId
string

CDQ ID of the Golden Record.

Example: "VIES:PL1132639219"
featuresOn
Array of strings (BusinessPartnerGoldenRecordFeatureEnum)

List of features to be activated.

Items Value: Description
SHOW_FORMATTED_SAP_RECORD

Show formatted sap records in the golden record response.

Example: ["SHOW_FORMATTED_SAP_RECORD"]
Responses
200

OK

400

Bad Request

post/v3/businesspartners/goldenrecord
Request samples
application/json
{
  • "cdqId": "VIES:PL1132639219",
  • "featuresOn": [
    ]
}
Response samples
application/json
{
  • "cdqId": "VIES:PL1132639219",
  • "matchingProfile": {
    },
  • "businessPartner": {
    },
  • "metadata": [
    ],
  • "businessPartnerChanges": []
}

Lookup Business Partners

Perform a Business Partner lookup operation across all available Data Sources. The output of this operation will be a comprehensive list of Business Partners, each accompanied by their respective Data Sources and meticulously calculated matching scores. It is important to note that all accessible data sources are comprehensively documented within the Data_source Category on CDQ Wiki.

The Data Sources are categorized as follows:

  • OPEN: These Data Sources are open to everyone without any registration requirement.
  • FREE: These Data Sources are free to use, but registration is required.
  • COMMERCIAL: These Data Sources are only available to commercial users.

The results of the Business Partner lookup operation are sorted in descending order based on their matching scores. Additionally, the results are conveniently paginated, allowing for efficient navigation through the extensive list. The page size can be effortlessly customized to accommodate specific preferences.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

object (BusinessPartnerParam)

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

configurationId
string (ReferenceDataConfigurationId)

Configuration ID used to set up lookup. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

  • dataSource
  • dataMatchingDefinitionId
  • matchingThreshold
  • maxCandidates
  • pageSize (deprecated)
  • limit
  • featuresOn
  • featuresOff
Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
dataSources
Array of strings

Filter data sources used during lookup.

Example: ["VIES"]
featuresOff
Array of strings (businessPartnerFeaturesDescription)

List of features to be deactivated.

Items Enum: Description
ACTIVATE_IDENTIFIER_ONLY_MATCH

Executes lookup based only on identifier. Company names and addresses will not affect results.

ACTIVATE_DATASOURCE_CDQ_POOL

Add results from CDQ Data Sharing Community Data Pool to the lookup results.

ACTIVATE_DATASOURCE_CDL

DEPRECATED Please use ACTIVATE_DATASOURCE_CDQ_POOL instead

ACTIVATE_DATASOURCE_BZST

dd results from Bzst to the lookup results.

ACTIVATE_DATASOURCE_VIES_FOR_ES

Use VIES to check for data correctness (only for spanish records).

ACTIVATE_DATASOURCE_GOOGLEPLACES

Add results from Google Places to the lookup results.

ACTIVATE_DATASOURCE_STORAGES

Add results from organizational data mirrors to the lookup results.

ACTIVATE_DATASOURCE_DNB

Add results from DNB to the lookup results. Works only when in organization setting the dnb credentials are provided or when X-DNB-USER and X-DNB-PASSWORD is set.

ACTIVATE_DATASOURCE_BVD

Add results from BVD to the lookup results.

ACTIVATE_DATASOURCE_NLBR

Add results from the Netherlands Company Register NL.BR to the lookup results. Works only when in organization setting the NL.BR credentials are provided.

ACTIVATE_DATASOURCE_ZEFIX

Add results from the Swiss Business Partner register Zefix.

CURATE_REQUEST

Curate Lookup results with data curation. Active by default.

ENABLE_IDENTIFIER_DERIVATION

Use fuzzy matching when searching with identifiers.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

MATCHING_SCORE_CALCULATION

Calculate matching score. Active by default.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_FORMATTED_ADDRESS

Formats addresses using data curation procedure.

SHOW_FORMATTED_SAP_RECORD

Show formatted sap records in the lookup response.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request without performing enrichment.

GOLDENRECORD_INLINE

Includes golden record at first position in array of values

GOLDENRECORD_INLINE_SORTED

Includes golden record in values array in response

SHOW_INCOMPLETE_CANDIDATES

Do not filter out search results without complete address data.

SHOW_REGISTERED_INDIVIDUAL

Show individual personas registered in company registers.

SHOW_SUBSCRIPTION_METADATA

Provide information whether current user is subscribed to given business partner, and overall subscription count.

FORCE_DATA_SOURCES_INTERSECTION

If used with augmentation configuration and data sources are provided in the request, lookup will be performed using the intersection of data sources from request and configuration

ACTIVATE_MASTER_DATA_BASIC_BVD

Returns Master Data Basic from BvD

ACTIVATE_MASTER_DATA_EXTENDED_BVD

Returns Master Data Extended from BvD

ACTIVATE_FINANCIAL_RISK_DATA_BVD

Returns Financial Risk Data from BvD

ACTIVATE_OWNERSHIP_DATA_BVD

Returns Ownership Data from BvD

Example: ["ACTIVATE_DATASOURCE_BVD"]
featuresOn
Array of strings (businessPartnerFeaturesDescription)

List of features to be activated.

Items Enum: Description
ACTIVATE_IDENTIFIER_ONLY_MATCH

Executes lookup based only on identifier. Company names and addresses will not affect results.

ACTIVATE_DATASOURCE_CDQ_POOL

Add results from CDQ Data Sharing Community Data Pool to the lookup results.

ACTIVATE_DATASOURCE_CDL

DEPRECATED Please use ACTIVATE_DATASOURCE_CDQ_POOL instead

ACTIVATE_DATASOURCE_BZST

dd results from Bzst to the lookup results.

ACTIVATE_DATASOURCE_VIES_FOR_ES

Use VIES to check for data correctness (only for spanish records).

ACTIVATE_DATASOURCE_GOOGLEPLACES

Add results from Google Places to the lookup results.

ACTIVATE_DATASOURCE_STORAGES

Add results from organizational data mirrors to the lookup results.

ACTIVATE_DATASOURCE_DNB

Add results from DNB to the lookup results. Works only when in organization setting the dnb credentials are provided or when X-DNB-USER and X-DNB-PASSWORD is set.

ACTIVATE_DATASOURCE_BVD

Add results from BVD to the lookup results.

ACTIVATE_DATASOURCE_NLBR

Add results from the Netherlands Company Register NL.BR to the lookup results. Works only when in organization setting the NL.BR credentials are provided.

ACTIVATE_DATASOURCE_ZEFIX

Add results from the Swiss Business Partner register Zefix.

CURATE_REQUEST

Curate Lookup results with data curation. Active by default.

ENABLE_IDENTIFIER_DERIVATION

Use fuzzy matching when searching with identifiers.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

MATCHING_SCORE_CALCULATION

Calculate matching score. Active by default.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_FORMATTED_ADDRESS

Formats addresses using data curation procedure.

SHOW_FORMATTED_SAP_RECORD

Show formatted sap records in the lookup response.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request without performing enrichment.

GOLDENRECORD_INLINE

Includes golden record at first position in array of values

GOLDENRECORD_INLINE_SORTED

Includes golden record in values array in response

SHOW_INCOMPLETE_CANDIDATES

Do not filter out search results without complete address data.

SHOW_REGISTERED_INDIVIDUAL

Show individual personas registered in company registers.

SHOW_SUBSCRIPTION_METADATA

Provide information whether current user is subscribed to given business partner, and overall subscription count.

FORCE_DATA_SOURCES_INTERSECTION

If used with augmentation configuration and data sources are provided in the request, lookup will be performed using the intersection of data sources from request and configuration

ACTIVATE_MASTER_DATA_BASIC_BVD

Returns Master Data Basic from BvD

ACTIVATE_MASTER_DATA_EXTENDED_BVD

Returns Master Data Extended from BvD

ACTIVATE_FINANCIAL_RISK_DATA_BVD

Returns Financial Risk Data from BvD

ACTIVATE_OWNERSHIP_DATA_BVD

Returns Ownership Data from BvD

Example: ["ACTIVATE_DATASOURCE_BVD"]
limit
integer [ 0 .. 1000 ]

Number of items per page. Default value is 10.

Example: "20"
matchingThreshold
number <double> [ 0 .. 1 ]

Matching threshold for the lookup process. Default value is 0.5.

Example: "0.5"
maxCandidates
integer [ 20 .. 200 ]

Maximum number of candidates to be returned. Default value is 50.

Example: "50"
startAfter
string

The ID which is used to read the page.

Example: "5712566172571652"
Array of objects (StoragesDataSource)

This field allows to filter data mirrors that will be queried. For each data mirror, data sources can also be filtered. Leave empty to include all available data mirrors in query.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

429
Message ID Technical Key Message
429000007 CREDITS_EXCEEDED Credits exceeded. There is not enough credits to execute the request. Contact sales to get additional credits
post/v4/businesspartners/lookup
Request samples
application/json
{
  • "matchingThreshold": 0,
  • "pageSize": 10,
  • "page": 0,
  • "dataSources": [
    ],
  • "businessPartner": {
    }
}
Response samples
application/json
{
  • "cdqId": "VIES:CZ46981691",
  • "dataSource": {
    },
  • "businessPartner": {
    }
}

Search Business Partners

Use for single queries to quickly find a Business Partner. User have to verify the results. To be used when Business Partner is not normalized e.g. Company Name and Address are in one line.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

page
integer (schemas-Page) >= 0
Default: 0

Current page number.

Example: "1"
pageSize
integer (PageSize) [ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"
query
string non-empty

Pattern which will be used to search in multiple fields.

Example: "CDQ Lukasstrasse 4, Sankt Gallen 9000"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/search
Request samples
application/json
{
  • "query": "CDQ, 50-078 Wrocław"
}
Response samples
application/json
{
  • "pageSize": "10",
  • "totals": "67",
  • "page": "1",
  • "values": [
    ]
}

Simplified Lookup Business Partners

Perform a comprehensive Business Partner lookup across all accessible Data Sources. This endpoint offers a simplified HTTP GET method for conducting the lookup. However, it only offers a limited set of default features. For the complete range of features, it is recommended to utilize the HTTP POST version.

SecurityapiKey
Request
query Parameters
country
string

The country (ISO code) of the Business Partner address.

Example: country=CH
identifier
string

An identifier (the value, number, payload) of the Business Partner.

Example: identifier=CHCHE218608886
identifierType
string

The type of given identifier of the Business Partner.

Example: identifierType=BVD_ID
locality
string

The locality (city) of the Business Partner address.

Example: locality=Sankt Gallen
name
string

The name of the Business Partner.

Example: name=CDQ
postCode
string

The postal code of the Business Partner address.

Example: postCode=9000
thoroughfare
string

The thoroughfare (street, incl. house number) of the Business Partner address.

Example: thoroughfare=Lukasstrasse 4
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/v3/businesspartners/lookup
Request samples 
Response samples 
application/json
{
  • "total": "67",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ],
  • "goldenRecord": {
    },
  • "debugInfo": {
    },
  • "annotations": [
    ]
}