Download OpenAPI specification:Download
This API provides services to curate and enrich Business Partner and address data.
After you have started a curation job, you will receive a job id in the response. {
'id' : '
OK
Unauthorized
Forbidden
Not Found
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data",
- "description": "I started this job to improve quality of our data.",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceIds": [
- "648824a691d8d2503d65103e"
], - "countryShortNames": [
- "CH"
], - "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2024-09-06T20:43:36Z",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "reportsJobId": "6be92567-4327-4463-813f-a8c990410d79",
- "reportsConfiguration": {
- "addressCuration": {
- "build": "true"
}, - "legalEntityCuration": {
- "build": "true"
}, - "naturalPersonScreening": {
- "build": "true"
}, - "vatRegistrationData": {
- "build": "true"
}
}
}
Retrieves curation results for particular job.
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 (StartAfter) Used to retrieve the next page of results. Prepared in the Curation Job Result Page.nextStartAfter. Example: startAfter=5712566172571652 |
OK
Unauthorized or missing
{- "startAfter": "5712566172571652",
- "limit": "100",
- "total": "67",
- "values": [
- {
- "id": "6be92567-4327-4463-813f-a8c990410d79",
- "businessPartnerId": "63e635235c06b7396330fe40",
- "addressId": "1",
- "curationResult": {
- "businessPartnerCurationResult": {
- "curatedBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": null,
- "technicalKey": null
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- null
]
}, - "identifiers": [
- {
- "type": null,
- "value": null,
- "issuingBody": null,
- "status": null
}
], - "categories": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "score": null
}
], - "status": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "officialDenotation": "Good Standing",
- "validFrom": "2024-09-06T20:43:36Z",
- "validUntil": "2024-09-06T20:43:36Z"
}, - "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"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "lastModifiedAt": "2024-09-06T20:43:36Z"
}, - "originalBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": null,
- "technicalKey": null
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- null
]
}, - "identifiers": [
- {
- "type": null,
- "value": null,
- "issuingBody": null,
- "status": null
}
], - "categories": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "score": null
}
], - "status": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "officialDenotation": "Good Standing",
- "validFrom": "2024-09-06T20:43:36Z",
- "validUntil": "2024-09-06T20:43:36Z"
}, - "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"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "lastModifiedAt": "2024-09-06T20:43:36Z"
}, - "changes": [
- {
- "externalIds": [
- null
], - "property": {
- "parentConcept": null,
- "name": null,
- "technicalKey": null,
- "contentSelector": null,
- "instanceSelectors": [ ]
}, - "newContent": "AAB",
- "previousContent": "AAB",
- "provenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null,
- "subscribers": null,
- "subscribed": null,
- "lastUpdatedAt": null,
- "lastSyncAt": null
}, - "changeType": "MODIFIED",
- "changeClassification": "MAJOR",
- "confidenceScore": "0.0",
- "maxConfidenceScore": "1.0",
- "matchingScores": {
- "overall": null,
- "businessPartner": null,
- "address": null
}
}
], - "requestSimilarity": {
- "name": {
- "value": "0.8"
}, - "address": {
- "value": "0.8"
}
}
}, - "addressCurationResults": [
- {
- "curatedAddress": {
- "version": {
- "characterSet": null,
- "language": null
}, - "identifyingName": {
- "value": null
}, - "externalId": "1",
- "metadata": {
- "primaryProvenance": null,
- "language": null
}, - "careOf": {
- "value": null
}, - "contexts": [
- null
], - "country": {
- "shortName": null,
- "value": null
}, - "administrativeAreas": [
- null
], - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
], - "premises": [
- null
], - "postalDeliveryPoints": [
- null
], - "geographicCoordinates": {
- "latitude": null,
- "longitude": null
}, - "types": [
- null
], - "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
}
}, - "originalAddress": {
- "version": {
- "characterSet": null,
- "language": null
}, - "identifyingName": {
- "value": null
}, - "externalId": "1",
- "metadata": {
- "primaryProvenance": null,
- "language": null
}, - "careOf": {
- "value": null
}, - "contexts": [
- null
], - "country": {
- "shortName": null,
- "value": null
}, - "administrativeAreas": [
- null
], - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
], - "premises": [
- null
], - "postalDeliveryPoints": [
- null
], - "geographicCoordinates": {
- "latitude": null,
- "longitude": null
}, - "types": [
- null
], - "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
}
}, - "additionalAddresses": [
- {
- "version": null,
- "identifyingName": null,
- "externalId": null,
- "metadata": null,
- "careOf": null,
- "contexts": [ ],
- "country": null,
- "administrativeAreas": [ ],
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ],
- "premises": [ ],
- "postalDeliveryPoints": [ ],
- "geographicCoordinates": null,
- "types": [ ],
- "formattedAddress": null
}
], - "curationAnalysis": {
- "requestSimilarity": {
- "geoCoordinates": null,
- "locality": null,
- "postCode": null,
- "thoroughfare": null,
- "thoroughfareNumber": null,
- "overall": null
}, - "curationLevel": "LEVEL_1",
- "accuracyIndicator": "0.9",
- "outputLanguage": "CH",
- "curationDecision": {
- "action": null
}, - "geographicCoordinatesAccuracy": "LOCALITY"
}
}
], - "settings": {
- "enabled": "true",
- "dataCurationRules": [
- {
- "context": {
- "country": null
}, - "addressCurationLevelThreshold": "0.5",
- "outputLanguageTechnicalKey": "DE",
- "outputCharsets": [
- null
], - "profile": "BUSINESS_PARTNER_ONLY",
- "featuresOn": [
- null
], - "featuresOff": [
- null
], - "addressDataSources": {
- "primaryAddressDataSource": null,
- "secondaryAddressDataSources": [ ]
}
}
]
}, - "debugInfo": {
- "externalServiceResponses": [
- {
- "timestamp": "2024-09-06T20:43:36Z",
- "httpStatus": "400",
- "httpPath": "/v2/businesspartners/lookup",
- "status": "OK",
- "message": "VIES_NOT_AVAILABLE - Vies is currently not available",
- "source": "CHUID",
- "additionalInformations": [
- null
]
}
], - "lookupServiceResponses": [
- {
- "request": {
- "businessPartner": null,
- "dataSources": [ ],
- "matchingThreshold": null,
- "maxCandidates": null,
- "pageSize": null,
- "page": null,
- "limit": null,
- "startAfter": null,
- "featuresOn": [ ],
- "featuresOff": [ ]
}, - "result": {
- "pageSize": null,
- "totals": null,
- "page": null,
- "limit": null,
- "startAfter": null,
- "nextStartAfter": null,
- "values": [ ]
}
}
]
}
}, - "resultStatus": {
- "status": "OK",
- "message": "Storage with provided ID doesn’t exist."
}
}
], - "nextStartAfter": "5712566172571652"
}
Start a batch curation job on a given storage.
addressCurationLevelThreshold | string (CurationLevel) Indicator for curation quality. Defines how good curation was. Additional documentation can be found here.
Example: "LEVEL_1" | ||||||||||||||||
object (AddressDataSources) Preferred data sources for curation. Default PrimaryAddressDataSource is HERE. Default SecondaryAddressDataSource is CDQ. | |||||||||||||||||
configurationId | string (DataCurationConfigurationId) Configuration ID used to set up curation. 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):
Example: "5c5356588c72a028c448adbd" | ||||||||||||||||
countryShortNames | Array of strings (CountryShortName) If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters). Example: ["CH"] | ||||||||||||||||
dataSourceIds | Array of strings (BusinessPartnerStorageDataSourceId) If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters). Example: ["648824a691d8d2503d65103e"] | ||||||||||||||||
description | string <= 200 characters Detailed description of a Job. Example: "I started this job to improve quality of our data." | ||||||||||||||||
featuresOff | Array of strings (Feature) List of features to be deactivated. Example: ["ENRICH_ADDRESS"] | ||||||||||||||||
featuresOn | Array of strings (Feature) List of features to be activated. Example: ["ENRICH_ADDRESS"] | ||||||||||||||||
fields | Array of strings Default: ["formattedAddress"] Fields are deprecated. Use features instead. Example: ["formattedAddress"] | ||||||||||||||||
language | string (LanguageTechnicalKey) ISO 639-1 two-letter code of languages. Example: "DE" | ||||||||||||||||
name | string <= 50 characters Name of a Job. Example: "Process vendor data." | ||||||||||||||||
optionSkipReport | boolean Deprecated Default: true Deprecated and not usable. For a report creation, use Example: "true" | ||||||||||||||||
Array of objects (OutputCharset) List of Output Character Sets. | |||||||||||||||||
profile | string (Profile) Used to configure the curation process. Available wiki documentation for profiles: Example: "STANDARD" | ||||||||||||||||
object (DataCurationReportsRequest) Deprecated Deprecated. Reports are available in Data Clinic app. | |||||||||||||||||
storageId required | string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6" | ||||||||||||||||
workers | integer [ 1 .. 8 ] Default: 1 Number of workers to be used for the job. By default, the number of workers is 1. Example: "3" |
OK
Created
The sent request is malformed.
Unauthorized
Forbidden
Not Found
{- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceIds": [
- "648824a691d8d2503d65103e"
], - "countryShortNames": [
- "CH"
], - "workers": "3",
- "profile": "STANDARD",
- "language": "DE",
- "outputCharsets": [
- {
- "concept": "ADDRESS",
- "charset": "LATIN"
}
], - "addressDataSources": {
- "primaryAddressDataSource": {
- "technicalKey": "HERE",
- "threshold": "0.4"
}, - "secondaryAddressDataSources": [
- {
- "technicalKey": "HERE",
- "threshold": "0.4"
}
]
}, - "addressCurationLevelThreshold": "LEVEL_1",
- "fields": [
- "formattedAddress"
], - "featuresOn": [
- "ENRICH_ADDRESS"
], - "featuresOff": [
- "ENRICH_ADDRESS"
], - "optionSkipReport": "true",
- "reportsRequest": {
- "dataCurationJobId": "a34fb367-85aa-400f-b369-53863432050c",
- "name": "Data Curation Reports Job",
- "description": "The report will be generated for the Data Curation Job with ID: a34fb367-85aa-400f-b369-53863432050c.",
- "reportsConfiguration": {
- "addressCuration": {
- "build": "true"
}, - "legalEntityCuration": {
- "build": "true"
}, - "naturalPersonScreening": {
- "build": "true"
}, - "vatRegistrationData": {
- "build": "true"
}
}
}, - "configurationId": "5c5356588c72a028c448adbd"
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "name": "Process vendor data",
- "description": "I started this job to improve quality of our data.",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceIds": [
- "648824a691d8d2503d65103e"
], - "countryShortNames": [
- "CH"
], - "status": "RUNNING",
- "statusMessage": "The job failed because storage is empty.",
- "createdAt": "2024-09-06T20:43:36Z",
- "user": "742429-234242-4343-232323",
- "progress": "77",
- "attachments": [
- {
- "url": "customer-upload/user/file.xlsx",
- "tags": [
- "Reporting"
]
}
], - "reportsJobId": "6be92567-4327-4463-813f-a8c990410d79",
- "reportsConfiguration": {
- "addressCuration": {
- "build": "true"
}, - "legalEntityCuration": {
- "build": "true"
}, - "naturalPersonScreening": {
- "build": "true"
}, - "vatRegistrationData": {
- "build": "true"
}
}
}