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 Business PartnerWSDL

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

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

cmd

cdqId
string

CDQ ID for Business Partner and address.

Example: "VIES:DE123456789"
featuresOff
Array of strings (BusinessPartnerFetchFeatures)

List of features to be deactivated.

Items Enum: Description
ENABLE_SETTINGS

Enables settings for the lookup.

ACTIVATE_DATASOURCE_BVD

Enables BVD data source for the lookup.

ACTIVATE_DATASOURCE_DNB

Enables DNB data source for the lookup.

Example: ["[ \"ENABLE_SETTINGS\", \"LAB_ENABLE_BETA_FEATURES\" ]"]
featuresOn
Array of strings (BusinessPartnerFetchFeatures)

List of features to be activated.

Items Enum: Description
ENABLE_SETTINGS

Enables settings for the lookup.

ACTIVATE_DATASOURCE_BVD

Enables BVD data source for the lookup.

ACTIVATE_DATASOURCE_DNB

Enables DNB data source for the lookup.

Example: ["[ \"ENABLE_SETTINGS\", \"LAB_ENABLE_BETA_FEATURES\" ]"]
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartners/fetch
Request samples
{
  • "cdqId": "VIES:DE123456789",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
{}

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

Lookup Business PartnersWSDL

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
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: application/json
required

cmd

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.

dataMatchingDefinitionId
string
Deprecated

The data matching definition ID to be used for the lookup. If not provided, the default data matching definition will be used.

Example: "6400955811c68a034bcef311"
dataSource
string (DataSourceParam)

External Data Source.

Enum: Description
AR.NRC

Argentina National Registry of Companies.

AT.CR

Austria Company Register.

AT.FON

Austria Federal Office for National Economic Supply.

AU.BR

Australia Business Register.

BE.CCD

Belgium Crossroads Bank for Enterprises.

BR.RF

Brazil Receita Federal.

BZST

Germany Federal Central Tax Office.

CA.CRL

Canada Corporate Registry.

CZ.REE

Czech Republic Register of Economic Entities.

CZ.VAT

Czech Republic Register of VAT payers.

CDL

CDQ Legal Entity Identifier.

CDQ.POOL

CDQ Data Sharing Community Data Pool.

CDQ.TEST

CDQ Test Data Pool.

CX.POOL

Catena-X Pool.

CX.BPN

Catena-X Business Partner Numbers.

CDQ.CRAWLED

CDQ Crawled.

CH.CR

Switzerland Company Register.

CH.UIDR

Switzerland UID Register.

DATAMIRROR

CDQ Data Mirror.

DE.RC

Germany Company Register.

DNB

Dun & Bradstreet.

DNB.LINKAGE.LNKELI

Dun & Bradstreet Linkage LNKELI.

DNB.MASTER.DATA.BASIC

Dun & Bradstreet Master Data Basic.

DNB.MASTER.DATA.EXTENDED

Dun & Bradstreet Master Data Extended.

EE.CR

Estonia Company Register.

EU.EORI

European Union Economic Operators Registration and Identification.

UK.EORI

United Kingdom Economic Operators Registration and Identification.

FR.RC

France Company Register.

GB-EAW.CR

United Kingdom Company Register.

GOOGLEPLACES

Google Places.

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.

MX.SBI

Mexico Sistema de Administración Tributaria.

NL.BR

Netherlands Company Register.

PL.NOBR

Poland National Official Business Register.

US.SEC

US Securities and Exchange Commission.

US-AK.BER

US Alaska Business Entity Report.

US-FL.BER

US Florida Business Entity Report.

US-LA.BER

US Louisiana Business Entity Report.

US-SF.BER

US South Dakota Business Entity Report.

US-NY.BER

US New York Business Entity Report.

US-IO.BER

US Iowa Business Entity Report.

US-OR.BER

US Oregon Business Entity Report.

US-WA.BER

US Washington Business Entity Report.

US-WY.BER

US Wyoming Business Entity Report.

US-CO.BER

US Colorado Business Entity Report.

SG.BR

Singapore Business Register.

VIES

VAT Information Exchange System.

DK.CR

Denmark Company Register.

NO.RBE

Norway Register of Business Enterprises.

LV.CR

Latvia Company Register.

NZ.CR

New Zealand Company Register.

SPOR.OMS

SPOR OMS.

UK.VAT

United Kingdom VAT.

SK.FS

Slovakia Financial Statements.

SK.VAT

Slovakia Financial Statements - VAT payers.

RO.TR

Romania Trade Register.

RU.SME

Unified Register of small and medium-sized businesses.

US.EDU

US Education.

ACCUITY

Bankers Almanac for Payments.

AT.GCB

Austria Global Compliance Business.

SK.GCB

Slovakia Global Compliance Business.

NL.GCB

Netherlands Global Compliance Business.

NO.GCB

Norway Global Compliance Business.

BVD

Bureau van Dijk.

LU.GCB

Luxembourg Global Compliance Business.

LT.GCB

Lithuania Global Compliance Business.

MT.GCB

Malta Global Compliance Business.

GR.GCB

Greece Global Compliance Business.

BE.GCB

Belgium Global Compliance Business.

DE.GCB

Germany Global Compliance Business.

CZ.GCB

Czech Republic Global Compliance Business.

CH.GCB

Switzerland Global Compliance Business.

IE.GCB

Ireland Global Compliance Business.

PL.GCB

Poland Global Compliance Business.

CY.GCB

Cyprus Global Compliance Business.

PEPPOL

Pan-European Public Procurement On-Line.

CHORUS.PRO

Chorus Pro Information System.

TW.CR

Taiwan Company Register.

Example: "CDQ"
featuresOff
Array of strings (businessPartnerFeaturesDescription)

The features to be deactivated in the lookup.

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)

