Confirm Business Partner

Confirm Business PartnerBETA

BETA
Confirms the validity of a trading partner by checking the provided data against various CDQ services.

SecurityapiKey

Request

query Parameters

dataTransformationDefinitionId

string

The ID of the data transformation definition to apply.

Example: dataTransformationDefinitionId=123456

Request Body schema: application/json
required

object (BusinessPartner)

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

featuresOff

Array of strings (ConfirmFeatureParam)

List of features to be deactivated.

Items Enum:	Description
ENABLE_SANCTION_CONFIRMATION	Sanction confirmation is used to confirm business partner.
ENABLE_QUALIFICATION_CONFIRMATION	Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]

featuresOn

Array of strings (ConfirmFeatureParam)

List of features to be activated.

Items Enum:	Description
ENABLE_SANCTION_CONFIRMATION	Sanction confirmation is used to confirm business partner.
ENABLE_QUALIFICATION_CONFIRMATION	Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]

Responses

200

400

Bad Request

post/v2/businesspartners/confirm

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"jsonRecord": "{ \"key\" : \"value\"}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001"
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"technicalKey": "Amtsgericht Aachen"
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2025-02-21T08:27:07Z",
"validUntil": "2025-02-21T08:27:07Z"
},
"profile": {"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"relations": [{"startedAt": "2025-02-21T08:27:07Z",
"endedAt": "2025-02-21T08:27:07Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2025-02-21T08:27:07Z"
}
],
"addresses": [{"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"fipsCode": "SZ15",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type",
"technicalKey": "CITY"
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"thoroughfares": [{"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type",
"technicalKey": "INDUSTRIAL_ZONE"
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type",
"technicalKey": "FACTORY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postalDeliveryPoints": [{"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type",
"technicalKey": "MAILBOX"
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
]
},
"featuresOn": ["ENABLE_QUALIFICATION_CONFIRMATION"
],
"featuresOff": ["ENABLE_QUALIFICATION_CONFIRMATION"
]
}

Response samples

application/json

{"status": {"code": "400",
"technicalKey": "OK",
"details": [{"id": 200000004,
"message": "Business Partner Name is mandatory.",
"technicalKey": "JOB_FINISHED",
"jsonPath": "$.businessPartner.names[0].value",
"jsonRecord": "{ \"key\" : \"value\"}"
}
],
"path": "/v2/businesspartners/lookup",
"timestamp": "2025-02-21T08:27:07Z"
},
"dataQualityConfirmation": {"decision": {"technicalKey": "OK"
},
"summary": {"numErrors": "0",
"numWarnings": "0",
"numInfos": "0"
},
"details": {"errors": [{"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
},
"violationLevel": "INFO",
"violationMessage": "Business Partner identifier is mandatory."
}
],
"warnings": [{"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
},
"violationLevel": "INFO",
"violationMessage": "Business Partner identifier is mandatory."
}
],
"infos": [{"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
},
"violationLevel": "INFO",
"violationMessage": "Business Partner identifier is mandatory."
}
]
}
},
"companyConfirmation": {"decision": {"technicalKey": "OK"
},
"summary": {"dataSource": {"name": "Receita Federal Brazil",
"aleiPrefix": "VIES",
"technicalKey": "BR_RF"
},
"overallMatchingClassification": "FULL_MATCH",
"overallMatchingScore": "0.9"
},
"details": {"matchingProfile": {"matchingScores": {"overall": {"classification": "FULL_MATCH",
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": "FULL_MATCH",
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": "FULL_MATCH",
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"matchedCompanyData": {"externalId": "The ID managed in the customer's SAP systems.",
"jsonRecord": "{ \"key\" : \"value\"}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001"
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"technicalKey": "Amtsgericht Aachen"
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2025-02-21T08:27:07Z",
"validUntil": "2025-02-21T08:27:07Z"
},
"profile": {"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"relations": [{"startedAt": "2025-02-21T08:27:07Z",
"endedAt": "2025-02-21T08:27:07Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2025-02-21T08:27:07Z"
}
],
"addresses": [{"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": null,
"technicalKey": null
},
"characterSet": {"name": null,
"technicalKey": null
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"fipsCode": null,
"shortName": null,
"type": null,
"language": null
}
],
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
]
}
]
}
}
},
"qualificationConfirmation": {"decision": {"technicalKey": "OK"
},
"summary": {"dataSource": {"name": "Receita Federal Brazil",
"aleiPrefix": "VIES",
"technicalKey": "BR_RF"
},
"decisionIdentifier": "VALID",
"decisionName": "VALID",
"decisionCity": "VALID",
"decisionStreet": "VALID",
"decisionPostalCode": "VALID"
},
"details": {"identifierResults": {"qualificationDecisions": [{"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
},
"qualificationTarget": "IDENTIFIER",
"decision": "VALID",
"dataSource": {"name": "Receita Federal Brazil",
"aleiPrefix": "VIES",
"technicalKey": "BR_RF"
}
}
]
}
}
},
"sanctionComplianceConfirmation": {"decision": {"technicalKey": "OK"
},
"summary": {"matchingScore": {"classification": "FULL_MATCH",
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"complianceList": {"type": "SANCTIONLIST",
"name": "Seco List «Al-Qaïda»",
"technicalKey": "INFO4C_SL_1",
"issuingBody": {"name": "Amtsgericht Aachen",
"technicalKey": "Amtsgericht Aachen"
},
"rationale": "political background"
}
},
"details": {"complianceListMatches": [{"complianceList": {"type": "SANCTIONLIST",
"name": "Seco List «Al-Qaïda»",
"technicalKey": "INFO4C_SL_1",
"issuingBody": {"name": "Amtsgericht Aachen",
"technicalKey": "Amtsgericht Aachen"
},
"rationale": "political background"
},
"matchingScore": {"classification": "FULL_MATCH",
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
]
}
}
}