Business Partners

Everything about 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
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
cdqId
required
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 (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"]
outboundMapping
string (OutboundMapping)
Deprecated

If outboundMapping is set, business partner is transformed to the desired mapped record in a key-value representation.

Avaliable mappings:

  • SAP
Example: "SAP"
screeningMatchingThreshold
number

The matching threshold for compliance screening. If set and a fetch result is not above threshold, it will not be returned.

Example: "0.5"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "VIES:CZ46981691"
}
Response samples
application/json
{
  • "cdqId": "VIES:CZ46981691",
  • "dataSource": "VIES",
  • "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-07-11T07:22:27Z"
endedBefore
string

Find relations which endedAt is before given date.

Example: "2024-07-11T07:22:27Z"
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-07-11T07:22:27Z"
startedBefore
string

Find relations which startedAt is before given date.

Example: "2024-07-11T07:22:27Z"
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 Business Partners in BatchWSDL

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