Bulk Lookup

Create Bulk Lookup

Create a bulk to lookup multiple business partners at a time

SecurityapiKey

Request

Request Body schema: application/json
required

configurationId

string

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"

dataSources

Array of strings

Filter data sources used during lookup.

Example: ["VIES"]

featuresOff

Array of strings (businessPartnerFeaturesDescription)

List of 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 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)

List of 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 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"]

limit

integer [ 0 .. 1000 ]

Number of items per page. Default value is 10.

Example: "10"

matchingThreshold

number <double> [ 0 .. 1 ]

Matching threshold for the lookup process. Default value is 0.5.

Example: "0.5"

maxCandidates

integer [ 20 .. 200 ]

Maximum number of candidates to be returned. Default value is 50.

Example: "50"

startAfter

string

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.

required

Array of objects [ 1 .. 1000 ] items

List of tasks to be executed.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v4/businesspartners/lookup/bulks

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"featuresOn": ["SHOW_DEBUG_INFO"
],
"tasks": [{"id": "42010AEF0CEB1EEEACF7ECD80452F903__-/-",
"businessPartner": {"jsonRecord": {"addressData": [{"organizationPostalAddress": {"country": {"code": "DE"
},
"postCode": "69190",
"houseNumber": "16",
"street": {"name": "Dietmar-Hopp-Allee"
},
"primaryRegion": {"code": "08"
},
"town": {"name": "Walldorf"
}
}
}
],
"businessPartnerType": "organization",
"identifications": [{"identificationType": {"code": "BUP002"
},
"identificationNumber": "HRB 719915",
"entryDateVc": "-",
"country": {"code": "DE"
},
"institute": "Local Court Mannheim",
"validFrom": "2024-01-15",
"validTo": "9999-12-31"
},
{"identificationType": {"code": "DPI001"
},
"identificationNumber": "GR.LEI:529900PM64WH8AF1E917HQ",
"entryDateVc": "-",
"validFrom": "2024-01-15",
"validTo": "9999-12-31"
}
],
"organization": {"nameDetails": {"formattedOrgNameLine1": "SAP SE",
"formattedOrgName": "SAP SE"
}
},
"taxNumbers": [{"taxNumberType": {"code": "DE0"
},
"taxNumber": "DE143454214"
}
]
}
}
}
]
}

Response samples

application/json

