Bulk Lookup

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

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v4/businesspartners/lookup/bulks
Request samples
application/json
{
  • "featuresOn": [
    ],
  • "tasks": [
    ]
}
Response samples
application/json
{
  • "id": "650b12ac-3768-11ee-be56-0242ac120002",
  • "createdAt": "2024-07-11T07:22:43Z",
  • "finishedAt": "2024-07-11T07:22:43Z",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "limit": "10",
  • "startAfter": "5712566172571652",
  • "dataSources": [
    ],
  • "matchingThreshold": "0.5",
  • "maxCandidates": "50",
  • "storagesDataSources": [
    ],
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "results": [
    ],
  • "nextStartAfter": "5712566172571652"
}

Read Bulk Lookup

Read results for lookup bulk

SecurityapiKey
Request
path Parameters
id
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

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/referencedata/rest/v4/businesspartners/lookup/bulks/{id}
Request samples
Response samples
application/json
{
  • "id": "650b12ac-3768-11ee-be56-0242ac120002",
  • "createdAt": "2024-07-11T07:22:43Z",
  • "finishedAt": "2024-07-11T07:22:43Z",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "limit": "10",
  • "startAfter": "5712566172571652",
  • "dataSources": [
    ],
  • "matchingThreshold": "0.5",
  • "maxCandidates": "50",
  • "storagesDataSources": [
    ],
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "results": [
    ],
  • "nextStartAfter": "5712566172571652"
}