# Qualify Business Partner BETAEndpoint used for Business Partner qualification. It is in version and may change without notice. Endpoint: POST /v3/businesspartners/qualify Version: 3 Security: apiKey ## Request fields (application/json): - `dataSources` (array) List of data sources should be used. Enum: "AR.NRC", "AT.CR", "AT.FON", "AU.BR", "BR.RF", "BZST", "CA.CR", "CH.UIDR", "CZ.REE", "DK.CR", "EU.EORI", "FR.RC", "NO.RBE", "PL.NOBR", "SG.BR", "UK.EORI", "UK.VAT", "VIES" - `profile` (string) Qualification profiles enum. Enum: "EU_TAX_QUALIFICATION", "WORLDWIDE_TAX_QUALIFICATION" - `featuresOn` (array) Request features that should be turned on. Enum: "SHOW_LOOKUP_RESULTS", "SHOW_BUSINESS_PARTNER", "FORCE_EXTERNAL_CALL", "SHOW_DEBUG_INFO" - `featuresOff` (array) Request features that should be turned off. Enum: "SHOW_LOOKUP_RESULTS", "SHOW_BUSINESS_PARTNER", "FORCE_EXTERNAL_CALL", "SHOW_DEBUG_INFO" - `businessPartner` (object) An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner. - `businessPartner.id` (string) A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League. Example: "63e635235c06b7396330fe40" - `businessPartner.externalId` (string) Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records. Example: "The ID managed in the customer's SAP systems." - `businessPartner.addresses` (array) List of addresses of the Business Partner. Example: ["Lukasstraße 4, 9008 St. Gallen"] - `businessPartner.addresses.externalId` (string) ID the address has in the external system where the record originates from. Example: "1" - `businessPartner.addresses.version` (object) CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language. Example: "International DE" - `businessPartner.addresses.version.characterSet` (object) Character set. - `businessPartner.addresses.version.characterSet.name` (string) Name of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "International" - `businessPartner.addresses.version.characterSet.technicalKey` (string) Technical key of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "INTERNATIONAL" - `businessPartner.addresses.version.language` (object) Naming of a language according to ISO 639-1. - `businessPartner.addresses.version.language.name` (string) ISO 639-1 name of language. Example: "German" - `businessPartner.addresses.version.language.technicalKey` (string) ISO 639-1 two-letter code of languages. Example: "DE" - `businessPartner.addresses.country` (object) Country consisting of the country name and country code (ISO 3166-1 alpha-2). Example: "Switzerland CH" - `businessPartner.addresses.country.shortName` (string) Country code (ISO 3166-1 alpha-2). Example: "CH" - `businessPartner.addresses.country.value` (string) Country name (ISO 3166-1 alpha-2). Example: "Switzerland" - `businessPartner.addresses.administrativeAreas` (array) List of Administrative Areas. Example: ["Sankt Gallen"] - `businessPartner.addresses.administrativeAreas.value` (string) Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "Sankt Gallen" - `businessPartner.addresses.administrativeAreas.shortName` (string) Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "SG" - `businessPartner.addresses.administrativeAreas.type` (object) Type of the Administrative Area. - `businessPartner.addresses.administrativeAreas.type.name` (string) Display label for the Administrative Area Type. Example: "COUNTY" - `businessPartner.addresses.administrativeAreas.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/administrative_area/type). Example: "https://meta.cdq.com/Address/administrative_area/type" - `businessPartner.addresses.administrativeAreas.type.technicalKey` (string) Technical key of the Administrative Area. Example: "COUNTY" - `businessPartner.addresses.postCodes` (array) List of Post Codes. Example: ["9000"] - `businessPartner.addresses.postCodes.value` (string) Effective [post code](https://meta.cdq.com/Address/post_code). Example: "9000" - `businessPartner.addresses.postCodes.type` (object) Type of the Post Code. - `businessPartner.addresses.postCodes.type.name` (string) Display label for the Post Code Type. Example: "Regular" - `businessPartner.addresses.postCodes.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type). Example: "https://meta.cdq.com/Address/post_code/type" - `businessPartner.addresses.postCodes.type.technicalKey` (string) Technical key of the Post Code. Example: "REGULAR" - `businessPartner.addresses.localities` (array) List of Localities. Example: ["Sankt Gallen"] - `businessPartner.addresses.localities.value` (string) Name of the [Locality](https://meta.cdq.com/Address/locality). Example: "Sankt Gallen" - `businessPartner.addresses.localities.type` (object) Type of the Locality. Example: "City" - `businessPartner.addresses.localities.type.name` (string) Display label for the Locality Type. Example: "City" - `businessPartner.addresses.localities.type.url` (string) URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type). Example: "https://meta.cdq.com/Address/locality/type" - `businessPartner.addresses.localities.type.technicalKey` (string) Technical Key of the Locality Type. Example: "CITY" - `businessPartner.addresses.localities.shortName` (string) Abbreviation of the [Locality](https://meta.cdq.com/Address/locality). Example: "St. Gallen" - `businessPartner.addresses.thoroughfares` (array) List of Thoroughfares. Example: ["Lukasstraße 4"] - `businessPartner.addresses.thoroughfares.type` (object) Type of the Thoroughfare. Example: "Industrial zone" - `businessPartner.addresses.thoroughfares.type.name` (string) Display label for the Thoroughfare Type Name. Example: "Industrial zone" - `businessPartner.addresses.thoroughfares.type.url` (string) URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type). Example: "https://meta.cdq.com/Address/thoroughfare/type" - `businessPartner.addresses.thoroughfares.type.technicalKey` (string) Technical key of the Thoroughfare Type. Example: "INDUSTRIAL_ZONE" - `businessPartner.addresses.thoroughfares.shortName` (string) Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "Lukasstr. 4" - `businessPartner.addresses.thoroughfares.number` (string) Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "4" - `businessPartner.addresses.thoroughfares.value` (string) Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue. Example: "Lukasstraße 4" - `businessPartner.addresses.thoroughfares.name` (string) Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue. Example: "Lukasstraße" - `businessPartner.addresses.thoroughfares.direction` (string) Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "221-bis Baker Street, North" - `businessPartner.addresses.premises` (array) List of Premises. Example: ["Lukasstraße 4, Building 2, Floor 3, Room 4"] - `businessPartner.addresses.premises.value` (string) The actual value of a Premise in the language of the address. Example: "Lukasstraße 4" - `businessPartner.addresses.premises.shortName` (string) Abbreviation of the Premise. Example: "Lukasstr. 4" - `businessPartner.addresses.premises.number` (string) Number of the Premise. Example: "4" - `businessPartner.addresses.premises.type` (object) Type of the Premise. Example: "Building" - `businessPartner.addresses.premises.type.name` (string) Display label for the Premise Type. Example: "Factory" - `businessPartner.addresses.premises.type.url` (string) URL to the documentation which summarizes all details of the [Premise Type](https://meta.cdq.com/Address/premise/type). Example: "https://meta.cdq.com/Address/premise/type" - `businessPartner.addresses.premises.type.technicalKey` (string) Technical key of the Premise Type. Example: "FACTORY" - `businessPartner.addresses.postalDeliveryPoints` (array) List of Postal Delivery Points. Example: ["Sankt Gallen, Postfach 460"] - `businessPartner.addresses.postalDeliveryPoints.type` (object) A single mailbox or other place at which postal mail is delivered. Example: "Sankt Gallen, Postfach 460" - `businessPartner.addresses.postalDeliveryPoints.type.name` (string) Display label for the Postal Delivery Point Type. Example: "Mailbox" - `businessPartner.addresses.postalDeliveryPoints.type.url` (string) URL to the documentation which summarizes all details of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type) Example: "https://meta.cdq.com/Address/postal_delivery_point/type" - `businessPartner.addresses.postalDeliveryPoints.type.technicalKey` (string) Technical key of the Postal Delivery Point. Example: "MAILBOX" - `businessPartner.addresses.postalDeliveryPoints.shortName` (string) Stort name of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "St Gallen, Postfach 460" - `businessPartner.addresses.postalDeliveryPoints.number` (string) Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "460" - `businessPartner.addresses.postalDeliveryPoints.value` (string) Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "Postfach" - `businessPartner.names` (array) List of names of the Business Partner. Example: ["Corporate Data Quality AG"] - `businessPartner.names.shortName` (string) The abbreviated variant of a company's full name. Example: "CDQ AG" - `businessPartner.names.type` (object) The type of the name, e.g. a locally used name or an international version. Example: "Local Name" - `businessPartner.names.type.url` (string) URL to the documentation which summarizes all details of the [Name Type](https://meta.cdq.com/Business_partner/name/type). Example: "https://meta.cdq.com/Business_partner/name/type" - `businessPartner.names.type.name` (string) Display label for the Name Type. Example: "Local Name" - `businessPartner.names.type.technicalKey` (string) Technical Keys of the Name Type. Example: "LOCAL" - `businessPartner.names.value` (string) The actual name. Example: "Corporate Data Quality AG" - `businessPartner.identifiers` (array) List of identifiers of the Business Partner. Example: ["VAT identification number"] - `businessPartner.identifiers.value` (string) Value of the identifier. Example: "CHE-218.608.886 HR/MWST" - `businessPartner.identifiers.type` (object) Type of the identifier. Example: "CH_VAT_ID" - `businessPartner.identifiers.type.url` (string) URL to the documentation which summarizes all details of an [Identifier](https://meta.cdq.com/Business_partner/identifier/type). Example: "https://meta.cdq.com/Business_partner/identifier/type" - `businessPartner.identifiers.type.name` (string) Display label for the Identifier. Example: "CH_VAT_ID" - `businessPartner.identifiers.type.technicalKey` (string) Technical key of the type of the Identifier. Example: "CH_VAT_ID" - `businessPartner.identifiers.issuingBody` (object) An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.name` (string) Preferred display label for an Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.url` (string) URL to the documentation which summarizes all details of a [Issuing Body](https://meta.cdq.com/Business_partner/identifier/issuing_body). Example: "https://meta.cdq.com/Business_partner/identifier/issuing_body" - `businessPartner.identifiers.issuingBody.technicalKey` (string) Technical key of the Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.legalForm` (object) The legal form of a [business partner/type/legal entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the form it takes in the eyes of the law governing it. The legal form of a [company](https://meta.cdq.com/Business_partner) is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc., LLC, S.A.). Example: "Aktiengesellschaft" - `businessPartner.legalForm.name` (string) Display of the Legal Form. Example: "Aktiengesellschaft" - `businessPartner.legalForm.mainAbbreviation` (string) The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country. Example: "AG" - `businessPartner.legalForm.url` (string) URL to the documentation which summarizes all details of [Legal Form](https://meta.cdq.com/Business_partner/legal_form). Example: "https://meta.cdq.com/Business_partner/legal_form" - `businessPartner.legalForm.technicalKey` (string) Technical Key of a Legal Form. Descriptions of below enums contain , and . Example: "DE_9866" - `businessPartner.bankAccounts` (array) List of bank accounts of the Business Partner. - `businessPartner.bankAccounts.internationalBankAccountIdentifier` (string) The IBAN of a bank account. Example: "CH8800781619278412000" - `businessPartner.bankAccounts.internationalBankIdentifier` (string) (BIC/SWIFT) Bank identifier which is globally unique. Example: "KBSGCH22XXX" - `businessPartner.bankAccounts.nationalBankAccountIdentifier` (string) Identifier of a bank account in a national context, i.e. for a country. Example: "619278412000" - `businessPartner.bankAccounts.nationalBankIdentifier` (string) Bank identifier which is unique in a national context, i.e. for a country. Example: "00781" - `businessPartner.bankAccounts.bank` (object) Financial institution that accepts deposits, facilitates withdrawals and transfers, and provides various financial services such as loans, investments, and currency exchange. - `businessPartner.bankAccounts.bank.name` (string) The name of a bank. Example: "Sparda Bank" - `businessPartner.bankAccounts.bank.branch` (string) The branch of a bank. Example: "Filiale München" - `businessPartner.bankAccounts.bank.address` (object) The address where a bank resides. - `businessPartner.status` (object) Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation). - `businessPartner.status.officialDenotation` (string) The status as provided by an official register. Example: "Good Standing" - `businessPartner.status.validFrom` (string) Describes since when a business partner turned or will turn into the provided status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided. Example: "2025-09-01T14:16:48Z" - `businessPartner.status.validUntil` (string) Describes until when a business partner had a certain status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided. Example: "2025-09-01T14:16:48Z" - `businessPartner.status.type` (object) The standardized status which the business partner currently has. Example: "In Liquidation" - `businessPartner.status.type.name` (string) Display name of the Business Partner Status. Example: "In Liquidation" - `businessPartner.status.type.url` (string) URL to the documentation which summarizes all details of the [Business Partner Status](https://meta.cdq.com/Business_partner/status/type). Example: "https://meta.cdq.com/Business_partner/status/type" - `businessPartner.status.type.technicalKey` (string) Technical Key of the Business Parter Status. Example: "IN_LIQUIDATION" - `businessPartner.profile` (object) A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator. - `businessPartner.profile.contactEmails` (array) List of contact emails of the Business Partner. Example: ["developer-portal@cdq.com"] - `businessPartner.profile.contactEmails.value` (string) Value of the email address of the Business Partner. Example: "developer-portal@cdq.com" ## Response 200 fields (application/json): - `qualificationResults` (array) List of Qualifications Results. - `qualificationResults.identifier` (object) Identifies a Business Partner in a given context uniquely such as a VAT identification number. - `qualificationResults.identifier.value` (string) Value of the identifier. Example: "CHE-218.608.886 HR/MWST" - `qualificationResults.identifier.type` (object) Type of the identifier. - `qualificationResults.identifier.type.technicalKey` (string) Technical key of the type of the Identifier. Example: "CH_VAT_ID" - `qualificationResults.businessPartnerStatus` (object) Represents the operational status of the business partner. - `qualificationResults.businessPartnerStatus.type` (object) Describes the type of business partner status. - `qualificationResults.businessPartnerStatus.type.name` (string) Name of the business partner status. Example: "Active" - `qualificationResults.businessPartnerStatus.type.url` (string) URL linking to more information about the business partner status. Example: "https://meta.cdq.com/Business_partner/status/type/technical_key/active" - `qualificationResults.businessPartnerStatus.type.technicalKey` (string) Technical key associated with the business partner status. Example: "ACTIVE" - `qualificationResults.qualifiedAt` (string) Date and time of qualification. Example: "2025-09-01T14:16:48Z" - `qualificationResults.dataSourceTechnicalKey` (string) Data source used for qualification Example: "VIES" - `qualificationResults.dataSourceRequestIdentifiers` (array) List of Request Identifiers. - `qualificationResults.dataSourceRequestIdentifiers.dataSourceTechnicalKey` (string) Technical Key of the Provenance Name. Example: "VIES" - `qualificationResults.dataSourceRequestIdentifiers.value` (string) Value of the datasource technical key. Example: "WAPIAAAAYhCi7BOK" - `qualificationResults.qualificationDecisionSummary` (object) Provides a concise summary of a qualification decision. - `qualificationResults.qualificationDecisionSummary.identifierQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.nameQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.addressQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.addressQualificationDecisionDetails` (object) Represents the details of a qualification decision for an address. - `qualificationResults.qualificationDecisionSummary.addressQualificationDecisionDetails.localityQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.addressQualificationDecisionDetails.postCodeQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.addressQualificationDecisionDetails.thoroughfareQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionSummary.overallQualificationDecision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionDetails` (array) List of Qualification Decision Details. - `qualificationResults.qualificationDecisionDetails.businessRule` (object) Represents a Business Rule. - `qualificationResults.qualificationDecisionDetails.businessRule.name` (string) Represents business rule name. Example: "Identifier unknown (European value added tax identifier (The Netherlands))" - `qualificationResults.qualificationDecisionDetails.businessRule.url` (string) Represents Data Quality Rule url. Example: "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))" - `qualificationResults.qualificationDecisionDetails.businessRule.ruleStatus` (string) Status of the business rule. Example: "RELEASED" - `qualificationResults.qualificationDecisionDetails.businessRule.violationMessage` (string) Violation message that is returned with detected data defect. Example: "Business Partner identifier is mandatory." - `qualificationResults.qualificationDecisionDetails.executionContextProperties` (array) List of Execution Context Properties. - `qualificationResults.qualificationDecisionDetails.executionContextProperties.name` (string) Descriptive name of the context’s attribute Example: "qualificationTarget" - `qualificationResults.qualificationDecisionDetails.executionContextProperties.value` (string) Value of the context execution attribute Example: "STREET" - `qualificationResults.qualificationDecisionDetails.cdqId` (string) The ID provided for a linkage with the source by CDQ. Example: "VIES:PL8660001429" - `qualificationResults.qualificationDecisionDetails.decision` (string) Qualification decision enum. Enum: "VALID", "INVALID", "NOT_PROCESSED", "NO_INPUT_PROVIDED", "NO_REFERENCE_PROVIDED", "EXECUTION_ERROR" - `qualificationResults.qualificationDecisionDetails.error` (object) Detailed information about API errors. - `qualificationResults.qualificationDecisionDetails.error.path` (string) Requested path which caused this error. Example: "/v2/businesspartners/lookup" - `qualificationResults.qualificationDecisionDetails.error.id` (string) Unique identifier of an error, usually in a format of . Example: "REF_VIES_SERVICE_UNAVAILABLE_300" - `qualificationResults.qualificationDecisionDetails.error.timestamp` (string) ISO 8601 representation of the timestamp. Example: "2025-09-01T14:16:48Z" - `qualificationResults.qualificationDecisionDetails.error.message` (string) Details about the error. Example: "This user is not allowed to access this service." - `qualificationResults.qualificationDecisionDetails.error.error` (string) RFC 7231 error which belongs to the status code. Example: "BAD_REQUEST" - `qualificationResults.qualificationDecisionDetails.error.status` (integer) RFC 7231 status code for this error. Example: "400" - `rulesInError` (array) List of rules executed with error. - `rulesInError.businessRule` (object) Set of information about the Business Rule. - `rulesInError.executionStatus` (string) Information about the execution process of the rule. For rules executed correctly or , whenever rule execution is failing by external data sources the status is . Example: "500" - `rulesInError.ruleResult` (string) Contains information, if available, about the data returned from execution of business rule. Example: "parentConceptIdSelector = 'businessPartner.identifiers.technicalKey', content = '1633582012931231', parentConceptUrl='https://meta.cdq.com/Business_partner/identifier', recordId = '451ff2f9-8182-43fc-9728-aad9ce62d771', contentSelector = 'businessPartner.identifiers.value', contentSelectorUrl = 'https://meta.cdq.com/Business_partner/identifier/value', parentConceptId = 'EE_BRN'" - `rulesInError.violationLevel` (string) Indicates the criticality of the applied rule. If a data defect was found then user will get , or level. Otherwise, it will be NO_DEFECT. Example: "INFO" - `rulesInError.validationSource` (string) Name of source used for fetching business rules from. Example: "CDQ" - `lookupResults` (array) List of Lookup Results. - `lookupResults.businessPartner` (object) An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner. - `lookupResults.businessPartner.id` (string) A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League. Example: "63e635235c06b7396330fe40" - `lookupResults.businessPartner.externalId` (string) Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records. Example: "The ID managed in the customer's SAP systems." - `lookupResults.businessPartner.addresses` (array) List of addresses of the Business Partner. Example: ["Lukasstraße 4, 9008 St. Gallen"] - `lookupResults.businessPartner.addresses.externalId` (string) ID the address has in the external system where the record originates from. Example: "1" - `lookupResults.businessPartner.addresses.version` (object) CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language. Example: "International DE" - `lookupResults.businessPartner.addresses.version.characterSet` (object) Character set. - `lookupResults.businessPartner.addresses.version.characterSet.name` (string) Name of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "International" - `lookupResults.businessPartner.addresses.version.characterSet.technicalKey` (string) Technical key of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "INTERNATIONAL" - `lookupResults.businessPartner.addresses.version.language` (object) Naming of a language according to ISO 639-1. - `lookupResults.businessPartner.addresses.version.language.name` (string) ISO 639-1 name of language. Example: "German" - `lookupResults.businessPartner.addresses.version.language.technicalKey` (string) ISO 639-1 two-letter code of languages. Example: "DE" - `lookupResults.businessPartner.addresses.country` (object) Country consisting of the country name and country code (ISO 3166-1 alpha-2). Example: "Switzerland CH" - `lookupResults.businessPartner.addresses.country.shortName` (string) Country code (ISO 3166-1 alpha-2). Example: "CH" - `lookupResults.businessPartner.addresses.country.value` (string) Country name (ISO 3166-1 alpha-2). Example: "Switzerland" - `lookupResults.businessPartner.addresses.administrativeAreas` (array) List of Administrative Areas. Example: ["Sankt Gallen"] - `lookupResults.businessPartner.addresses.administrativeAreas.value` (string) Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "Sankt Gallen" - `lookupResults.businessPartner.addresses.administrativeAreas.shortName` (string) Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "SG" - `lookupResults.businessPartner.addresses.administrativeAreas.type` (object) Type of the Administrative Area. - `lookupResults.businessPartner.addresses.administrativeAreas.type.name` (string) Display label for the Administrative Area Type. Example: "COUNTY" - `lookupResults.businessPartner.addresses.administrativeAreas.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/administrative_area/type). Example: "https://meta.cdq.com/Address/administrative_area/type" - `lookupResults.businessPartner.addresses.administrativeAreas.type.technicalKey` (string) Technical key of the Administrative Area. Example: "COUNTY" - `lookupResults.businessPartner.addresses.postCodes` (array) List of Post Codes. Example: ["9000"] - `lookupResults.businessPartner.addresses.postCodes.value` (string) Effective [post code](https://meta.cdq.com/Address/post_code). Example: "9000" - `lookupResults.businessPartner.addresses.postCodes.type` (object) Type of the Post Code. - `lookupResults.businessPartner.addresses.postCodes.type.name` (string) Display label for the Post Code Type. Example: "Regular" - `lookupResults.businessPartner.addresses.postCodes.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type). Example: "https://meta.cdq.com/Address/post_code/type" - `lookupResults.businessPartner.addresses.postCodes.type.technicalKey` (string) Technical key of the Post Code. Example: "REGULAR" - `lookupResults.businessPartner.addresses.localities` (array) List of Localities. Example: ["Sankt Gallen"] - `lookupResults.businessPartner.addresses.localities.value` (string) Name of the [Locality](https://meta.cdq.com/Address/locality). Example: "Sankt Gallen" - `lookupResults.businessPartner.addresses.localities.type` (object) Type of the Locality. Example: "City" - `lookupResults.businessPartner.addresses.localities.type.name` (string) Display label for the Locality Type. Example: "City" - `lookupResults.businessPartner.addresses.localities.type.url` (string) URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type). Example: "https://meta.cdq.com/Address/locality/type" - `lookupResults.businessPartner.addresses.localities.type.technicalKey` (string) Technical Key of the Locality Type. Example: "CITY" - `lookupResults.businessPartner.addresses.localities.shortName` (string) Abbreviation of the [Locality](https://meta.cdq.com/Address/locality). Example: "St. Gallen" - `lookupResults.businessPartner.addresses.thoroughfares` (array) List of Thoroughfares. Example: ["Lukasstraße 4"] - `lookupResults.businessPartner.addresses.thoroughfares.type` (object) Type of the Thoroughfare. Example: "Industrial zone" - `lookupResults.businessPartner.addresses.thoroughfares.type.name` (string) Display label for the Thoroughfare Type Name. Example: "Industrial zone" - `lookupResults.businessPartner.addresses.thoroughfares.type.url` (string) URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type). Example: "https://meta.cdq.com/Address/thoroughfare/type" - `lookupResults.businessPartner.addresses.thoroughfares.type.technicalKey` (string) Technical key of the Thoroughfare Type. Example: "INDUSTRIAL_ZONE" - `lookupResults.businessPartner.addresses.thoroughfares.shortName` (string) Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "Lukasstr. 4" - `lookupResults.businessPartner.addresses.thoroughfares.number` (string) Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "4" - `lookupResults.businessPartner.addresses.thoroughfares.value` (string) Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue. Example: "Lukasstraße 4" - `lookupResults.businessPartner.addresses.thoroughfares.name` (string) Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue. Example: "Lukasstraße" - `lookupResults.businessPartner.addresses.thoroughfares.direction` (string) Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "221-bis Baker Street, North" - `lookupResults.businessPartner.addresses.premises` (array) List of Premises. Example: ["Lukasstraße 4, Building 2, Floor 3, Room 4"] - `lookupResults.businessPartner.addresses.premises.value` (string) The actual value of a Premise in the language of the address. Example: "Lukasstraße 4" - `lookupResults.businessPartner.addresses.premises.shortName` (string) Abbreviation of the Premise. Example: "Lukasstr. 4" - `lookupResults.businessPartner.addresses.premises.number` (string) Number of the Premise. Example: "4" - `lookupResults.businessPartner.addresses.premises.type` (object) Type of the Premise. Example: "Building" - `lookupResults.businessPartner.addresses.premises.type.name` (string) Display label for the Premise Type. Example: "Factory" - `lookupResults.businessPartner.addresses.premises.type.url` (string) URL to the documentation which summarizes all details of the [Premise Type](https://meta.cdq.com/Address/premise/type). Example: "https://meta.cdq.com/Address/premise/type" - `lookupResults.businessPartner.addresses.premises.type.technicalKey` (string) Technical key of the Premise Type. Example: "FACTORY" - `lookupResults.businessPartner.addresses.postalDeliveryPoints` (array) List of Postal Delivery Points. Example: ["Sankt Gallen, Postfach 460"] - `lookupResults.businessPartner.addresses.postalDeliveryPoints.type` (object) A single mailbox or other place at which postal mail is delivered. Example: "Sankt Gallen, Postfach 460" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.type.name` (string) Display label for the Postal Delivery Point Type. Example: "Mailbox" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.type.url` (string) URL to the documentation which summarizes all details of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type) Example: "https://meta.cdq.com/Address/postal_delivery_point/type" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.type.technicalKey` (string) Technical key of the Postal Delivery Point. Example: "MAILBOX" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.shortName` (string) Stort name of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "St Gallen, Postfach 460" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.number` (string) Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "460" - `lookupResults.businessPartner.addresses.postalDeliveryPoints.value` (string) Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "Postfach" - `lookupResults.businessPartner.names` (array) List of names of the Business Partner. Example: ["Corporate Data Quality AG"] - `lookupResults.businessPartner.names.shortName` (string) The abbreviated variant of a company's full name. Example: "CDQ AG" - `lookupResults.businessPartner.names.type` (object) The type of the name, e.g. a locally used name or an international version. Example: "Local Name" - `lookupResults.businessPartner.names.type.url` (string) URL to the documentation which summarizes all details of the [Name Type](https://meta.cdq.com/Business_partner/name/type). Example: "https://meta.cdq.com/Business_partner/name/type" - `lookupResults.businessPartner.names.type.name` (string) Display label for the Name Type. Example: "Local Name" - `lookupResults.businessPartner.names.type.technicalKey` (string) Technical Keys of the Name Type. Example: "LOCAL" - `lookupResults.businessPartner.names.value` (string) The actual name. Example: "Corporate Data Quality AG" - `lookupResults.businessPartner.identifiers` (array) List of identifiers of the Business Partner. Example: ["VAT identification number"] - `lookupResults.businessPartner.identifiers.issuingBody` (object) An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects. Example: "Amtsgericht Aachen" - `lookupResults.businessPartner.identifiers.issuingBody.name` (string) Preferred display label for an Issuing Body. Example: "Amtsgericht Aachen" - `lookupResults.businessPartner.identifiers.issuingBody.url` (string) URL to the documentation which summarizes all details of a [Issuing Body](https://meta.cdq.com/Business_partner/identifier/issuing_body). Example: "https://meta.cdq.com/Business_partner/identifier/issuing_body" - `lookupResults.businessPartner.identifiers.issuingBody.technicalKey` (string) Technical key of the Issuing Body. Example: "Amtsgericht Aachen" - `lookupResults.businessPartner.legalForm` (object) The legal form of a [business partner/type/legal entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the form it takes in the eyes of the law governing it. The legal form of a [company](https://meta.cdq.com/Business_partner) is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc., LLC, S.A.). Example: "Aktiengesellschaft" - `lookupResults.businessPartner.legalForm.name` (string) Display of the Legal Form. Example: "Aktiengesellschaft" - `lookupResults.businessPartner.legalForm.mainAbbreviation` (string) The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country. Example: "AG" - `lookupResults.businessPartner.legalForm.url` (string) URL to the documentation which summarizes all details of [Legal Form](https://meta.cdq.com/Business_partner/legal_form). Example: "https://meta.cdq.com/Business_partner/legal_form" - `lookupResults.businessPartner.legalForm.technicalKey` (string) Technical Key of a Legal Form. Descriptions of below enums contain , and . Example: "DE_9866" - `lookupResults.businessPartner.bankAccounts` (array) List of bank accounts of the Business Partner. - `lookupResults.businessPartner.bankAccounts.internationalBankAccountIdentifier` (string) The IBAN of a bank account. Example: "CH8800781619278412000" - `lookupResults.businessPartner.bankAccounts.internationalBankIdentifier` (string) (BIC/SWIFT) Bank identifier which is globally unique. Example: "KBSGCH22XXX" - `lookupResults.businessPartner.bankAccounts.nationalBankAccountIdentifier` (string) Identifier of a bank account in a national context, i.e. for a country. Example: "619278412000" - `lookupResults.businessPartner.bankAccounts.nationalBankIdentifier` (string) Bank identifier which is unique in a national context, i.e. for a country. Example: "00781" - `lookupResults.businessPartner.bankAccounts.bank` (object) Financial institution that accepts deposits, facilitates withdrawals and transfers, and provides various financial services such as loans, investments, and currency exchange. - `lookupResults.businessPartner.bankAccounts.bank.name` (string) The name of a bank. Example: "Sparda Bank" - `lookupResults.businessPartner.bankAccounts.bank.branch` (string) The branch of a bank. Example: "Filiale München" - `lookupResults.businessPartner.bankAccounts.bank.address` (object) The address where a bank resides. - `lookupResults.businessPartner.status` (object) Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation). - `lookupResults.businessPartner.status.officialDenotation` (string) The status as provided by an official register. Example: "Good Standing" - `lookupResults.businessPartner.status.validFrom` (string) Describes since when a business partner turned or will turn into the provided status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided. Example: "2025-09-01T14:16:48Z" - `lookupResults.businessPartner.status.validUntil` (string) Describes until when a business partner had a certain status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided. Example: "2025-09-01T14:16:48Z" - `lookupResults.businessPartner.status.type` (object) The standardized status which the business partner currently has. Example: "In Liquidation" - `lookupResults.businessPartner.status.type.name` (string) Display name of the Business Partner Status. Example: "In Liquidation" - `lookupResults.businessPartner.status.type.url` (string) URL to the documentation which summarizes all details of the [Business Partner Status](https://meta.cdq.com/Business_partner/status/type). Example: "https://meta.cdq.com/Business_partner/status/type" - `lookupResults.businessPartner.status.type.technicalKey` (string) Technical Key of the Business Parter Status. Example: "IN_LIQUIDATION" - `lookupResults.businessPartner.profile` (object) A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator. - `lookupResults.businessPartner.profile.contactEmails` (array) List of contact emails of the Business Partner. Example: ["developer-portal@cdq.com"] - `lookupResults.businessPartner.profile.contactEmails.value` (string) Value of the email address of the Business Partner. Example: "developer-portal@cdq.com" - `lookupResults.address` (object) An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address). Example: "Lukasstraße 4, 9008 St. Gallen" - `lookupResults.matchingScore` (number) Matching score of the lookup result. Example: "0.9" - `lookupResults.dataSource` (string) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e" - `lookupResults.cdqId` (string) CDQ ID of the business partner. Example: "VIES:DE119267630" - `debugInfo` (object) Reference implementation how to structure external service responses. Can be activated by a feature . - `debugInfo.externalServiceResponses` (array) List of external service responses. - `debugInfo.externalServiceResponses.status` (integer) HTTP status code returned from external Data Source. Example: "200" - `debugInfo.externalServiceResponses.message` (string) Typically, contains an error message received from external data source, only if returned. Can show CDQ-related messages. Example: "There is no more quota left for this Data Source." - `debugInfo.externalServiceResponses.path` (string) When legacy qualification is done with BZST Data Source, then full request path is returned Example: "/data-validation/businesspartners/validate" - `debugInfo.externalServiceResponses.details` (string) Additional details about External Service. Example: "Detailed message" - `debugInfo.externalServiceResponses.timestamp` (string) The timestamp of execution the request to external Data Source. Example: "2025-09-01T14:16:48Z" - `debugInfo.externalServiceResponses.additionalInformation` (array) Any additional information received during the original request. - `debugInfo.externalServiceResponses.additionalInformation.key` (string) Property name. Example: "requestId" - `debugInfo.externalServiceResponses.additionalInformation.value` (string) Value of given property. Example: "WAPIAAAAYse8yTdE" - `debugInfo.businessRulesExecutionSummary` (object) Summary of Business Rules execution. - `debugInfo.businessRulesExecutionSummary.numberOfRules` (integer) Number of rules executed. Example: "274" - `debugInfo.businessRulesExecutionSummary.numberOfExecutions` (integer) Number of rule executions. Example: "273" - `debugInfo.businessRulesExecutionSummary.numberOfFails` (integer) Number of failed rule executions. Example: "1" - `debugInfo.businessRulesExecutionSummary.failures` (array) List of failed rules. - `debugInfo.businessRulesExecutionSummary.failures.message` (string) Descriptive message, usually an error, with the reason why execution of the rule didn’t succeed. Example: "Message to be filled in." - `debugInfo.businessRulesExecutionSummary.failures.externalId` (string) External ID of the Business Partner or Record being validated. Example: "955775" - `debugInfo.businessRulesExecutionSummary.warnings` (array) List of data sources used in validation. - `debugInfo.businessRulesExecutionSummary.warnings.message` (string) Descriptive message, usually a warning. Example: "Message to be filled in." - `debugInfo.businessRulesExecutionSummary.dataSourcesOn` (array) List of data sources used in validation. - `debugInfo.businessRulesExecutionSummary.dataSourcesOn.prefix` (string) Identifies external Data Source. Example: "VIES" - `debugInfo.businessRulesExecutionSummary.dataSourcesOff` (array) List of data sources not used in validation. - `debugInfo.businessRulesExecutionSummary.activatedRules` (array) List of activated rules. Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"] - `debugInfo.businessRulesExecutionSummary.ignoredRules` (array) List of ignored rules. Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"] - `debugInfo.businessRulesExecutionSummary.ruleCategoriesOn` (array) List of activated rule categories. - `debugInfo.businessRulesExecutionSummary.ruleCategoriesOn.url` (string) URL of the rule category. Example: "https://meta.cdq.com/Identifier_checkdigit" - `debugInfo.businessRulesExecutionSummary.ruleStatuses` (array) Filter for rule status. Example: ["RELEASED"] - `debugInfo.businessRulesExecutionSummary.violationLevels` (array) Filter for rule violation level (criticality). Example: ["INFO"]