The features to be activated in the lookup.

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"]
matchingThreshold
number <double> [ 0 .. 1 ]
Default: 0.5

The threshold for the matching score. Only results with a score greater than or equal to the threshold will be returned.

Example: "0.5"
page
integer (Page) >= 0
Default: 0

Current page number.

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

Number of items per page. Default 10.

Example: "10"
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/v2/businesspartners/lookup
Request samples
application/json
{
  • "businessPartner": {
    },
  • "dataSource": "CDQ",
  • "dataMatchingDefinitionId": "6400955811c68a034bcef311",
  • "matchingThreshold": "0.5",
  • "pageSize": "10",
  • "page": "1",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
application/json
{
  • "pageSize": "10",
  • "totals": "67",
  • "page": "1",
  • "values": [
    ],
  • "goldenRecord": {
    },
  • "debugInfo": {
    }
}

Read CMPELK productDeprecated

Fetch CMPELK product for a given CDQ-ID.

SecurityapiKey
Request
path Parameters
cdqId
required
string

Read CMPELK product for this CDQ-ID.

Example: DNB:123456
header Parameters
X-DNB-PASSWORD
required
string

Dnb Consumer Secret.

Example: dnb_consumer_key
X-DNB-USER
required
string

Dnb Consumer Key.

Example: dnb_consumer_key
Responses
200

successful operation

get/businesspartners/{cdqId}/cmpelk
Request samples
Response samples
{
  • "transactionDetail": {
    },
  • "inquiryDetail": {
    },
  • "organization": {
    }
}

Read Commercial UltimateDeprecated

Fetch Commercial Ultimate for a given CDQ-ID.

SecurityapiKey
Request
path Parameters
cdqId
required
string

Read Commercial Ultimate for this CDQ-ID.

Example: DNB:123456
header Parameters
X-DNB-PASSWORD
required
string

Dnb Consumer Secret.

Example: dnb_consumer_key
X-DNB-USER
required
string

Dnb Consumer Key.

Example: dnb_consumer_key
Responses
200

successful operation

get/businesspartners/{cdqId}/commercialUltimate
Request samples
Response samples
{
  • "duns": "804735132",
  • "primaryName": "Acme Corporation",
  • "primaryAddress": {
    },
  • "path": [
    ],
  • "cmpelkV2": {
    },
  • "dataBlock": {
    }
}