Fetch Business Partner

Fetch business partner by CDQ-ID

SecurityapiKey

Request

Request Body schema: application/json
required

cdqId

string

CDQ ID for business partner and address.

Example: "CDQ:DE123456789"

featuresOff

Array of strings (BusinessPartnerFetchFeature)

List of features to be deactivated.

Items Value:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]

featuresOn

Array of strings (BusinessPartnerFetchFeature)

List of features to be activated.

Items Value:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"cdqId": "VIES:CZ46981691"
}

Response samples

application/json

{"status": "OK",
"message": "Message describing the status of the request.",
"cdqId": "CDQ:DE123456789",
"dataSource": "VIES",
"businessPartner": {"names": [{"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
],
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866"
},
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"status": {"name": "ACTIVE",
"url": "https://meta.cdq.com/Business_partner/identifier/status",
"technicalKey": "ACTIVE"
},
"issuingBody": {"name": "Amtsgericht Aachen",
"shortName": "Amtsgericht Aachen",
"names": [{"shortName": "CDQ AG",
"type": {"url": null,
"name": null,
"technicalKey": null
},
"value": "Corporate Data Quality AG",
"language": {"name": null,
"technicalKey": null
}
}
],
"description": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
]
},
"gleifCode": "RA000004",
"localAuthorityCode": "R3101",
"externalUrl": "https://www.amtsgericht.de/muenchen"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2025-02-21T08:27:06Z",
"validUntil": "2025-02-21T08:27:06Z",
"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"addresses": [{"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"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",
"shortName": "SG",
"fipsCode": "SZ15",
"isoCode": "CH-SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": ["9000"
],
"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"
}
}
],
"openingHours": [{"openingHour": "09:00 AM",
"closingHour": "05:00 PM",
"weekday": "Monday"
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postalCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"postOfficeBox": "Postfach 460"
}
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"level": "primary",
"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"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2025-02-21T08:27:06Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"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": "2025-02-21T08:27:06Z",
"endedAt": "2025-02-21T08:27:06Z",
"type": {"name": "Commercial ultimate",
"url": "https://meta.cdq.com/Business_partner/relation/type",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"url": "https://meta.cdq.com/Business_partner/relation/class",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"bank": {"name": "Sparda Bank",
"branch": "Filiale München",
"address": {"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": ["9000"
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
]
}
}
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
},
"businessPartnerSapOdm": {"displayId": "Number to be determined",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formOfAddress": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Dear customer"
},
"legalForm": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"industries": [{"industrySector": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"industrySystemType": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"isStandardIndustry": "true"
}
],
"globalLocationNumber": "0847976000005",
"foundationDate": "2025-02-21T08:27:06Z",
"liquidationDate": "2025-02-21T08:27:06Z"
},
"lifecycleStatus": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"identifications": [{"validFrom": "2025-02-21T08:27:06Z",
"validTo": "2025-02-21T08:27:06Z"
}
],
"taxNumbers": [{"taxNumberType": {"name": "Code list entry name.",
"descr": "Code list entry description."
},
"taxNumber": "DE123456789"
}
],
"addressData": [{"validFrom": "2025-02-21T08:27:06Z",
"validTo": "2025-02-21T08:27:06Z"
}
]
}
}

Fetch Business Partner

Request Body schema: application/jsonrequired

Request Body schema: application/json
required