Batch Lookup Result

Read Batch Lookup Results

Read lookup job results by page

SecurityapiKey

Request

path Parameters

required

string

id of the lookup job

query Parameters

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

Responses

200

get/lookupjobs/{id}/results

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "string",
"limit": 0,
"total": 0,
"values": [{"id": "string",
"businessPartnerId": "string",
"lookupRequest": {"businessPartner": {"names": [{"value": "string"
}
],
"identifiers": [{"value": "string",
"type": {"technicalKey": null
},
"issuingBody": {"technicalKey": null,
"name": null
}
}
],
"legalForm": {"value": "string"
},
"addresses": [{"thoroughfares": [null
],
"localities": [null
],
"administrativeAreas": [null
],
"postCodes": [null
],
"country": {"shortName": null
}
}
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": "string",
"dataSources": ["string"
]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"businessPartnerLookupResult": {"pageSize": 0,
"totals": 0,
"page": 0,
"limit": 0,
"startAfter": "string",
"nextStartAfter": "string",
"values": [{"cdqId": "string",
"dataSource": "string",
"lastSyncAt": "21-06-2023",
"lastUpdatedAt": "21-01-2023",
"dataSourceName": "string",
"storageDataSource": "string",
"subscriptionMetadata": {"subscribed": true,
"numberOfSubscribers": 0
},
"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": {"type": null,
"officialDenotation": null,
"validFrom": null,
"validUntil": 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": "string",
"mappedRecord": {"attributes": [null
]
}
}
],
"goldenRecord": {"cdqId": "string",
"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": {"type": {"name": null,
"url": null,
"technicalKey": null
},
"officialDenotation": "Good Standing",
"validFrom": "2022-02-26",
"validUntil": "2022-02-26"
},
"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": [{"startNodeBusinessPartner": null,
"endNodeBusinessPartner": null
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"externalContext": {"identifiers": [null
]
},
"jsonRecord": { }
},
"mappedRecord": {"attributes": [{"key": null,
"value": null
}
]
},
"metadata": [{"modifiedAt": "string",
"modifiedBy": "string",
"dataSource": {"name": null,
"technicalKey": null
},
"cdqId": "string"
}
],
"businessPartnerChanges": [{"externalIds": [null
],
"property": "PL_REG",
"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": "string",
"active": true
}
],
"request": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"curatedRequest": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"externalServiceResponses": [{"apiError": {"timestamp": null,
"message": null,
"error": null,
"status": null,
"path": null,
"id": null
},
"timestamp": "2019-08-31T16:47+00:00",
"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": "string",
"message": "Incorrect credentials",
"severity": "string"
}
]
},
"resultStatus": {"status": "string",
"message": "string"
},
"addressId": "string",
"externalId": "string"
}
]
}

Reads Batch Lookup Results

SecurityapiKey

Request

path Parameters

required

string

id of the lookup job

query Parameters

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

Responses

200

get/v3/lookupjobs/{id}/results

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "string",
"limit": 0,
"total": 0,
"values": [{"id": "string",
"businessPartnerId": "string",
"lookupRequest": {"businessPartner": {"names": [{"value": "string"
}
],
"identifiers": [{"value": "string",
"type": {"technicalKey": null
},
"issuingBody": {"technicalKey": null,
"name": null
}
}
],
"legalForm": {"value": "string"
},
"addresses": [{"thoroughfares": [null
],
"localities": [null
],
"administrativeAreas": [null
],
"postCodes": [null
],
"country": {"shortName": null
}
}
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": "string",
"dataSources": ["string"
]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"businessPartnerLookupResult": {"pageSize": 0,
"totals": 0,
"page": 0,
"limit": 0,
"startAfter": "string",
"nextStartAfter": "string",
"values": [{"cdqId": "string",
"dataSource": "string",
"lastSyncAt": "21-06-2023",
"lastUpdatedAt": "21-01-2023",
"dataSourceName": "string",
"storageDataSource": "string",
"subscriptionMetadata": {"subscribed": true,
"numberOfSubscribers": 0
},
"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": {"type": null,
"officialDenotation": null,
"validFrom": null,
"validUntil": 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": "string",
"mappedRecord": {"attributes": [null
]
}
}
],
"goldenRecord": {"cdqId": "string",
"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": {"type": {"name": null,
"url": null,
"technicalKey": null
},
"officialDenotation": "Good Standing",
"validFrom": "2022-02-26",
"validUntil": "2022-02-26"
},
"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": [{"startNodeBusinessPartner": null,
"endNodeBusinessPartner": null
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"externalContext": {"identifiers": [null
]
},
"jsonRecord": { }
},
"mappedRecord": {"attributes": [{"key": null,
"value": null
}
]
},
"metadata": [{"modifiedAt": "string",
"modifiedBy": "string",
"dataSource": {"name": null,
"technicalKey": null
},
"cdqId": "string"
}
],
"businessPartnerChanges": [{"externalIds": [null
],
"property": "PL_REG",
"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": "string",
"active": true
}
],
"request": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"curatedRequest": {"businessPartner": {"names": [null
],
"identifiers": [null
],
"legalForm": {"value": null
},
"addresses": [null
],
"jsonRecord": { }
},
"dataSource": "string",
"dataSources": "VIES",
"storagesDataSources": [{"storageId": null,
"dataSources": [ ]
}
],
"dataMatchingDefinitionId": "string",
"matchingThreshold": 1,
"maxCandidates": 20,
"pageSize": 1,
"page": 0,
"limit": 1000,
"startAfter": "string",
"featuresOn": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"featuresOff": ["ACTIVATE_IDENTIFIER_ONLY_MATCH"
],
"configurationId": "string",
"outboundMapping": "SAP"
},
"externalServiceResponses": [{"apiError": {"timestamp": null,
"message": null,
"error": null,
"status": null,
"path": null,
"id": null
},
"timestamp": "2019-08-31T16:47+00:00",
"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": "string",
"message": "Incorrect credentials",
"severity": "string"
}
]
},
"resultStatus": {"status": "string",
"message": "string"
},
"addressId": "string",
"externalId": "string"
}
]
}