Fetch Business Partner

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

Request Body schema: application/json
required

object

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

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

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

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

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v4/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"cdqId": "VIES:CZ46981691"
}

Response samples

application/json

{"cdqId": "VIES:CZ46981691",
"dataSource": {"aleiPrefix": "VIES",
"name": "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 Partner

Request Body schema: application/jsonrequired

Request Body schema: application/json
required