Lookup Business Partners

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

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

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"

dataMatchingDefinitionId

string

Deprecated

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

Example: "6461e6113b1865304b3038b6"

dataSource

string

Deprecated

Data source to be used for the lookup.

Example: "VIES"

dataSources

Array of strings

Filter data sources used during lookup

Example: ["VIES"]

featuresOff

Array of strings (businessPartnerFeaturesDescription)

The 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 at least one pair of any dnb credentials are provided and given data source is active.
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.

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 at least one pair of any dnb credentials are provided and given data source is active.
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.

Example: "100"

matchingThreshold

number <double> [ 0 .. 1 ]

Matching threshold for the lookup. Default 0.5.

Example: "0.8"

maxCandidates

integer [ 20 .. 200 ]

Maximum number of candidates to be returned. Default 10.

Example: "20"

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"

page

integer >= 0

Default: 0

Current page number.

Example: "1"

pageSize

integer (PageSize) [ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"

startAfter

string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

Array of objects

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

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"matchingThreshold": 0,
"pageSize": 10,
"page": 0,
"dataSources": ["string"
],
"businessPartner": {"names": [{"value": "string"
}
],
"identifiers": [{"value": "string",
"type": {"technicalKey": "string"
}
}
],
"legalForm": {"value": "string"
},
"addresses": [{"thoroughfares": [{"value": "string",
"number": "string"
}
],
"localities": [{"value": "string"
}
],
"administrativeAreas": [{"value": "string"
}
],
"postCodes": [{"value": "string"
}
],
"country": {"shortName": "string"
}
}
]
}
}

Response samples

application/json

{"pageSize": 10,
"totals": 2,
"page": 0,
"limit": 10,
"startAfter": "RVtH+Q==",
"nextStartAfter": "RVtH8w==",
"values": [{"cdqId": "VIES:PL9280012700",
"dataSource": "VIES",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "MAYBE_MATCH",
"name": "Maybe Match"
},
"value": 0.9,
"explanation": "BP: [overall: [EU_VAT_ID_PL: 0.9; overall: 0.9;]] A: []"
},
"businessPartner": {"classification": {"technicalKey": "FULL_MATCH",
"name": "Full Match"
},
"value": 0.9
},
"address": {"classification": {"technicalKey": "NO_MATCH",
"name": "No Match"
},
"value": 0.5
}
}
},
"businessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type/vat_registered_name",
"name": "VAT Registered Name",
"technicalKey": "VAT_REGISTERED"
},
"value": "SWISS KRONO SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ"
}
],
"legalForm": {"name": "Spółka z ograniczoną odpowiedzialnością",
"url": "https://meta.cdq.com/Business_partner/legal_form/technical_key/PL_2712",
"mainAbbreviation": "Sp. z o.o.",
"technicalKey": "PL_2712"
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/European_value_added_tax_identifier_(Poland)",
"name": "Value added tax identification number",
"technicalKey": "EU_VAT_ID_PL"
},
"value": "PL9280012700",
"status": {"technicalKey": "ACTIVE"
}
}
],
"categories": [ ],
"addresses": [{"country": {"shortName": "PL",
"value": "Poland"
},
"administrativeAreas": [ ],
"postCodes": [{"value": "68-200",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type/regular",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"value": "Żary"
}
],
"thoroughfares": [{"shortName": "Serbska",
"number": "56",
"value": "Serbska"
}
],
"premises": [ ],
"types": [{"name": "VAT Registered Address",
"url": "https://meta.cdq.com/Address/type/vat_registered_address",
"technicalKey": "VAT_REGISTERED"
}
]
}
],
"externalId": "PL9280012700",
"types": [ ]
}
},
{"cdqId": "PL.NOBR:9280012700",
"dataSource": "PL.NOBR",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "MAYBE_MATCH",
"name": "Maybe Match"
},
"value": 0.89,
"explanation": "BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: []"
},
"businessPartner": {"classification": {"technicalKey": "FULL_MATCH",
"name": "Full Match"
},
"value": 0.89
},
"address": {"classification": {"technicalKey": "NO_MATCH",
"name": "No Match"
},
"value": 0.5
}
}
},
"businessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type/local",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "SWISS KRONO SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ"
}
],
"legalForm": {"name": "Spółka z ograniczoną odpowiedzialnością",
"url": "https://meta.cdq.com/Business_partner/legal_form/technical_key/PL_2712",
"mainAbbreviation": "Sp. z o.o.",
"technicalKey": "PL_2712"
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/REGON_(Poland)",
"name": "Rejestr Gospodarki Narodowej",
"technicalKey": "PL_REG"
},
"value": "970327738"
},
{"type": {"url": "https://meta.cdq.com/NIP_number_(Poland)",
"name": "Numer Identyfikacji Podatkowej",
"technicalKey": "PL_NIP"
},
"value": "9280012700"
}
],
"categories": [{"name": "Company",
"url": "https://meta.cdq.com/Business_partner/category/company",
"technicalKey": "COMPANY"
}
],
"addresses": [{"country": {"shortName": "PL",
"value": "Poland"
},
"administrativeAreas": [{"value": "LUBUSKIE"
},
{"value": "żarski"
},
{"value": "Żary"
}
],
"postCodes": [{"value": "68-200",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type/regular",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"value": "Żary"
}
],
"thoroughfares": [{"shortName": "ul. Serbska",
"number": "56",
"value": "ul. Serbska"
}
],
"premises": [ ],
"types": [{"name": "Registered Address",
"url": "https://meta.cdq.com/Address/type/registered_address",
"technicalKey": "REGISTERED"
}
]
}
],
"externalId": "9280012700",
"types": [ ]
}
}
]
}

Lookup Business PartnersWSDL

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required