# Search Business Partners

Use for single queries to quickly find a Business Partner.
User have to verify the results.
To be used when Business Partner is not normalized e.g. Company Name and Address are in one line.


Endpoint: POST /v3/businesspartners/search
Version: 3
Security: apiKey

## Request fields (application/json):

  - `query` (string)
    Pattern which will be used to search in multiple fields.
    Example: "CDQ Lukasstrasse 4, Sankt Gallen 9000"

  - `pageSize` (integer)
    Number of items per page. Default 10.
    Example: "10"

  - `page` (integer)
    Current page number.
    Example: "1"

## Response 200 fields (application/json):

  - `pageSize` (integer)
    Number of items per page. Default 10.
    Example: "10"

  - `totals` (integer)
    Total number of items which can be paged.
    Example: "67"

  - `page` (integer)
    Current page number.
    Example: "1"

  - `values` (array)
    List of Business Partners search entry.

  - `values.relevanceScore` (number)
    Value shows how relevant the results are based on given query
    Example: "0.8"

  - `values.cdqId` (string)
    Unique identifier for the Business Partner.
    Example: "VIES:PL8660001429"

  - `values.dataSource` (string)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `values.businessPartner` (object)
    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.

  - `values.businessPartner.names` (array)
    List of names of the Business Partner.

  - `values.businessPartner.names.shortName` (string)
    The abbreviated variant of a company's full name.
    Example: "CDQ AG"

  - `values.businessPartner.names.type` (object)
    The type of the name, e.g. a locally used name or an international version. Allowed types are documented [here](https://meta.cdq.com/Business_partner/name/type).

  - `values.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"

  - `values.businessPartner.names.type.name` (string)
    Display label for the Name Type.
    Example: "Local Name"

  - `values.businessPartner.names.type.technicalKey` (string)
    Technical Keys of the Name Type.
    Example: "LOCAL"

  - `values.businessPartner.names.value` (string)
    The actual name.
    Example: "Corporate Data Quality AG"

  - `values.businessPartner.names.language` (object)
    Naming of a language according to ISO 639-1.

  - `values.businessPartner.names.language.name` (string)
    ISO 639-1 name of language.
    Example: "German"

  - `values.businessPartner.names.language.technicalKey` (string)
    ISO 639-1 two-letter code of languages.
    Example: "DE"

  - `values.businessPartner.names.details` (array)

  - `values.businessPartner.names.details.value` (string)
    Value of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "Corporate Data Quality AG - Marketing Department"

  - `values.businessPartner.names.details.type` (object)
    Type of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).

  - `values.businessPartner.names.details.type.name` (string)
    Name Detail Type Name of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "Legal Entity"

  - `values.businessPartner.names.details.type.url` (string)
    Name Detail Type Url of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "https://meta.cdq.com/Business_partner/type"

  - `values.businessPartner.names.details.type.technicalKey` (string)
    Name Detail Type Technical Key of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "LEGAL_ENTITY"

  - `values.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.).

  - `values.businessPartner.legalForm.name` (string)
    Display of the Legal Form.
    Example: "Aktiengesellschaft"

  - `values.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"

  - `values.businessPartner.legalForm.mainAbbreviation` (string)
    The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country.
    Example: "AG"

  - `values.businessPartner.legalForm.categories` (array)
    List of categories of the legal form.

  - `values.businessPartner.legalForm.categories.name` (string)
    Descriptive display name of the Legal Form Category.
    Example: "Limited Liability Company"

  - `values.businessPartner.legalForm.categories.shortName` (string)
    Short display name of the Legal Form Category.
    Example: "LLC"

  - `values.businessPartner.legalForm.categories.url` (string)
    URL to the documentation which summarizes all details of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category).
    Example: "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001"

  - `values.businessPartner.legalForm.categories.technicalKey` (string)
    Technical Key of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category).
    Example: "LIMITED"

  - `values.businessPartner.legalForm.technicalKey` (string)
    Technical Key of a Legal Form. Descriptions of below enums contain ,  and .
    Example: "DE_9866"

  - `values.businessPartner.legalForm.cdlElfCode` (string)
    An unique identifier for CDL managed Legal Forms.
    Example: "AG"

  - `values.businessPartner.identifiers` (array)
    List of identifiers of the Business Partner.

  - `values.businessPartner.identifiers.type` (object)
    Value of the identifier. Allowed types are documented [here](https://meta.cdq.com/Category:Business_partner/identifier/type).

  - `values.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"

  - `values.businessPartner.identifiers.type.name` (string)
    Display label for the Identifier.
    Example: "CH_VAT_ID"

  - `values.businessPartner.identifiers.type.technicalKey` (string)
    Technical key of the type of the Identifier.
    Example: "CH_VAT_ID"

  - `values.businessPartner.identifiers.value` (string)
    Value of the identifier.
    Example: "CHE-218.608.886 HR/MWST"

  - `values.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.

  - `values.businessPartner.identifiers.issuingBody.shortName` (string)
    Preferred short display label for an Issuing Body.
    Example: "Amtsgericht Aachen"

  - `values.businessPartner.identifiers.issuingBody.name` (string)
    Preferred display label for an Issuing Body.
    Example: "Amtsgericht Aachen"

  - `values.businessPartner.identifiers.issuingBody.names` (array)
    List of names of the Issuing Body.

  - `values.businessPartner.identifiers.issuingBody.names.type` (object)
    The type of the name, e.g. a locally used name or an international version.

  - `values.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"

  - `values.businessPartner.identifiers.issuingBody.technicalKey` (string)
    Technical key of the Issuing Body.
    Example: "Amtsgericht Aachen"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction` (object)
    The authority of an official organization to make decisions and judgments in a particular administrative area.

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.country` (object)
    Country consisting of the country name and country code (ISO 3166-1 alpha-2).

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.country.shortName` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.country.value` (string)
    Country name (ISO 3166-1 alpha-2).
    Example: "Switzerland"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas` (array)
    List of administrative areas in the jurisdiction.
    Example: ["Sankt Gallen"]

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.value` (string)
    Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area).
    Example: "Sankt Gallen"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.shortName` (string)
    Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area).
    Example: "SG"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.fipsCode` (string)
    FIPS codes are numbers which uniquely identify geographic areas. The number of digits in FIPS codes vary depending on the level of geography. State-level FIPS codes have two digits, county-level FIPS codes have five digits of which the first two are the FIPS code of the state to which the county belongs.
    Example: "SZ15"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.isoCode` (string)
    ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states).
    Example: "CH-SG"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type` (object)
    Type of the [Administrative Area](https://meta.cdq.com/Address/administrative_area).

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type.name` (string)
    Display label for the Administrative Area Type.
    Example: "COUNTY"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.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"

  - `values.businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type.technicalKey` (string)
    Technical key of the Administrative Area.
    Example: "COUNTY"

  - `values.businessPartner.identifiers.status` (object)
    Identifier Status refers to the current state of a unique identification number.

  - `values.businessPartner.identifiers.status.name` (string)
    Display label for the Identifier Status Name.
    Example: "ACTIVE"

  - `values.businessPartner.identifiers.status.technicalKey` (string)
    Technical key of the Identifier Status.
    Example: "ACTIVE"

  - `values.businessPartner.categories` (array)
    List of categories of the Business Partner.

  - `values.businessPartner.categories.name` (string)
    Display name of the Business Partner Category Name.
    Example: "Hotel"

  - `values.businessPartner.categories.url` (string)
    URL to the documentation which summarizes all details of the [Business Partner Category](https://meta.cdq.com/Business_partner/category).
    Example: "https://meta.cdq.com/Business_partner/category"

  - `values.businessPartner.categories.technicalKey` (string)
    Technical Key of the Business Partner Category.
    Example: "HOTEL"

  - `values.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).

  - `values.businessPartner.status.officialDenotation` (string)
    The status as provided by an official register.
    Example: "Good Standing"

  - `values.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-12T14:57:59Z"

  - `values.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-12T14:57:59Z"

  - `values.businessPartner.status.type` (object)
    The standardized status which the business partner currently has.

  - `values.businessPartner.status.type.name` (string)
    Display name of the Business Partner Status.
    Example: "In Liquidation"

  - `values.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"

  - `values.businessPartner.status.type.technicalKey` (string)
    Technical Key of the Business Parter Status.
    Example: "IN_LIQUIDATION"

  - `values.businessPartner.addresses` (array)
    List of addresses of the Business Partner.

  - `values.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.

  - `values.businessPartner.addresses.version.characterSet` (object)
    Collection of [characters](https://meta.cdq.com/Address/version/character_set) that can be used to represent and manipulate textual data.

  - `values.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"

  - `values.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"

  - `values.businessPartner.addresses.identifyingName` (object)
    An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.

  - `values.businessPartner.addresses.identifyingName.value` (string)
    An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.
    Example: "John Doe"

  - `values.businessPartner.addresses.externalId` (string)
    ID the address has in the external system where the record originates from.
    Example: "1"

  - `values.businessPartner.addresses.metadata` (object)
    Specifies the language and primary data provenance.

  - `values.businessPartner.addresses.metadata.primaryProvenance` (object)
    The source of the change/update. Could be the reference data source as VIES or Organization.

  - `values.businessPartner.addresses.metadata.primaryProvenance.name` (string)
    Display Name of the Provenance Name.
    Example: "VIES"

  - `values.businessPartner.addresses.metadata.primaryProvenance.url` (string)
    URL to the documentation which summarizes all details of the Provenance Name.
    Example: "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter="

  - `values.businessPartner.addresses.metadata.primaryProvenance.technicalKey` (string)
    Technical Key of the Provenance Name.
    Example: "VIES"

  - `values.businessPartner.addresses.metadata.primaryProvenance.cdqId` (string)
    The ID provided for a linkage with the source by CDQ.
    Example: "VIES:PL8660001429"

  - `values.businessPartner.addresses.careOf` (object)
    Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.

  - `values.businessPartner.addresses.careOf.value` (string)
    Value of the CareOf.
    Example: "CDQ GmbH c/o Product Department"

  - `values.businessPartner.addresses.contexts` (array)
    List of address contexts.

  - `values.businessPartner.addresses.contexts.value` (string)
    Value of the Address Context.
    Example: "Production hall 7, Storage field 8."

  - `values.businessPartner.addresses.administrativeAreas` (array)
    List of administrative areas.
    Example: ["Sankt Gallen"]

  - `values.businessPartner.addresses.postCodes` (array)
    List of post codes.

  - `values.businessPartner.addresses.postCodes.value` (string)
    Effective [post code](https://meta.cdq.com/Address/post_code).
    Example: "9000"

  - `values.businessPartner.addresses.postCodes.type` (object)
    Type of the Post Code.

  - `values.businessPartner.addresses.postCodes.type.name` (string)
    Display label for the Post Code Type.
    Example: "Regular"

  - `values.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"

  - `values.businessPartner.addresses.postCodes.type.technicalKey` (string)
    Technical key of the Post Code.
    Example: "REGULAR"

  - `values.businessPartner.addresses.localities` (array)
    List of localities.

  - `values.businessPartner.addresses.localities.type` (object)
    Type of the [Locality](https://meta.cdq.com/Address/locality).

  - `values.businessPartner.addresses.localities.type.name` (string)
    Display label for the Locality Type.
    Example: "City"

  - `values.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"

  - `values.businessPartner.addresses.localities.type.technicalKey` (string)
    Technical Key of the Locality Type.
    Example: "CITY"

  - `values.businessPartner.addresses.localities.shortName` (string)
    Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "St. Gallen"

  - `values.businessPartner.addresses.localities.value` (string)
    Name of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "Sankt Gallen"

  - `values.businessPartner.addresses.thoroughfares` (array)
    List of thoroughfares.

  - `values.businessPartner.addresses.thoroughfares.type` (object)
    Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).

  - `values.businessPartner.addresses.thoroughfares.type.name` (string)
    Display label for the Thoroughfare Type Name.
    Example: "Industrial zone"

  - `values.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"

  - `values.businessPartner.addresses.thoroughfares.type.technicalKey` (string)
    Technical key of the Thoroughfare Type.
    Example: "INDUSTRIAL_ZONE"

  - `values.businessPartner.addresses.thoroughfares.shortName` (string)
    Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "Lukasstr. 4"

  - `values.businessPartner.addresses.thoroughfares.number` (string)
    Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "4"

  - `values.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"

  - `values.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"

  - `values.businessPartner.addresses.thoroughfares.direction` (string)
    Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "221-bis Baker Street, North"

  - `values.businessPartner.addresses.premises` (array)
    List of premises.

  - `values.businessPartner.addresses.premises.value` (string)
    The actual value of a Premise in the language of the address.
    Example: "Lukasstraße 4"

  - `values.businessPartner.addresses.premises.shortName` (string)
    Abbreviation of the Premise.
    Example: "Lukasstr. 4"

  - `values.businessPartner.addresses.premises.number` (string)
    Number of the Premise.
    Example: "4"

  - `values.businessPartner.addresses.premises.type` (object)
    Type of the Premise.

  - `values.businessPartner.addresses.premises.type.name` (string)
    Display label for the Premise Type.
    Example: "Factory"

  - `values.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"

  - `values.businessPartner.addresses.premises.type.technicalKey` (string)
    Technical key of the Premise Type.
    Example: "FACTORY"

  - `values.businessPartner.addresses.postalDeliveryPoints` (array)
    List of postal delivery points.

  - `values.businessPartner.addresses.postalDeliveryPoints.type` (object)
    A single mailbox or other place at which postal mail is delivered.

  - `values.businessPartner.addresses.postalDeliveryPoints.type.name` (string)
    Display label for the Postal Delivery Point Type.
    Example: "Mailbox"

  - `values.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"

  - `values.businessPartner.addresses.postalDeliveryPoints.type.technicalKey` (string)
    Technical key of the Postal Delivery Point.
    Example: "MAILBOX"

  - `values.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"

  - `values.businessPartner.addresses.postalDeliveryPoints.number` (string)
    Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point).
    Example: "460"

  - `values.businessPartner.addresses.postalDeliveryPoints.value` (string)
    Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point).
    Example: "Postfach"

  - `values.businessPartner.addresses.geographicCoordinates` (object)
    Decimal geographic coordinates (WGS 84 - reference coordinate system).

  - `values.businessPartner.addresses.geographicCoordinates.latitude` (number)
    Plain on the earth's surface north or south of the equator.
    Example: "47.439549"

  - `values.businessPartner.addresses.geographicCoordinates.longitude` (number)
    Plain on the earth's surface east or west of a meridian.
    Example: "9.395275"

  - `values.businessPartner.addresses.types` (array)
    List of address types.

  - `values.businessPartner.addresses.types.name` (string)
    Display label for the Address Type.
    Example: "Legal Address"

  - `values.businessPartner.addresses.types.url` (string)
    URL to the documentation which summarizes all details of the [Address Type](https://meta.cdq.com/Address/type).
    Example: "https://meta.cdq.com/Address/type"

  - `values.businessPartner.addresses.types.technicalKey` (string)
    Technical key of the Address Type.
    Example: "LEGAL_ADDRESS"

  - `values.businessPartner.addresses.formattedAddress` (object)
    A formatted address is a structured address of VIES data source.

  - `values.businessPartner.addresses.formattedAddress.country` (string)
    Country name.
    Example: "Switzerland"

  - `values.businessPartner.addresses.formattedAddress.administrativeArea` (string)
    A top-level geographical or political area division in a country.
    Example: "Sankt Gallen"

  - `values.businessPartner.addresses.formattedAddress.region` (string)
    Top level subdivision of a country.
    Example: "Sankt Gallen"

  - `values.businessPartner.addresses.formattedAddress.regionCode` (string)
    A country specific code for a certain address in the region.
    Example: "9004"

  - `values.businessPartner.addresses.formattedAddress.locality` (string)
    A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses.
    Example: "Sankt Gallen"

  - `values.businessPartner.addresses.formattedAddress.district` (string)
    Type of administrative division that, in some countries, is managed by local government. Across the world, areas known as "districts" vary greatly in size, spanning regions or counties, several municipalities, subdivisions of municipalities, school district, or political district.
    Example: "City center"

  - `values.businessPartner.addresses.formattedAddress.postalCode` (string)
    A country specific code for a certain address.
    Example: "9000"

  - `values.businessPartner.addresses.formattedAddress.thoroughfare` (string)
    Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue.
    Example: "Lukassstrasse"

  - `values.businessPartner.addresses.formattedAddress.premise` (string)
    A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.
    Example: "Lukasstraße 4, Building 2, Floor 3, Room 4"

  - `values.businessPartner.addresses.formattedAddress.interurbanDeliveryPoint` (string)
    A single mailbox or other place at which postal mail is delivered.
    Example: "Sankt Gallen, Postfach 460"

  - `values.businessPartner.addresses.formattedAddress.mailbox` (string)
    A location at an address where the post is delivered to.
    Example: "Postfach 460"

  - `values.businessPartner.addresses.formattedAddress.postOfficeBox` (string)
    A uniquely addressable lockable box located on the premises of a post office station.
    Example: "Postfach 460"

  - `values.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."

  - `values.businessPartner.profile` (object)
    A Business Partner [profile](https://meta.cdq.com/Partner_profile) contains important information about a company, such as its classification, tags, contact details, or minority indicator.

  - `values.businessPartner.profile.minorityIndicator` (object)
    The minority indicator determines the minority group to which a vendor belongs. Usually, the minority indicator is only relevant in the United States and it is used for reporting purposes only. There is a corresponding SAP field in the vendor master for maintaining the minority indicator.

This feature is as of today dependent on data provided by a US based company: SupplierGateway.

Additional documentation can be found [here](https://meta.cdq.com/Business_partner/partner_profile/minority_indicator).

  - `values.businessPartner.profile.minorityIndicator.value` (string)
    The actual value of the minority indicator, representing the minority group.
    Example: "Social enterprise"

  - `values.businessPartner.profile.classifications` (array)
    List of classifications of the Business Partner.

  - `values.businessPartner.profile.classifications.value` (string)
    A textual description of the Classification.
    Example: "Manufacture of pesticides and other agrochemical products."

  - `values.businessPartner.profile.classifications.code` (string)
    Code that classifies the business partner.
    Example: "20.20Z"

  - `values.businessPartner.profile.classifications.type` (object)
    Type of classification such as NACE, SIC, NAF or other industry classification standards.

  - `values.businessPartner.profile.classifications.type.name` (string)
    Display label for the Classification Type.
    Example: "NAF 2003"

  - `values.businessPartner.profile.classifications.type.url` (string)
    URL to the documentation which summarizes all details of the [Classification Type](https://meta.cdq.com/Business_partner/partner_profile/classification/type)
    Example: "https://meta.cdq.com/Business_partner/partner_profile/classification/type"

  - `values.businessPartner.profile.phoneNumbers` (array)
    List of phone numbers of the Business Partner.

  - `values.businessPartner.profile.phoneNumbers.countryPrefix` (string)
    The country prefix of a phone number.
    Example: "+41"

  - `values.businessPartner.profile.phoneNumbers.number` (string)
    The complete phone number without any country prefixes.
    Example: "71 571 10 40"

  - `values.businessPartner.profile.phoneNumbers.type` (object)
    The [type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type) of phone number such as mobile phone or fixed line.

  - `values.businessPartner.profile.phoneNumbers.type.name` (string)
    Display label for a Phone Number Type Name.
    Example: "FAX"

  - `values.businessPartner.profile.phoneNumbers.type.url` (string)
    URL to the documentation which summarizes all details of the [Phone Number Type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
    Example: "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"

  - `values.businessPartner.profile.phoneNumbers.value` (string)
    The actual complete phone number incl. country prefix.
    Example: "+41 71 571 10 40"

  - `values.businessPartner.profile.websites` (array)
    List of websites of the Business Partner.

  - `values.businessPartner.profile.websites.url` (string)
    The actual company website URL.
    Example: "https://cdq.com"

  - `values.businessPartner.profile.websites.type` (object)
    Describes the type of website of a business partner, e.g. corporate website, official LinkedIn profile, etc.

  - `values.businessPartner.profile.websites.type.name` (string)
    Display label for a Website Type Name
    Example: "Corporate Website"

  - `values.businessPartner.profile.websites.type.url` (string)
    URL to the documentation which summarizes [Website Type Name](https://meta.cdq.com/Business_Partner/partner_profile/website/type).
    Example: "https://meta.cdq.com/Business_Partner/partner_profile/website/type"

  - `values.businessPartner.profile.websites.type.technicalKey` (string)
    Technical Keys of the Website Type Name.
    Example: "WEBSITE_TYPE_CORPORATE"

  - `values.businessPartner.profile.contactEmails` (array)
    List of contact emails of the Business Partner.

  - `values.businessPartner.profile.contactEmails.value` (string)
    Value of the email address of the Business Partner.
    Example: "developer-portal@cdq.com"

  - `values.businessPartner.profile.tags` (array)
    List of Tags.

  - `values.businessPartner.profile.tags.value` (string)
    Value of the tag.
    Example: "Warehouse"

  - `values.businessPartner.profile.tags.type` (object)
    A type that specifies the nature of the tag.

  - `values.businessPartner.profile.tags.type.technicalKey` (string)
    Technical Key of the Tag.
    Example: "WAREHOUSE"

  - `values.businessPartner.profile.vatPayerStatus` (object)
    Information about VAT status including publication date and registration authority.

  - `values.businessPartner.profile.vatPayerStatus.publicationDate` (string)
    Date of publication
    Example: "2025-09-12T14:57:59Z"

  - `values.businessPartner.profile.vatPayerStatus.status` (object)
    Information about payer status.

  - `values.businessPartner.profile.vatPayerStatus.status.name` (string)
    Name of Vat payer status. Available values RELIABLE and UNRELIABLE
    Example: "RELIABLE"

  - `values.businessPartner.profile.vatPayerStatus.status.technicalKey` (string)
    Technical key of Vat payer status
    Example: "VAT_PAYER_STATUS"

  - `values.businessPartner.profile.vatPayerStatus.registrationAuthority` (object)
    Additional information about registration authority.

  - `values.businessPartner.profile.vatPayerStatus.registrationAuthority.registrationAuthorityId` (string)
    The reference code of the registration authority, taken from the Registration Authorities Code List maintained by GLEIF.
    Example: "RA000009"

  - `values.businessPartner.profile.vatPayerStatus.registrationAuthority.registrationAuthorityEntityId` (string)
    The identifier of the Entity at the indicated registration authority.
    Example: "RA000009"

  - `values.businessPartner.profile.vatPayerStatus.registrationAuthority.otherRegistrationAuthorityId` (string)
    A legacy / historical reference code of a registration authority.
    Example: "RA000009"

  - `values.businessPartner.profile.hcpProfile` (object)
    Healthcare Professional Profile informs about the status, licenses, and location of a natural person who is a member 
of the medical, dental, pharmacy, or nursing professions or any other person who, in the course of his/her professional 
activities, may prescribe, purchase, supply, recommend or administer a Medicinal Product and whose primary practice, 
principal professional address or place of incorporation is in Europe.

  - `values.businessPartner.profile.hcpProfile.generalLicense` (object)
    The general license of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.generalLicense.professionType` (object)
    The profession type of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.generalLicense.professionType.name` (string)
    Name of the profession type.
    Example: "Doctor"

  - `values.businessPartner.profile.hcpProfile.generalLicense.professionType.url` (string)
    URL to the documentation of the Profession Type Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key"

  - `values.businessPartner.profile.hcpProfile.generalLicense.professionType.technicalKey` (string)
    Technical key of the profession type.
    Example: "DOCTOR"

  - `values.businessPartner.profile.hcpProfile.generalLicense.licenseStatus` (object)
    The license status of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.generalLicense.licenseStatus.name` (string)
    Name of the license status.
    Example: "Granted"

  - `values.businessPartner.profile.hcpProfile.generalLicense.licenseStatus.url` (string)
    URL to the documentation of the License Status Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key"

  - `values.businessPartner.profile.hcpProfile.generalLicense.licenseStatus.technicalKey` (string)
    Technical key of the license status.
    Example: "GRANTED"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions` (array)
    Operational permissions of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.issuingAuthority` (string)
    The issuing authority of the operational permission.
    Example: "Swiss Medical Association"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.permissionStatus` (object)
    The permission status of the operational permission.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.permissionStatus.name` (string)
    Name of the permission status.
    Example: "Granted"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.permissionStatus.url` (string)
    URL to the documentation of the Permission Status Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.permissionStatus.technicalKey` (string)
    Technical key of the permission status.
    Example: "GRANTED"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.activityStatus` (object)
    The activity status of the operational permission.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.activityStatus.name` (string)
    Name of the activity status.
Possible values: 
* Active - The operational permission is active.
* Inactive - The operational permission is inactive.
    Example: "Inactive"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.activityStatus.url` (string)
    URL to the documentation of the Activity Status Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.activityStatus.technicalKey` (string)
    Technical key of the activity status.
    Example: "INACTIVE"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations` (array)
    Practice locations of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.practiceName` (string)
    The practice location of the Healthcare Professional.
    Example: "VIVOMED AG"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus` (object)
    The self-dispensation status of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.name` (string)
    Name of the self-dispensation status.
    Example: "No"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.url` (string)
    URL to the documentation of the Self Dispensation Status Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/self_dispensation_status/url"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.technicalKey` (string)
    Technical key of the self-dispensation status.
    Example: "NO"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission` (object)
    The controlled substance purchase permission of the Healthcare Professional.

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.name` (string)
    Name of the controlled substance purchase permission.
    Example: "Yes"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.url` (string)
    URL to the documentation of the Controlled Substance Purchase Permission Technical Key.
    Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/controlled_substance_purchase_permission/url"

  - `values.businessPartner.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.technicalKey` (string)
    Technical key of the controlled substance purchase permission.
    Example: "YES"

  - `values.businessPartner.formattedSapRecord` (object)
    Provides business partner and address information in a data structure similar to SAP Business Partner table BUT000 and SAP Business Address Services table ADRC. Field names are equal or very similar to SAP field names in order to simplify field mapping. Data for name and street fields is already split into chunks of max. 35 characters.

  - `values.businessPartner.formattedSapRecord.name1` (string)
    A name1 filed of a business partner name.
    Example: "CDQ AG"

  - `values.businessPartner.formattedSapRecord.name2` (string)
    A name2 filed of a business partner name.
    Example: "CDQ AG"

  - `values.businessPartner.formattedSapRecord.name3` (string)
    A name3 filed of a business partner name.
    Example: "CDQ AG"

  - `values.businessPartner.formattedSapRecord.name4` (string)
    A name4 filed of a business partner name.
    Example: "CDQ AG"

  - `values.businessPartner.formattedSapRecord.nameCo` (string)
    The legal form name of a Legal Form.
    Example: "Aktiengesellschaft"

  - `values.businessPartner.formattedSapRecord.legalEntity` (string)
    The legal entity of a Legal Form.
    Example: "Aktiengesellschaft"

  - `values.businessPartner.formattedSapRecord.legalForm` (string)
    The legal form of a Legal Form.
    Example: "Aktiengesellschaft"

  - `values.businessPartner.formattedSapRecord.indSector` (string)
    A business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.
    Example: "NAF"

  - `values.businessPartner.formattedSapRecord.indSectorCode` (string)
    A code of business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.
    Example: "NAF"

  - `values.businessPartner.formattedSapRecord.emailAddress` (string)
    Email address of the Business Partner.
    Example: "bp@gmail.com"

  - `values.businessPartner.formattedSapRecord.narp` (string)
    An individual person, i.e. not an organization. An individual has no identifiers and has no legal form in its name.
    Example: "Friedrich Nietzsche"

  - `values.businessPartner.formattedSapRecord.stceg` (string)
    VAT registration number.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.stcd1` (string)
    Standard tax number field1.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.stcd2` (string)
    Standard tax number field2.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.stcd3` (string)
    Standard tax number field3.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.stcd4` (string)
    Standard tax number field4.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.stcd5` (string)
    Standard tax number field5.
    Example: "CHE-218.608.88"

  - `values.businessPartner.formattedSapRecord.url` (string)
    Webpages related to the business partner, e.g. the main corporate website as also provided by some company registers.
    Example: "www.cdq.com"

  - `values.businessPartner.formattedSapRecord.telNumber` (string)
    The main phone number of a business partner, usually some info-line of the headquarter.
    Example: "+41 71 571 10 40"

  - `values.businessPartner.formattedSapRecord.countryCode` (string)
    Country code (ISO 3166-1 alpha-2)
    Example: "CH"

  - `values.businessPartner.formattedSapRecord.region` (string)
    A top-level geographical or political area division in a country.
    Example: "Sankt Gallen"

  - `values.businessPartner.formattedSapRecord.regionCodeSap` (string)
    A Region specific code for a certain address.
    Example: "9004"

  - `values.businessPartner.formattedSapRecord.county` (string)
    A sub-level geographical or political area division in a country.
    Example: "Sankt Gallen"

  - `values.businessPartner.formattedSapRecord.countyCode` (string)
    A county specific code for a certain address in the region.
    Example: "9004"

  - `values.businessPartner.formattedSapRecord.township` (string)
    A sub-level geographical or political area division in a country.
    Example: "Sankt Gallen"

  - `values.businessPartner.formattedSapRecord.townshipCode` (string)
    A township specific code for a certain address in the region.
    Example: "9004"

  - `values.businessPartner.formattedSapRecord.city` (string)
    A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an [administrative area](https://meta.cdq.com/Address/administrative_area). A locality can also have several levels of sub localities.
    Example: "Sankt Gallen"

  - `values.businessPartner.formattedSapRecord.district` (string)
    Area of a country or city.
    Example: "St. Georgen"

  - `values.businessPartner.formattedSapRecord.postalCode3` (string)
    A country specific code for a certain address.
    Example: "9000"

  - `values.businessPartner.formattedSapRecord.street1` (string)
    Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.
    Example: "Lukasstraße 4"

  - `values.businessPartner.formattedSapRecord.street2` (string)
    Additional street filed.
    Example: "Lukasstraße 4"

  - `values.businessPartner.formattedSapRecord.street5` (string)
    Additional street filed.
    Example: "Lukasstraße 4"

  - `values.businessPartner.formattedSapRecord.houseNum` (string)
    Number of the Thoroughfare.
    Example: "4"

  - `values.businessPartner.formattedSapRecord.houseNum2` (string)
    Additional number filed.
    Example: "4"

  - `values.businessPartner.formattedSapRecord.building` (string)
    A structure (such as a house, hospital, school, etc.) with a roof and walls that is used as a place for people to live, work, do activities, store things, etc.
    Example: "Office 2"

  - `values.businessPartner.formattedSapRecord.floor` (string)
    The floor/story of the building.
    Example: "2"

  - `values.businessPartner.formattedSapRecord.roomnumber` (string)
    A distinct room in a building.
    Example: "123"

  - `values.businessPartner.formattedSapRecord.poBoxCountry` (string)
    A location at an address where the post is delivered to.
    Example: "9000"

  - `values.businessPartner.formattedSapRecord.poBoxCity` (string)
    A location at an address where the post is delivered to.
    Example: "9000"

  - `values.businessPartner.formattedSapRecord.poBoxPostalCode` (string)
    A location at an address where the post is delivered to.
    Example: "9000"

  - `values.businessPartner.formattedSapRecord.poBox` (string)
    Des
    Example: "9000"

  - `values.businessPartner.relations` (array)
    List of relations of the Business Partner.

  - `values.businessPartner.relations.startedAt` (string)
    Describe when this relationship was first established.
    Example: "2025-09-12T14:57:59Z"

  - `values.businessPartner.relations.endedAt` (string)
    Describe when this relationship ended.
    Example: "2025-09-12T14:57:59Z"

  - `values.businessPartner.relations.type` (object)
    Provides information about the type of the relationship between two Business Partners like:\ direct parent/child, ultimate parent, branch.

  - `values.businessPartner.relations.type.name` (string)
    Display name of the Business Partner Relation Type.
    Example: "Commercial ultimate"

  - `values.businessPartner.relations.type.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Type](https://meta.cdq.com/Business_partner/relation/type).
    Example: "https://meta.cdq.com/Business_partner/relation/type"

  - `values.businessPartner.relations.type.technicalKey` (string)
    Technical Key of the Business Partner Relation Type.
    Example: "COMMERCIAL_ULTIMATE"

  - `values.businessPartner.relations.class` (object)
    Provides information about the classification of the relation.

  - `values.businessPartner.relations.class.name` (string)
    Display name of the Business Partner Relation Class.
    Example: "CDQ Hierarchy"

  - `values.businessPartner.relations.class.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Class](https://meta.cdq.com/Business_partner/relation/class).
    Example: "https://meta.cdq.com/Business_partner/relation/class"

  - `values.businessPartner.relations.class.technicalKey` (string)
    Technical Key of the Business Partner Relation Class.
    Example: "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"

  - `values.businessPartner.relations.startNode` (string)
    It's a number of the business partner that plays a superior role over the other business partner. In means that, the company is parent of the second company (child) and has one of the relationship type like:\ Domestic Ultimate Legal entity or Direct Legal entity.
    Example: "FR.RC:5664645"

  - `values.businessPartner.relations.endNode` (string)
    It's a number of the business partner that plays a subordinate role over the other business partner. In means that, the company is chile of the second company (parent) and has one of the special relationship types.
    Example: "FR.RC:5664645"

  - `values.businessPartner.relations.startNodeBusinessPartner` (object)
    Relation of the Business Partner.

  - `values.businessPartner.relations.startNodeBusinessPartner.names` (array)
    List of names.

  - `values.businessPartner.relations.startNodeBusinessPartner.addresses` (array)
    List of addresses.

  - `values.businessPartner.relations.startNodeBusinessPartner.addresses.postCodes` (array)
    List of Post Codes.

  - `values.businessPartner.relations.startNodeBusinessPartner.addresses.localities` (array)
    List of Localities.

  - `values.businessPartner.relations.startNodeBusinessPartner.addresses.thoroughfares` (array)
    List of Thoroughfares.

  - `values.businessPartner.relations.endNodeBusinessPartner` (object)
    Relation of the Business Partner.

  - `values.businessPartner.types` (array)
    List of types of the Business Partner.

  - `values.businessPartner.types.name` (string)
    Display name of the Business Partner Type Name.
    Example: "Legal Entity"

  - `values.businessPartner.types.url` (string)
    URL to the documentation which summarizes all details of a [Buisness Partner Type](https://meta.cdq.com/Business_partner/type).
    Example: "https://meta.cdq.com/Business_partner/type"

  - `values.businessPartner.types.technicalKey` (string)
    Technical key of the Business Partner Type.
    Example: "LEGAL_ENTITY"

  - `values.businessPartner.externalContext` (object)
    Describe own identifiers of a record (others than just the external ID).

  - `values.businessPartner.externalContext.identifiers` (array)
    List of external context identifiers.

  - `values.businessPartner.externalContext.identifiers.value` (string)
    Value of own identifiers of a record.
    Example: "7250017031"

  - `values.businessPartner.externalContext.identifiers.type` (object)
    Type of own identifiers of a record.

  - `values.businessPartner.externalContext.identifiers.type.technicalKey` (string)
    Technical key for the External Context Identifier Type.
    Example: "KUNNR"

  - `values.businessPartner.jsonRecord` (object)
    Custom-representation of a data record

  - `values.businessPartner.bankAccounts` (array)
    List of bank accounts of the Business Partner.

  - `values.businessPartner.bankAccounts.internationalBankAccountIdentifier` (string)
    The IBAN of a bank account.
    Example: "CH8800781619278412000"

  - `values.businessPartner.bankAccounts.internationalBankIdentifier` (string)
    (BIC/SWIFT) Bank identifier which is globally unique.
    Example: "KBSGCH22XXX"

  - `values.businessPartner.bankAccounts.nationalBankAccountIdentifier` (string)
    Identifier of a bank account in a national context, i.e. for a country.
    Example: "619278412000"

  - `values.businessPartner.bankAccounts.nationalBankIdentifier` (string)
    Bank identifier which is unique in a national context, i.e. for a country.
    Example: "00781"

  - `values.businessPartner.bankAccounts.countryCode` (string)
    ISO code to identify the country a bank account is registered in.
    Example: "DE"

  - `values.businessPartner.bankAccounts.bankAccountIdentifier` (string)
    Identifier of a bank account in a national or international context.
    Example: "CH8800781619278412000"