{"id": "650b12ac-3768-11ee-be56-0242ac120002",
"createdAt": "2024-11-20T14:46:48Z",
"finishedAt": "2024-11-20T14:46:48Z",
"createdBy": "76248934691294444",
"status": {"code": "400",
"technicalKey": "OK",
"details": [{"id": 200000004,
"message": "Business Partner Name is mandatory.",
"technicalKey": "OK"
}
],
"path": "/v2/businesspartners/lookup",
"timestamp": "2024-11-20T14:46:48Z"
},
"progress": "77",
"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"results": [{"total": "67",
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "648824a691d8d2503d65103e",
"dataSourceName": "Internal customers",
"storageDataSource": {"id": "6479fd136811f0361e083211"
},
"lastSyncAt": "2024-11-20T14:46:48Z",
"lastUpdatedAt": "2024-11-20T14:46:48Z",
"subscriptionMetadata": {"subscribed": "true",
"numberOfSubscribers": "50"
},
"matchingProfile": {"matchingScores": {"overall": {"classification": { },
"value": null,
"explanation": null
},
"businessPartner": {"classification": { },
"value": null,
"explanation": null
},
"address": {"classification": { },
"value": null,
"explanation": null
}
}
},
"businessPartner": {"names": [{"shortName": null,
"type": { },
"value": null,
"language": { }
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": null,
"technicalKey": null
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{ }
],
"technicalKey": "DE_9866"
},
"identifiers": [{"type": { },
"value": null,
"issuingBody": { },
"status": { }
}
],
"categories": [{"name": null,
"url": null,
"technicalKey": null
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-20T14:46:48Z",
"validUntil": "2024-11-20T14:46:48Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
},
"addresses": [{"version": { },
"identifyingName": { },
"externalId": null,
"metadata": { },
"careOf": { },
"contexts": [ ],
"country": { },
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": { },
"types": [ ],
"formattedAddress": { }
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": null
},
"classifications": [{ }
],
"phoneNumbers": [{ }
],
"websites": [{ }
],
"contactEmails": [{ }
],
"tags": [{ }
],
"vatPayerStatus": {"publicationDate": null,
"status": { },
"registrationAuthority": { }
},
"hcpProfile": {"generalLicense": { },
"operationalPermissions": [ ]
}
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"indSectorCode": "NAF",
"emailAddress": "bp@gmail.com",
"narp": "Friedrich Nietzsche",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"url": "www.cdq.com",
"telNumber": "+41 71 571 10 40",
"country": "Switzerland",
"countryCode": "CH",
"region": "Sankt Gallen",
"regionCodeSap": "9004",
"regionCode": "9004",
"county": "Sankt Gallen",
"countyCode": "9004",
"township": "Sankt Gallen",
"townshipCode": "9004",
"city": "Sankt Gallen",
"district": "St. Georgen",
"postalCode": "9000",
"postalCode3": "9000",
"street1": "Lukasstraße 4",
"street2": "Lukasstraße 4",
"street5": "Lukasstraße 4",
"houseNum": "4",
"houseNum2": "4",
"building": "Office 2",
"floor": "2",
"roomnumber": "123",
"poBoxCountry": "9000",
"poBoxCity": "9000",
"poBoxPostalCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
},
"relations": [{"startedAt": null,
"endedAt": null,
"type": { },
"class": { },
"startNode": null,
"endNode": null,
"startNodeBusinessPartner": { },
"endNodeBusinessPartner": { }
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"externalContext": {"identifiers": [{ }
]
},
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
},
"bankAccounts": [{"internationalBankAccountIdentifier": null,
"internationalBankIdentifier": null,
"nationalBankAccountIdentifier": null,
"nationalBankIdentifier": null,
"countryCode": null
}
]
},
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"goldenRecordUse": "PRIMARY"
}
],
"goldenRecord": {"cdqId": "VIES:PL1132639219",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"businessPartner": {"names": [{"shortName": "CDQ AG",
"type": {"url": null,
"name": null,
"technicalKey": null
},
"value": "Corporate Data Quality AG",
"language": {"name": null,
"technicalKey": null
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": null,
"shortName": null,
"url": null,
"technicalKey": null
}
],
"technicalKey": "DE_9866"
},
"identifiers": [{"type": {"url": null,
"name": null,
"technicalKey": null
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"shortName": null,
"name": null,
"names": [ ],
"url": null,
"technicalKey": null,
"jurisdiction": { }
},
"status": {"name": null,
"technicalKey": null
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-20T14:46:48Z",
"validUntil": "2024-11-20T14:46:48Z",
"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"addresses": [{"version": {"characterSet": { },
"language": { }
},
"identifyingName": {"value": null
},
"externalId": "1",
"metadata": {"primaryProvenance": { },
"language": { }
},
"careOf": {"value": null
},
"contexts": [{ }
],
"country": {"shortName": null,
"value": null
},
"administrativeAreas": [{ }
],
"postCodes": [{ }
],
"localities": [{ }
],
"thoroughfares": [{ }
],
"premises": [{ }
],
"postalDeliveryPoints": [{ }
],
"geographicCoordinates": {"latitude": null,
"longitude": null
},
"types": [{ }
],
"formattedAddress": {"country": null,
"administrativeArea": null,
"region": null,
"regionCode": null,
"locality": null,
"district": null,
"postalCode": null,
"thoroughfare": null,
"premise": null,
"interurbanDeliveryPoint": null,
"mailbox": null,
"postOfficeBox": null
}
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": null,
"code": null,
"type": { }
}
],
"phoneNumbers": [{"countryPrefix": null,
"number": null,
"type": { },
"value": null
}
],
"websites": [{"url": null,
"type": { }
}
],
"contactEmails": [{"value": null
}
],
"tags": [{"value": null,
"type": { }
}
],
"vatPayerStatus": {"publicationDate": "2024-11-20T14:46:48Z",
"status": {"name": null,
"technicalKey": null
},
"registrationAuthority": {"registrationAuthorityId": null,
"registrationAuthorityEntityId": null,
"otherRegistrationAuthorityId": null
}
},
"hcpProfile": {"generalLicense": {"professionType": { },
"licenseStatus": { }
},
"operationalPermissions": [{ }
]
}
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"indSectorCode": "NAF",
"emailAddress": "bp@gmail.com",
"narp": "Friedrich Nietzsche",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"url": "www.cdq.com",
"telNumber": "+41 71 571 10 40",
"country": "Switzerland",
"countryCode": "CH",
"region": "Sankt Gallen",
"regionCodeSap": "9004",
"regionCode": "9004",
"county": "Sankt Gallen",
"countyCode": "9004",
"township": "Sankt Gallen",
"townshipCode": "9004",
"city": "Sankt Gallen",
"district": "St. Georgen",
"postalCode": "9000",
"postalCode3": "9000",
"street1": "Lukasstraße 4",
"street2": "Lukasstraße 4",
"street5": "Lukasstraße 4",
"houseNum": "4",
"houseNum2": "4",
"building": "Office 2",
"floor": "2",
"roomnumber": "123",
"poBoxCountry": "9000",
"poBoxCity": "9000",
"poBoxPostalCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
},
"relations": [{"startedAt": "2024-11-20T14:46:48Z",
"endedAt": "2024-11-20T14:46:48Z",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"class": {"name": null,
"url": null,
"technicalKey": null
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645",
"startNodeBusinessPartner": {"names": [ ],
"addresses": [ ]
},
"endNodeBusinessPartner": {"names": [ ],
"addresses": [ ]
}
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"externalContext": {"identifiers": [{"value": null,
"type": { }
}
]
},
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": null,
"formattedOrgNameLine2": null,
"formattedOrgNameLine3": null,
"formattedOrgNameLine4": null,
"formattedOrgName": null,
"customSalutation": null,
"scriptVariants": [ ]
},
"legalForm": {"name": null,
"code": null
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": { },
"identificationNumber": null,
"country": { },
"region": { },
"institute": null
}
],
"taxNumbers": [{"taxNumberType": { },
"taxNumber": null
}
],
"addressData": [{"validFrom": null,
"validTo": null,
"usages": [ ],
"postalAddressType": null,
"organizationPostalAddress": { },
"emailAddresses": { },
"websites": { }
}
]
},
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE"
}
]
},
"metadata": [{"modifiedAt": "2024-11-20T14:46:48Z",
"modifiedBy": "76248934691294444",
"dataSource": {"aleiPrefix": "DE.RC",
"name": "VIES"
},
"cdqId": "VIES:PL1132639219"
}
],
"businessPartnerChanges": [{"externalIds": [{"externalId": null,
"dataSourceId": null,
"id": null,
"characterSet": { },
"language": { },
"concept": { }
}
],
"property": {"parentConcept": {"name": null,
"url": null,
"technicalKey": null
},
"name": "Minority Indicator Value",
"technicalKey": "MINORITY_INDICATOR_VALUE",
"url": "http://meta.cdq.com/Business_Partner/Identifier_Value",
"content": "DE12345678",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"instanceSelectors": [{ }
]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0"
}
]
},
"debugInfo": {"features": [{"feature": "ACTIVATE_DATASOURCE_BVD",
"active": "true"
}
],
"request": {"limit": "20",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{ }
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"businessPartner": {"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { },
"issuingBody": { }
}
],
"legalForm": {"value": "Concept name or value"
},
"addresses": [{"thoroughfares": [ ],
"localities": [ ],
"administrativeAreas": [ ],
"postCodes": [ ],
"country": { }
}
],
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
}
},
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"curatedRequest": {"limit": "20",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{ }
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"businessPartner": {"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { },
"issuingBody": { }
}
],
"legalForm": {"value": "Concept name or value"
},
"addresses": [{"thoroughfares": [ ],
"localities": [ ],
"administrativeAreas": [ ],
"postCodes": [ ],
"country": { }
}
],
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
}
},
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"externalServiceResponses": [{"apiError": {"status": {"code": null,
"technicalKey": null,
"details": [ ],
"path": null,
"timestamp": null
}
},
"timestamp": "2024-11-20T14:46:48Z",
"httpStatus": "400",
"httpPath": "/v2/businesspartners/lookup",
"status": "OK",
"message": "VIES_NOT_AVAILABLE - Vies is currently not available",
"source": "CHUID",
"additionalInformations": [{"key": null,
"value": null
}
]
}
]
},
"annotations": [{"technicalKey": "Ref-cred",
"url": "https://cdq.com/cred",
"message": "Incorrect credentials",
"severity": "ERROR"
}
],
"id": "dc172630-5791-11ee-8c99-0242ac120002",
"externalId": "id-customer-123"
}
],
"nextStartAfter": "5712566172571652"
}

