Fetch Business Partner

V3 (latest)

What's New

Knowledge Base

Getting started

Knowledge-Base

Developer Guidelines

Tutorials

Instructions

API Catalogue

Bankaccount Data API

Case Management API

Data Clinic API

Data Compliance API

Data Curation API

Data Exchange API

Data Matching API

Data Validation API

Email Analysis API

Knowledge Graph API

Metadata API

Organization Management API

Product Identification API

Reference Data API

Resources

Batch Lookup

Create Supplier Gateway Record

post

Fetch Batch Business Partners

post

Fetch Business Partner

post

Fetch Business Partner Relations

post

Fetch DNB Record

post

Fetch Supplier Gateway Record

post

Generate Golden Record

post

Lookup Business Partners

post

Search Business Partners

get

Simplified Lookup Business Partners

Configurations

Registrations

Vendor Extensions

Salesforce API

SAP DQM API

SAP ODM API

SAP BN API

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:

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

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"cdqId": "VIES:CZ46981691"
}

Response samples

application/json

{"cdqId": "VIES:CZ46981691",
"dataSource": "VIES",
"businessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type/vat_registered_name",
"name": "VAT Registered Name",
"technicalKey": "VAT_REGISTERED"
},
"value": "TESCOMA s.r.o.",
"language": { }
}
],
"identifiers": [{"type": {"url": "https://meta.cdq.com/European_value_added_tax_identifier_(Czech_Republic)",
"name": "Value added tax identification number",
"technicalKey": "EU_VAT_ID_CZ"
},
"value": "CZ46981691",
"status": {"technicalKey": "ACTIVE"
}
}
],
"categories": [ ],
"addresses": [{"version": {"characterSet": {"name": "Latin",
"technicalKey": "LATIN"
},
"language": {"name": "en",
"technicalKey": "en"
}
},
"country": {"shortName": "CZ",
"value": "Czechia"
},
"administrativeAreas": [ ],
"postCodes": [{"value": "760 01",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type/regular",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"value": "Zlín"
}
],
"thoroughfares": [{"type": {"name": "Street",
"url": "https://meta.cdq.com/Address/thoroughfare/type/street",
"technicalKey": "STREET"
},
"number": "1",
"value": "U Tescomy Lužkovice"
}
],
"premises": [ ],
"postalDeliveryPoints": [ ],
"types": [{"name": "VAT Registered Address",
"url": "https://meta.cdq.com/Address/type/vat_registered_address",
"technicalKey": "VAT_REGISTERED"
}
],
"formattedAddress": {"country": "Czechia",
"locality": "Zlín",
"postalCode": "760 01",
"thoroughfare": "U Tescomy Lužkovice 1"
}
}
],
"formattedSapRecord": {"narp": "NO",
"stceg": "CZ46981691",
"country": "Czechia",
"countryCode": "CZ",
"city": "Zlín",
"postalCode": "760 01",
"street1": "U Tescomy Lužkovice",
"houseNum": "1"
},
"types": [ ]
}
}

Fetch Business PartnerWSDL

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required