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

Payload
curl
Python
Java
Node.js

application/json

{"supplierGateway": {"CompanyName": "Acme Corporation",
"EIN": "12-3456789",
"SupplierNumber": "SUP12345",
"Address": "123 Main St",
"Address2": "Suite 100",
"City": "Springfield",
"State": "IL",
"Country": "USA",
"Zip": "62701",
"ZipPlus": "62701-1234",
"Phone": "(123) 456-7890",
"Category": "Manufacturing",
"Ethnicity": "Not disclosed",
"ContactFirstName": "John",
"ContactLastName": "Doe",
"ContactEmail": "johndoe@example.com",
"RequiredtoReport": "Yes",
"YearEstablished": "2000",
"NumberOfEmployee": "100",
"Capabilities": "Manufacturing, Distribution",
"Duns": "15-048-3782",
"Naics": "541511",
"ProductListing": "Product A, Product B",
"ServiceListing": "Service X, Service Y",
"Certificates": [{"CertID": "CERT12345",
"CertNo": "12345",
"CertifiedDate": "2024-11-12T20:37:03Z",
"ExpirationDate": "2024-11-12T20:37:03Z",
"Attachments": {"Title": "Certificate Document",
"Url": "https://example.com/certificate.pdf"
}
}
]
}
}

Response samples

{"Code": "200",
"Message": "Supplier gateway successfully created",
"Supplier": {"SupplierNumber": "SUP12345",
"TaxID": "12-3456789",
"CompanyName": "Acme Corporation",
"ContactName": "John Doe",
"Address": "123 Main St, Springfield, IL",
"City": "Springfield",
"State": "IL",
"Country": "USA",
"Zip": "62701",
"ZipPlus": "62701-1234",
"Phone": "(123) 456-7890",
"Fax": "(123) 456-7891",
"Email": "contact@acme.com",
"Web": "https://www.acme.com",
"Duns": "15-048-3782",
"yearEstablished": "2000",
"NumberOfEmployee": "100",
"Capability": "Manufacturing, Distribution",
"Status": "Active",
"Acct": "ACC12345",
"LastAct": "2024-11-12T20:37:03Z",
"SBASDB": "Yes",
"Hub": "Yes",
"HubExp": "2024-11-12T20:37:03Z",
"Validated": "Yes",
"Preg": "PREG12345",
"PregStart": "2024-11-12T20:37:03Z",
"PregComp": "2024-11-12T20:37:03Z",
"PregStat": "Completed",
"Mospnd18": "MOSPND12345",
"Moamt18": "MOAMT12345",
"MasterSupplierNo": "MSUP12345",
"Tier2Required": "Yes",
"Categories": [{"Name": "Manufacturing",
"Abbreviation": "MFG"
}
],
"Ethnicities": [{"Name": "Hispanic",
"Abbreviation": "HISP"
}
],
"Certifications": [{"Name": "ISO 9001",
"Abbreviation": "ISO9K",
"CertDate": "2024-11-12T20:37:03Z",
"ExpDate": "2024-11-12T20:37:03Z",
"CertNo": "CERT12345"
}
],
"Banks": [{"BankName": "Bank of Springfield",
"AccountType": "Business Checking",
"AccountNumber": "123456789",
"RouteNumber": "987654321",
"Address": "456 Market St, Springfield, IL",
"CityRegion": "Springfield",
"StateProvince": "IL",
"PostalCode": "62702",
"Country": "USA"
}
]
}
}

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

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

{"cdqId": "VIES:DE123456789",
"featuresOn": ["[ \"ENABLE_SETTINGS\", \"LAB_ENABLE_BETA_FEATURES\" ]"
],
"featuresOff": ["[ \"ENABLE_SETTINGS\", \"LAB_ENABLE_BETA_FEATURES\" ]"
]
}

Response samples