Read Bulk Lookup

Read results for lookup bulk

SecurityapiKey

Request

path Parameters

required

string

Unique identifier for a bulk.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

query Parameters

limit	integer <int32> [ 1 .. 1000 ] Default: 100 Number of items to be returned on the page. Example: limit=20
startAfter	string Default: "0" Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response. Example: startAfter=16

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

get/referencedata/rest/v4/businesspartners/lookup/bulks/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "650b12ac-3768-11ee-be56-0242ac120002",
"createdAt": "2024-11-20T14:46:48Z",
"finishedAt": "2024-11-20T14:46:48Z",
"createdBy": "76248934691294444",
"status": {"code": "400",
"technicalKey": "OK",
"details": [{"id": 200000004,
"message": "Business Partner Name is mandatory.",
"technicalKey": "OK"
}
],
"path": "/v2/businesspartners/lookup",
"timestamp": "2024-11-20T14:46:48Z"
},
"progress": "77",
"limit": "10",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{"id": "6479fd136811f0361e083211"
}
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"results": [{"total": "67",
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "648824a691d8d2503d65103e",
"dataSourceName": "Internal customers",
"storageDataSource": {"id": "6479fd136811f0361e083211"
},
"lastSyncAt": "2024-11-20T14:46:48Z",
"lastUpdatedAt": "2024-11-20T14:46:48Z",
"subscriptionMetadata": {"subscribed": "true",
"numberOfSubscribers": "50"
},
"matchingProfile": {"matchingScores": {"overall": {"classification": { },
"value": null,
"explanation": null
},
"businessPartner": {"classification": { },
"value": null,
"explanation": null
},
"address": {"classification": { },
"value": null,
"explanation": null
}
}
},
"businessPartner": {"names": [{"shortName": null,
"type": { },
"value": null,
"language": { }
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": null,
"technicalKey": null
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{ }
],
"technicalKey": "DE_9866"
},
"identifiers": [{"type": { },
"value": null,
"issuingBody": { },
"status": { }
}
],
"categories": [{"name": null,
"url": null,
"technicalKey": null
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-20T14:46:48Z",
"validUntil": "2024-11-20T14:46:48Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
},
"addresses": [{"version": { },
"identifyingName": { },
"externalId": null,
"metadata": { },
"careOf": { },
"contexts": [ ],
"country": { },
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": { },
"types": [ ],
"formattedAddress": { }
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": null
},
"classifications": [{ }
],
"phoneNumbers": [{ }
],
"websites": [{ }
],
"contactEmails": [{ }
],
"tags": [{ }
],
"vatPayerStatus": {"publicationDate": null,
"status": { },
"registrationAuthority": { }
},
"hcpProfile": {"generalLicense": { },
"operationalPermissions": [ ]
}
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"indSectorCode": "NAF",
"emailAddress": "bp@gmail.com",
"narp": "Friedrich Nietzsche",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"url": "www.cdq.com",
"telNumber": "+41 71 571 10 40",
"country": "Switzerland",
"countryCode": "CH",
"region": "Sankt Gallen",
"regionCodeSap": "9004",
"regionCode": "9004",
"county": "Sankt Gallen",
"countyCode": "9004",
"township": "Sankt Gallen",
"townshipCode": "9004",
"city": "Sankt Gallen",
"district": "St. Georgen",
"postalCode": "9000",
"postalCode3": "9000",
"street1": "Lukasstraße 4",
"street2": "Lukasstraße 4",
"street5": "Lukasstraße 4",
"houseNum": "4",
"houseNum2": "4",
"building": "Office 2",
"floor": "2",
"roomnumber": "123",
"poBoxCountry": "9000",
"poBoxCity": "9000",
"poBoxPostalCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
},
"relations": [{"startedAt": null,
"endedAt": null,
"type": { },
"class": { },
"startNode": null,
"endNode": null,
"startNodeBusinessPartner": { },
"endNodeBusinessPartner": { }
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"externalContext": {"identifiers": [{ }
]
},
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
},
"bankAccounts": [{"internationalBankAccountIdentifier": null,
"internationalBankIdentifier": null,
"nationalBankAccountIdentifier": null,
"nationalBankIdentifier": null,
"countryCode": null
}
]
},
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"goldenRecordUse": "PRIMARY"
}
],
"goldenRecord": {"cdqId": "VIES:PL1132639219",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": null,
"name": null
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"businessPartner": {"names": [{"shortName": "CDQ AG",
"type": {"url": null,
"name": null,
"technicalKey": null
},
"value": "Corporate Data Quality AG",
"language": {"name": null,
"technicalKey": null
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": null,
"shortName": null,
"url": null,
"technicalKey": null
}
],
"technicalKey": "DE_9866"
},
"identifiers": [{"type": {"url": null,
"name": null,
"technicalKey": null
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"shortName": null,
"name": null,
"names": [ ],
"url": null,
"technicalKey": null,
"jurisdiction": { }
},
"status": {"name": null,
"technicalKey": null
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-20T14:46:48Z",
"validUntil": "2024-11-20T14:46:48Z",
"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"addresses": [{"version": {"characterSet": { },
"language": { }
},
"identifyingName": {"value": null
},
"externalId": "1",
"metadata": {"primaryProvenance": { },
"language": { }
},
"careOf": {"value": null
},
"contexts": [{ }
],
"country": {"shortName": null,
"value": null
},
"administrativeAreas": [{ }
],
"postCodes": [{ }
],
"localities": [{ }
],
"thoroughfares": [{ }
],
"premises": [{ }
],
"postalDeliveryPoints": [{ }
],
"geographicCoordinates": {"latitude": null,
"longitude": null
},
"types": [{ }
],
"formattedAddress": {"country": null,
"administrativeArea": null,
"region": null,
"regionCode": null,
"locality": null,
"district": null,
"postalCode": null,
"thoroughfare": null,
"premise": null,
"interurbanDeliveryPoint": null,
"mailbox": null,
"postOfficeBox": null
}
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": null,
"code": null,
"type": { }
}
],
"phoneNumbers": [{"countryPrefix": null,
"number": null,
"type": { },
"value": null
}
],
"websites": [{"url": null,
"type": { }
}
],
"contactEmails": [{"value": null
}
],
"tags": [{"value": null,
"type": { }
}
],
"vatPayerStatus": {"publicationDate": "2024-11-20T14:46:48Z",
"status": {"name": null,
"technicalKey": null
},
"registrationAuthority": {"registrationAuthorityId": null,
"registrationAuthorityEntityId": null,
"otherRegistrationAuthorityId": null
}
},
"hcpProfile": {"generalLicense": {"professionType": { },
"licenseStatus": { }
},
"operationalPermissions": [{ }
]
}
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"indSectorCode": "NAF",
"emailAddress": "bp@gmail.com",
"narp": "Friedrich Nietzsche",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"url": "www.cdq.com",
"telNumber": "+41 71 571 10 40",
"country": "Switzerland",
"countryCode": "CH",
"region": "Sankt Gallen",
"regionCodeSap": "9004",
"regionCode": "9004",
"county": "Sankt Gallen",
"countyCode": "9004",
"township": "Sankt Gallen",
"townshipCode": "9004",
"city": "Sankt Gallen",
"district": "St. Georgen",
"postalCode": "9000",
"postalCode3": "9000",
"street1": "Lukasstraße 4",
"street2": "Lukasstraße 4",
"street5": "Lukasstraße 4",
"houseNum": "4",
"houseNum2": "4",
"building": "Office 2",
"floor": "2",
"roomnumber": "123",
"poBoxCountry": "9000",
"poBoxCity": "9000",
"poBoxPostalCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
},
"relations": [{"startedAt": "2024-11-20T14:46:48Z",
"endedAt": "2024-11-20T14:46:48Z",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"class": {"name": null,
"url": null,
"technicalKey": null
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645",
"startNodeBusinessPartner": {"names": [ ],
"addresses": [ ]
},
"endNodeBusinessPartner": {"names": [ ],
"addresses": [ ]
}
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"externalContext": {"identifiers": [{"value": null,
"type": { }
}
]
},
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": null,
"formattedOrgNameLine2": null,
"formattedOrgNameLine3": null,
"formattedOrgNameLine4": null,
"formattedOrgName": null,
"customSalutation": null,
"scriptVariants": [ ]
},
"legalForm": {"name": null,
"code": null
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": { },
"identificationNumber": null,
"country": { },
"region": { },
"institute": null
}
],
"taxNumbers": [{"taxNumberType": { },
"taxNumber": null
}
],
"addressData": [{"validFrom": null,
"validTo": null,
"usages": [ ],
"postalAddressType": null,
"organizationPostalAddress": { },
"emailAddresses": { },
"websites": { }
}
]
},
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE"
}
]
},
"metadata": [{"modifiedAt": "2024-11-20T14:46:48Z",
"modifiedBy": "76248934691294444",
"dataSource": {"aleiPrefix": "DE.RC",
"name": "VIES"
},
"cdqId": "VIES:PL1132639219"
}
],
"businessPartnerChanges": [{"externalIds": [{"externalId": null,
"dataSourceId": null,
"id": null,
"characterSet": { },
"language": { },
"concept": { }
}
],
"property": {"parentConcept": {"name": null,
"url": null,
"technicalKey": null
},
"name": "Minority Indicator Value",
"technicalKey": "MINORITY_INDICATOR_VALUE",
"url": "http://meta.cdq.com/Business_Partner/Identifier_Value",
"content": "DE12345678",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"instanceSelectors": [{ }
]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0"
}
]
},
"debugInfo": {"features": [{"feature": "ACTIVATE_DATASOURCE_BVD",
"active": "true"
}
],
"request": {"limit": "20",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{ }
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"businessPartner": {"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { },
"issuingBody": { }
}
],
"legalForm": {"value": "Concept name or value"
},
"addresses": [{"thoroughfares": [ ],
"localities": [ ],
"administrativeAreas": [ ],
"postCodes": [ ],
"country": { }
}
],
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
}
},
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"curatedRequest": {"limit": "20",
"startAfter": "5712566172571652",
"dataSources": ["VIES"
],
"matchingThreshold": "0.5",
"maxCandidates": "50",
"storagesDataSources": [{"storageId": "6479fd136811f0361e083211",
"dataSources": [{ }
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"businessPartner": {"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { },
"issuingBody": { }
}
],
"legalForm": {"value": "Concept name or value"
},
"addresses": [{"thoroughfares": [ ],
"localities": [ ],
"administrativeAreas": [ ],
"postCodes": [ ],
"country": { }
}
],
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": { },
"legalForm": { },
"globalLocationNumber": null
},
"identifications": [{ }
],
"taxNumbers": [{ }
],
"addressData": [{ }
]
}
},
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"externalServiceResponses": [{"apiError": {"status": {"code": null,
"technicalKey": null,
"details": [ ],
"path": null,
"timestamp": null
}
},
"timestamp": "2024-11-20T14:46:48Z",
"httpStatus": "400",
"httpPath": "/v2/businesspartners/lookup",
"status": "OK",
"message": "VIES_NOT_AVAILABLE - Vies is currently not available",
"source": "CHUID",
"additionalInformations": [{"key": null,
"value": null
}
]
}
]
},
"annotations": [{"technicalKey": "Ref-cred",
"url": "https://cdq.com/cred",
"message": "Incorrect credentials",
"severity": "ERROR"
}
],
"id": "dc172630-5791-11ee-8c99-0242ac120002",
"externalId": "id-customer-123"
}
],
"nextStartAfter": "5712566172571652"
}

Bulk Lookup

Create Bulk Lookup

Request Body schema: application/jsonrequired

Read Bulk Lookup

path Parameters

query Parameters

Request Body schema: application/json
required