Batch Lookup Result

Read Batch Lookup Results

Read lookup job results by page.

SecurityapiKey

Request

path Parameters

required

string

ID of the lookup job.

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

query Parameters

businessPartnerId	Array of strings (BusinessPartnerId) Business Partner IDs which should be filtered. Example: businessPartnerId=63e635235c06b7396330fe40
limit	integer <int32> [ 1 .. 100 ] Default: 100 Number of results that should be fetched. Maximum 100 results can be returned in one page. Example: limit=50
startAfter	string Default: "0" Only records with an ID greater than this ID will be fetched. Example: startAfter=5712566172571652

Responses

200

get/lookupjobs/{id}/results

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"businessPartnerId": "63e635235c06b7396330fe40",
"lookupRequest": {"businessPartner": {"names": [{"value": "Concept name or value"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": null
},
"issuingBody": {"technicalKey": null,
"name": null
}
}
],
"legalForm": {"value": "Concept name or value"
},
"addresses": [{"thoroughfares": [null
],
"localities": [null
],
"administrativeAreas": [null
],
"postCodes": [null
],
"country": {"shortName": null
}
}
],
"jsonRecord": { }
},
"dataSource": "VIES",
"dataSources": ["VIES"
],
"storagesDataSources": [{"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dataSources": ["648824a691d8d2503d65103e"
]
}
],
"dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
"matchingThreshold": "0.8",
"maxCandidates": "20",
"pageSize": "10",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"outboundMapping": "SAP"
},
"businessPartnerLookupResult": {"pageSize": "10",
"totals": "67",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "648824a691d8d2503d65103e",
"lastSyncAt": "2024-04-19T10:05:44Z",
"lastUpdatedAt": "2024-04-19T10:05:44Z",
"dataSourceName": "Internal customers",
"storageDataSource": "648824a691d8d2503d65103e",
"subscriptionMetadata": {"subscribed": "true",
"numberOfSubscribers": "50"
},
"matchingProfile": {"matchingScores": {"overall": null,
"businessPartner": null,
"address": null
}
},
"businessPartner": {"names": [null
],
"legalForm": {"name": null,
"url": null,
"language": null,
"mainAbbreviation": null,
"cdlElfCode": null,
"categories": [ ],
"technicalKey": null
},
"identifiers": [null
],
"categories": [null
],
"status": {"officialDenotation": null,
"validFrom": null,
"validUntil": null,
"type": null
},
"addresses": [null
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": null,
"classifications": [ ],
"phoneNumbers": [ ],
"websites": [ ],
"contactEmails": [ ]
},
"formattedSapRecord": {"name1": null,
"name2": null,
"name3": null,
"name4": null,
"nameCo": null,
"legalEntity": null,
"legalForm": null,
"indSector": null,
"narp": null,
"stceg": null,
"stcd1": null,
"stcd2": null,
"stcd3": null,
"stcd4": null,
"stcd5": null,
"url": null,
"telNumber": null,
"country": null,
"countryCode": null,
"region": null,
"regionCodeSap": null,
"regionCode": null,
"county": null,
"countyCode": null,
"township": null,
"townshipCode": null,
"city": null,
"district": null,
"postalCode": null,
"postalCode3": null,
"street1": null,
"street2": null,
"street5": null,
"houseNum": null,
"houseNum2": null,
"building": null,
"floor": null,
"roomnumber": null,
"poBoxCountry": null,
"poBoxCity": null,
"poBoxPostalCode": null,
"poBox": null,
"latitude": null,
"longitude": null
},
"relations": [null
],
"types": [null
],
"externalContext": {"identifiers": [ ]
},
"jsonRecord": { }
},
"additionalInformation": [{"key": null,
"value": null
}
],
"goldenRecordUse": "PRIMARY",
"mappedRecord": {"attributes": [null
]
}
}
],
"goldenRecord": {"cdqId": "VIES:PL1132639219",
"matchingProfile": {"matchingScores": {"overall": {"classification": null,
"value": null,
"explanation": null
},
"businessPartner": {"classification": null,
"value": null,
"explanation": null
},
"address": {"classification": null,
"value": null,
"explanation": null
}
}
},
"businessPartner": {"names": [{"shortName": null,
"type": null,
"value": null,
"language": null
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": null,
"technicalKey": null
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [null
],
"technicalKey": "DE_9866"
},
"identifiers": [{"type": null,
"value": null,
"issuingBody": null,
"status": null
}
],
"categories": [{"name": null,
"url": null,
"technicalKey": null
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-04-19T10:05:44Z",
"validUntil": "2024-04-19T10:05:44Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
},
"addresses": [{"version": null,
"identifyingName": null,
"externalId": null,
"metadata": null,
"careOf": null,
"contexts": [ ],
"country": null,
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": null,
"types": [ ],
"formattedAddress": null
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": null
},
"classifications": [null
],
"phoneNumbers": [null
],
"websites": [null
],
"contactEmails": [null
]
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"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": null,
"class": null,
"startNode": null,
"endNode": null,
"startNodeBusinessPartner": null,
"endNodeBusinessPartner": null
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"externalContext": {"identifiers": [null
]
},
"jsonRecord": { }
},
"mappedRecord": {"attributes": [{"key": null,
"value": null
}
]
},
"metadata": [{"modifiedAt": "2024-04-19T10:05:44Z",
"modifiedBy": "76248934691294444",
"dataSource": {"name": null,
"technicalKey": null
},
"cdqId": "VIES:PL1132639219"
}
],
"businessPartnerChanges": [{"externalIds": [null
],
"property": {"parentConcept": null,
"name": null,
"technicalKey": null,
"url": null,
"content": null,
"contentSelector": null,
"instanceSelectors": [ ]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0"
}
]
},
"debugInfo": {"features": [{"feature": "ACTIVATE_DATASOURCE_BVD",
"active": "true"
}
],
"request": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "VIES",
"dataSources": ["VIES"
],
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
"matchingThreshold": "0.8",
"maxCandidates": "20",
"pageSize": "10",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"outboundMapping": "SAP"
},
"curatedRequest": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "VIES",
"dataSources": ["VIES"
],
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
"matchingThreshold": "0.8",
"maxCandidates": "20",
"pageSize": "10",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"outboundMapping": "SAP"
},
"externalServiceResponses": [{"apiError": {"timestamp": null,
"message": null,
"error": null,
"status": null,
"path": null,
"id": null
},
"timestamp": "2024-04-19T10:05:44Z",
"httpStatus": "400",
"httpPath": "/v2/businesspartners/lookup",
"status": "OK",
"message": "VIES_NOT_AVAILABLE - Vies is currently not available",
"source": "CHUID",
"additionalInformations": [null
]
}
]
},
"annotations": [{"technicalKey": "Ref-cred",
"url": "https://cdq.com/cred",
"message": "Incorrect credentials",
"severity": "ERROR"
}
]
},
"resultStatus": {"status": "SUCCESS",
"message": "Lookup successful"
},
"addressId": "0",
"externalId": "The ID managed in the customer's SAP systems."
}
]
}

Reads Batch Lookup Results

Reads the results of a batch lookup job. The results are returned in pages. The page size can be controlled by the limit parameter. The results are sorted by the CDQ ID of the Business Partner.