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: "VIES:PL8660001429"

featuresOff

Array of strings

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

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/referencedata/rest/v3/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"example": "VIES:PL8660001429"
}

Response samples

application/json

{"status": "OK",
"message": "Service returned a correct response.",
"cdqId": "VIES:PL8660001429",
"dataSource": "BR_RF",
"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": { },
"language": { }
}
]
},
"gleifCode": "RA000004",
"localAuthorityCode": "R3101",
"externalUrl": "https://www.amtsgericht.de/muenchen"
}
}
],
"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.",
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptVariants": [{"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptCode": {"name": null,
"code": null
}
}
]
},
"legalForm": {"name": "Code list entry name.",
"code": "AG"
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": {"name": "Code list entry name.",
"code": "IDCARD"
},
"identificationNumber": "DE123456789",
"country": {"name": "Code list entry name.",
"code": "DE"
},
"region": {"name": "Code list entry name.",
"code": "DE-BW"
},
"institute": "Federal Republic of Germany"
}
],
"taxNumbers": [{"taxNumberType": {"name": "Code list entry name.",
"code": "VAT"
},
"taxNumber": "DE123456789"
}
],
"addressData": [{"validFrom": "2025-02-20T19:04:01Z",
"validTo": "2025-02-20T19:04:01Z",
"usages": [{"validFrom": "2025-02-20T19:04:01Z",
"validTo": "2025-02-20T19:04:01Z",
"usage": {"name": null,
"code": null
},
"isStandard": "true"
}
],
"postalAddressType": "organizationPostalAddress",
"organizationPostalAddress": {"streetPrefix1": "StreetPrefix1",
"streetPrefix2": "StreetPrefix1",
"street": {"name": "Main Street",
"ref": {"name": null,
"code": null
}
},
"streetSuffix1": "StreetSuffix1",
"streetSuffix2": "StreetSuffix2",
"houseNumber": "Building 1",
"houseNumberSupplement": "2nd floor",
"building": "Building 1",
"floor": "2nd floor",
"door": "Room 14",
"careOf": "c/o John Doe",
"primaryRegion": {"name": "Code list entry name.",
"code": "DE-BW"
},
"secondaryRegion": {"name": "Montgomery County",
"ref": {"name": null,
"code": null
}
},
"tertiaryRegion": {"name": "Montgomery County",
"ref": {"name": null,
"code": null
}
},
"town": {"name": "Berlin",
"ref": {"name": null,
"code": null
}
},
"district": {"name": "Mitte",
"ref": {"name": null,
"code": null
}
},
"country": {"name": "Code list entry name.",
"code": "DE"
},
"postCode": "10115",
"alternative": {"country": {"name": null,
"code": null
},
"postCode": "10115",
"primaryRegion": {"name": null,
"code": null
},
"secondaryRegion": {"name": null,
"ref": { }
},
"tertiaryRegion": {"name": null,
"ref": { }
},
"town": {"name": null,
"ref": { }
},
"district": {"name": null,
"ref": { }
},
"deliveryType": {"name": null,
"code": null
},
"deliveryServiceType": "POBoxDelivery",
"deliveryServiceQualifier": "Post Office SouthEast",
"deliveryServiceIdentifier": "1234"
},
"coordinates": {"latitude": "52.520008",
"longitude": "13.404954",
"altitude": "34.0"
},
"scriptVariants": [{"formattedOrgNameLine1": null,
"formattedOrgNameLine2": null,
"formattedOrgNameLine3": null,
"formattedOrgNameLine4": null,
"formattedOrgName": null,
"streetPrefix1": null,
"streetPrefix2": null,
"street": { },
"streetSuffix1": null,
"streetSuffix2": null,
"houseNumber": null,
"houseNumberSupplement": null,
"building": null,
"floor": null,
"door": null,
"careOf": null,
"primaryRegion": { },
"secondaryRegion": { },
"tertiaryRegion": { },
"town": { },
"district": { },
"country": { },
"postCode": null,
"alternative": { },
"coordinates": { },
"scriptCode": { }
}
]
},
"emailAddresses": {"validFrom": "2025-02-20T19:04:01Z",
"validTo": "2025-02-20T19:04:01Z",
"address": "developer-portal@cdq.com"
},
"websites": {"validFrom": "2025-02-20T19:04:01Z",
"validTo": "2025-02-20T19:04:01Z",
"url": "https://www.developer.cdq.com"
}
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
}
}

Fetch Business Partner

Request Body schema: application/jsonrequired

Request Body schema: application/json
required