{"dataSource": "648824a691d8d2503d65103e",
"businessPartner": {"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"language": "DE",
"type": {"name": "Local Name",
"technicalKey": "LOCAL",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"partnerProfile": {"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"
},
"value": "+41 71 571 10 40"
}
],
"websites": ["https://cdq.com"
]
},
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen",
"status": "ACTIVE",
"validFrom": "2024-11-12T20:37:03Z",
"validTo": "2024-11-12T20:37:03Z",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"classifications": [{"code": "20.20Z",
"label": "Manufacture of pesticides and other agrochemical products.",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"addresses": [{"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "shortNamePostCode",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"openingHours": ["09:00 AM - 05:00 PM"
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"types": [{"name": "Legal Entity",
"technicalKey": "LEGAL_ENTITY",
"url": "https://meta.cdq.com/Business_partner/type"
}
]
},
"rawRecord": [{"key": "key",
"value": "value"
}
]
}

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

Payload
curl
Python
Java
Node.js

application/json

{"cdqId": "VIES:DE119267630",
"supplierNumber": "SUP12345",
"featuresOn": ["ENRICH_MINORITY_INDICATOR"
]
}

Response samples

{"cdqId": "VIES:DE119267630",
"supplierGateway": {"Code": "200",
"Message": "Supplier gateway successfully created",
"Supplier": {"SupplierNumber": "SUP12345",
"TaxID": "12-3456789",
"CompanyName": "Acme Corporation",
"ContactName": "John Doe",
"Address": "123 Main St, Springfield, IL",
"City": "Springfield",
"State": "IL",
"Country": "USA",
"Zip": "62701",
"ZipPlus": "62701-1234",
"Phone": "(123) 456-7890",
"Fax": "(123) 456-7891",
"Email": "contact@acme.com",
"Web": "https://www.acme.com",
"Duns": "15-048-3782",
"yearEstablished": "2000",
"NumberOfEmployee": "100",
"Capability": "Manufacturing, Distribution",
"Status": "Active",
"Acct": "ACC12345",
"LastAct": "2024-11-12T20:37:03Z",
"SBASDB": "Yes",
"Hub": "Yes",
"HubExp": "2024-11-12T20:37:03Z",
"Validated": "Yes",
"Preg": "PREG12345",
"PregStart": "2024-11-12T20:37:03Z",
"PregComp": "2024-11-12T20:37:03Z",
"PregStat": "Completed",
"Mospnd18": "MOSPND12345",
"Moamt18": "MOAMT12345",
"MasterSupplierNo": "MSUP12345",
"Tier2Required": "Yes",
"Categories": [{"Name": "Manufacturing",
"Abbreviation": "MFG"
}
],
"Ethnicities": [{"Name": "Hispanic",
"Abbreviation": "HISP"
}
],
"Certifications": [{"Name": "ISO 9001",
"Abbreviation": "ISO9K",
"CertDate": "2024-11-12T20:37:03Z",
"ExpDate": "2024-11-12T20:37:03Z",
"CertNo": "CERT12345"
}
],
"Banks": [{"BankName": "Bank of Springfield",
"AccountType": "Business Checking",
"AccountNumber": "123456789",
"RouteNumber": "987654321",
"Address": "456 Market St, Springfield, IL",
"CityRegion": "Springfield",
"StateProvince": "IL",
"PostalCode": "62702",
"Country": "USA"
}
]
}
},
"minorityIndicator": {"supplierNumber": "SUP12345",
"minorityIndicator": "Social enterprise"
}
}

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

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/v2/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"names": [{"value": "Concept name or value"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "ABN_AU"
}
}
],
"legalForm": {"value": "Aktiengesellschaft"
},
"address": {"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
],
"localities": [{"value": "Concept name or value"
}
],
"administrativeAreas": [{"value": "Concept name or value"
}
],
"postCode": {"value": "Concept name or value"
},
"country": {"value": "Concept name or value"
}
}
},
"dataSource": "CDQ",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"matchingThreshold": "0.5",
"pageSize": "10",
"page": "1",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
}

Response samples

application/json

{"pageSize": "10",
"totals": "67",
"page": "1",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "648824a691d8d2503d65103e",
"subscriptionMetadata": {"subscribed": "true",
"numberOfSubscribers": "50"
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"language": "DE",
"type": {"name": "Local Name",
"technicalKey": "LOCAL",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen",
"status": "ACTIVE",
"validFrom": "2024-11-12T20:37:03Z",
"validTo": "2024-11-12T20:37:03Z",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"partnerProfile": {"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": null,
"url": null
},
"value": "+41 71 571 10 40"
}
],
"websites": ["https://cdq.com"
]
},
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"classifications": [{"code": "20.20Z",
"label": "Manufacture of pesticides and other agrochemical products.",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"address": {"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "shortNamePostCode",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": null,
"url": null
}
}
],
"openingHours": ["09:00 AM - 05:00 PM"
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": null,
"url": null
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
},
"types": [{"name": "Legal Entity",
"technicalKey": "LEGAL_ENTITY",
"url": "https://meta.cdq.com/Business_partner/type"
}
]
},
"matchingScore": "0.9",
"addressMatchingScore": "0.9",
"businessPartnerMatchingScore": "0.9",
"matchingExplanation": "{'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}"
}
],
"goldenRecord": {"cdqId": "VIES:PL1132639219",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"language": "DE",
"type": {"name": "Local Name",
"technicalKey": "LOCAL",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen",
"status": "ACTIVE",
"validFrom": "2024-11-12T20:37:03Z",
"validTo": "2024-11-12T20:37:03Z",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"partnerProfile": {"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"
},
"value": "+41 71 571 10 40"
}
],
"websites": ["https://cdq.com"
]
},
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"classifications": [{"code": "20.20Z",
"label": "Manufacture of pesticides and other agrochemical products.",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"address": {"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "shortNamePostCode",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"openingHours": ["09:00 AM - 05:00 PM"
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
},
"types": [{"name": "Legal Entity",
"technicalKey": "LEGAL_ENTITY",
"url": "https://meta.cdq.com/Business_partner/type"
}
]
},
"metadata": [{"modifiedAt": "2024-11-12T20:37:03Z",
"modifiedBy": "76248934691294444",
"dataSource": {"name": "Receita Federal Brazil",
"technicalKey": "BR_RF"
},
"cdqId": "VIES:PL1132639219"
}
]
},
"debugInfo": {"features": [{"feature": "ACTIVATE_DATASOURCE_BVD",
"active": "true"
}
],
"request": {"businessPartner": {"names": [{"value": "Concept name or value"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "ABN_AU"
}
}
],
"legalForm": {"value": "Aktiengesellschaft"
},
"address": {"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
],
"localities": [{"value": "Concept name or value"
}
],
"administrativeAreas": [{"value": "Concept name or value"
}
],
"postCode": {"value": "Concept name or value"
},
"country": {"value": "Concept name or value"
}
}
},
"dataSource": "CDQ",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"matchingThreshold": "0.5",
"pageSize": "10",
"page": "1",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"curatedRequest": {"businessPartner": {"names": [{"value": "Concept name or value"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "ABN_AU"
}
}
],
"legalForm": {"value": "Aktiengesellschaft"
},
"address": {"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
],
"localities": [{"value": "Concept name or value"
}
],
"administrativeAreas": [{"value": "Concept name or value"
}
],
"postCode": {"value": "Concept name or value"
},
"country": {"value": "Concept name or value"
}
}
},
"dataSource": "CDQ",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"matchingThreshold": "0.5",
"pageSize": "10",
"page": "1",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"externalServiceResponses": [{"apiError": {"timestamp": "2024-11-12T20:37:03Z",
"message": "This user is not allowed to access this service.",
"error": "BAD_REQUEST",
"status": "400",
"path": "/v2/businesspartners/lookup",
"id": "REF_VIES_SERVICE_UNAVAILABLE_300"
},
"timestamp": "2024-11-12T20:37:03Z",
"httpStatus": "400",
"httpPath": "/v2/businesspartners/lookup",
"status": "OK",
"message": "VIES_NOT_AVAILABLE - Vies is currently not available",
"source": "CHUID",
"additionalInformations": [{"key": "KEY",
"value": "1"
}
]
}
]
}
}

Business Partners

Create Supplier Gateway Record

Request Body schema: application/jsonrequired

Fetch Business PartnerWSDL

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Fetch Supplier Gateway Record

Request Body schema: application/jsonrequired

Lookup Business PartnersWSDL

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema:
application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required