openapi: 3.0.0
info:
  version: '2'
  title: Data Clinic API
  description: This API provides services for Data Clinic
servers:
  - description: Production
    url: https://api.cdq.com/data-clinic/rest
    x-cdq-soap-url: https://api.corporate-data-league.ch/data-clinic/soap/v2
security:
  - apiKey: []
tags:
  - name: Decision Log
    description: >
      Provides services for managing decisions for Business Partners. Decisions
      are stored in a Decision Log and can be

      retrieved, upserted, cleared or deleted.
  - name: Augmented Business Partners
    description: >
      Represent entities enhanced with supplementary data derived from many
      distinct data sources, providing a 

      comprehensive view of the Business Partner's information.
  - name: Augmented Configuration Properties
    description: >
      Used to define and manipulate the settings, which include various
      parameters and configurations for the 

      augmentation of Business Partners.
  - name: Configuration
    description: >
      Used to create, read, update, and delete the configurations, which define
      the settings for the augmentation process 

      of Business Partners.
paths:
  /v2/businesspartners/confirm:
    post:
      x-wsdl: false
      x-cdq-beta: true
      summary: Confirm Business Partner
      description: >
        <b style="color: white; background: #077fbb; border-radius: 5px;
        margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
        super;">BETA</b><br>Confirms the validity of a trading partner by
        checking the provided data against various CDQ services.
      tags:
        - Business Partners
      parameters:
        - name: dataTransformationDefinitionId
          in: query
          required: false
          description: The ID of the data transformation definition to apply.
          schema:
            type: string
            example: '123456'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmBusinessPartnerRequest'
            examples:
              ConfirmBusinessPartnerExample:
                summary: Confirm Business Partner
                value:
                  businessPartner:
                    externalId: '1'
                    names:
                      - type:
                          url: >-
                            https://meta.cdq.com/Business_partner/name/type/local
                          name: Local Name
                          technicalKey: LOCAL
                        value: Corporate Data Quality AG
                        shortName: CDQ AG
                        language:
                          name: German
                          technicalKey: DE
                    legalForm:
                      name: Aktiengesellschaft
                      url: https://meta.cdq.com/Business_partner/legal_form/name
                      technicalKey: DE_9866
                      language:
                        name: German
                        technicalKey: DE
                      mainAbbreviation: AG
                      cdlElfCode: AG
                      categories:
                        - name: Limited Liability Company
                          url: >-
                            https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001
                    identifiers:
                      - type:
                          url: >-
                            https://meta.cdq.com/Business_partner/identifier/type/name
                          name: CH_VAT_ID
                          technicalKey: CH_VAT_ID
                        value: CHE-218.608.886 HR/MWST
                        issuingBody:
                          name: Amtsgericht Aachen
                          technicalKey: Amtsgericht Aachen
                        status:
                          name: ACTIVE
                          technicalKey: ACTIVE
                    categories:
                      - name: Hotel
                        url: https://meta.cdq.com/Business_partner/category/hotel
                        technicalKey: HOTEL
                    status:
                      type:
                        name: In Liquidation
                        url: >-
                          https://meta.cdq.com/Business_partner/status/type/technical_key/in_liquidation
                        technicalKey: IN_LIQUIDATION
                      officialDenotation: Good Standing
                      validFrom: '2024-12-11T08:30:48Z'
                      validUntil: '2024-12-11T08:30:48Z'
                    profile:
                      classifications:
                        - value: >-
                            Manufacture of pesticides and other agrochemical
                            products.
                          code: 20.20Z
                          type:
                            name: NAF 2003
                            url: >-
                              https://meta.cdq.com/Business_partner/partner_profile/classification/type/naf_rev_1
                            technicalKey: NAF 2003
                      phoneNumbers:
                        - countryPrefix: '+41'
                          number: 71 571 10 40
                          type:
                            name: FAX
                            url: >-
                              https://meta.cdq.com/Business_partner/partner_profile/phone_number/type/fax
                            technicalKey: FAX
                          value: +41 71 571 10 40
                      websites:
                        - url: https://cdq.com
                          type:
                            name: Corporate Website
                            url: >-
                              https://meta.cdq.com/Business_Partner/partner_profile/website/type/name
                            technicalKey: WEBSITE_TYPE_CORPORATE
                      contactEmails:
                        - value: developer-portal@cdq.com
                    types:
                      - name: Legal Entity
                        url: >-
                          https://meta.cdq.com/Business_partner/type/legal_entity
                        technicalKey: LEGAL_ENTITY
                    relations:
                      - startedAt: '2024-12-11T08:30:48Z'
                        endedAt: '2024-12-11T08:30:48Z'
                        type:
                          name: Commercial ultimate
                          technicalKey: COMMERCIAL_ULTIMATE
                        class:
                          name: CDQ Hierarchy
                          technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                        startNode:
                          externalId: The ID managed in the customer's SAP systems.
                          dataSourceId: 648824a691d8d2503d65103e
                        endNode:
                          externalId: The ID managed in the customer's SAP systems.
                          dataSourceId: 648824a691d8d2503d65103e
                        deactivatedAt: '2024-12-11T08:30:48Z'
                    addresses:
                      - externalId: '1'
                        cdqId: CDQID-123456789
                        version:
                          language:
                            name: German
                            technicalKey: DE
                          characterSet:
                            name: International
                            technicalKey: INTERNATIONAL
                        identifyingName:
                          value: John Doe
                        careOf:
                          value: CDQ GmbH c/o Product Department
                        contexts:
                          - value: Production hall 7, Storage field 8.
                        country:
                          shortName: CH
                          value: Switzerland
                        administrativeAreas:
                          - value: Sankt Gallen
                            fipsCode: SZ15
                            shortName: SG
                            type:
                              name: COUNTY
                              url: >-
                                https://meta.cdq.com/Address/administrative_area/type/county
                              technicalKey: COUNTY
                            language:
                              name: German
                              technicalKey: DE
                        postCodes:
                          - value: '9000'
                            type:
                              name: Regular
                              url: >-
                                https://meta.cdq.com/Address/post_code/type/regular
                              technicalKey: REGULAR
                        localities:
                          - type:
                              name: City
                              url: https://meta.cdq.com/Address/locality/type/city
                              technicalKey: CITY
                            shortName: St. Gallen
                            value: Sankt Gallen
                            language:
                              name: German
                              technicalKey: DE
                        thoroughfares:
                          - type:
                              name: Industrial zone
                              url: >-
                                https://meta.cdq.com/Address/thoroughfare/type/industrial_zone
                              technicalKey: INDUSTRIAL_ZONE
                            shortName: Lukasstr. 4
                            number: '4'
                            value: Lukasstraße 4
                            name: Lukasstraße
                            direction: 221-bis Baker Street, North
                            language:
                              name: German
                              technicalKey: DE
                        premises:
                          - value: Lukasstraße 4
                            shortName: Lukasstr. 4
                            number: '4'
                            type:
                              name: Factory
                              url: >-
                                https://meta.cdq.com/Address/premise/type/factory
                              technicalKey: FACTORY
                            language:
                              name: German
                              technicalKey: DE
                        postalDeliveryPoints:
                          - type:
                              name: Mailbox
                              url: >-
                                https://meta.cdq.com/Address/postal_delivery_point/type/mailbox
                              technicalKey: MAILBOX
                            shortName: St Gallen, Postfach 460
                            number: '460'
                            value: Postfach
                            language:
                              name: German
                              technicalKey: DE
                        geographicCoordinates:
                          latitude: 47.439549
                          longitude: 9.395275
                        types:
                          - name: Legal Address
                            url: https://meta.cdq.com/Address/type/legal
                            technicalKey: LEGAL_ADDRESS
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmBusinessPartnerResult'
        '400':
          $ref: '#/components/responses/BadRequest'
  /v2/storages/{storageId}/datasources/{dataSourceId}/augmentedbusinesspartners/fetch:
    parameters:
      - name: storageId
        description: Unique identifier of the Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: dataSourceId
        description: Unique identifier of the Data Source.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    post:
      x-wsdl: false
      summary: Read Augmented Business Partner
      description: Read an Augmented Business Partner from a given Data Source.
      tags:
        - Augmented Business Partners
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchAugmentedBusinessPartnerRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentedBusinessPartner'
        '400':
          $ref: '#/components/responses/BadRequest'
  /v2/storages/{storageId}/augmentedbusinesspartners:
    parameters:
      - name: storageId
        description: Unique identifier of the Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      x-wsdl: false
      tags:
        - Augmented Business Partners
      summary: List Augmented Business Partners
      description: Read a page of Augmented Business Partners from a given storage.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryMax100Param'
        - name: dataSourceIds
          description: >-
            List of IDs of Data Sources of the Data Mirror for filtering only
            Business Partners that are managed in these sources.
          in: query
          required: false
          schema:
            type: array
            description: List of Data Source IDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: externalIds
          description: >-
            List of Business Partner External IDs for filtering by a specific
            selection of Business Partners managed in the Data Mirror.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner External IDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: typeTechnicalKeys
          in: query
          description: >-
            List of Business Partner Type Technical Keys for filtering by a
            specific selection of Business Partners managed in the Data Mirror.
          required: false
          schema:
            type: array
            description: List of Type Technical Keys.
            items:
              $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKeyParam'
        - name: from
          description: >
            Filter by records that were modified since the given date. Provide
            date in ISO format: `RRRR-MM-DDTHH:MM:SSZ`.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ModifiedFrom'
        - name: countryShortNames
          description: >
            List of iso-2 country codes (see possible values here: <a
            href='https://meta.cdq.com/Category:Country'>Country - CDQ</a>) 

            for filtering Business Partners by country.
          in: query
          required: false
          schema:
            type: array
            description: List of Country Short Names.
            items:
              $ref: '#/components/schemas/CountryShortNameParam'
        - name: triggerTypeTechnicalKeys
          description: >-
            Filter by the type of trigger for the generation of a new version of
            the Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of Trigger Type Technical Keys.
            items:
              $ref: '#/components/schemas/TriggerTypeTechnicalKeyParam'
        - name: triggerProvenanceTechnicalKeys
          in: query
          description: >
            Filter by the Data Sources that triggered the generation of a new
            version of the Augmented Business Partner.
          required: false
          schema:
            type: array
            description: List of Trigger Provenance Technical Keys.
            items:
              $ref: '#/components/schemas/ProvenanceTechnicalKeyParam'
        - name: processingStatusTechnicalKey
          in: query
          description: Filter by the Processing Status of the Augmented Business Partner.
          required: false
          schema:
            $ref: '#/components/schemas/ProcessingStatusTechnicalKeyEnum'
        - name: summaryClassifications
          in: query
          description: Filter by specified Summary Classification Technical Keys.
          required: false
          schema:
            type: array
            description: List of Classification Technical Keys.
            items:
              $ref: '#/components/schemas/UpdateClassificationTechnicalKeyEnum'
        - name: conceptClassifications
          in: query
          description: Filter by specified concept Concept Classification Technical Keys.
          required: false
          schema:
            type: array
            description: List of Classification Technical Keys.
            items:
              $ref: '#/components/schemas/UpdateClassificationTechnicalKeyEnum'
        - name: tags
          in: query
          description: Filter by specified Update Summary Tags.
          required: false
          schema:
            type: array
            description: List of Update Summary Tags.
            items:
              $ref: '#/components/schemas/UpdateTagEnum'
        - name: featuresOn
          in: query
          required: false
          description: >-
            Features to be activated during the read augmented Business
            Partners.
          schema:
            type: array
            description: List of Features.
            items:
              $ref: '#/components/schemas/ReadAugmentedBusinessPartnersFeatureParam'
        - name: featuresOff
          in: query
          required: false
          description: >-
            Features to be deactivated during the read augmented Business
            Partners.
          schema:
            type: array
            description: List of Features.
            items:
              $ref: '#/components/schemas/ReadAugmentedBusinessPartnersFeatureParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentedBusinessPartnerPage'
        '400':
          $ref: '#/components/responses/BadRequest'
  /storages/{storageId}/decisions:
    parameters:
      - name: storageId
        description: Unique identifier of the Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      x-wsdl: false
      tags:
        - Decision Log
      summary: List Storage's Decisions
      description: Read decisions from given storage.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: businessPartnerIds
          in: query
          required: false
          description: Only show decisions for listed business partner IDs.
          schema:
            type: array
            description: List of Business Partner IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/DecisionLogBusinessPartnerId'
        - name: type
          description: Only show decisions of given type.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/DecisionLogTypeTechnicalKeyParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecisionsPage'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
    post:
      x-wsdl: false
      tags:
        - Decision Log
      summary: Upsert Decisions
      description: >-
        Upsert decisions for given storage. Decisions are distinguished by
        business partner id and type. Already existing decision will be
        replaced.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecisionsUpsertRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecisionsUpsertResult'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
  /storages/{storageId}/decisions/clear:
    parameters:
      - name: storageId
        description: Unique identifier of the Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      x-wsdl: false
      tags:
        - Decision Log
      summary: Clear Decisions
      description: Deletes decisions of a given type. Delete all if type not provided.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecisionsClearRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecisionDeleteResults'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
  /storages/{storageId}/decisions/delete:
    parameters:
      - name: storageId
        description: Unique identifier of the Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      x-wsdl: false
      tags:
        - Decision Log
      summary: Delete Decisions
      description: Deletes decisions of a given ids.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecisionDeletes'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecisionDeleteResults'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
  /jobs/curationdecisionimportjobs:
    post:
      x-wsdl: false
      tags:
        - Decision Log
      summary: Import Curation Decision
      description: Starts curation decision import job
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurationDecisionImportJobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationDecisionImportJob'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
  /jobs/curationdecisionimportjobs/{jobId}:
    get:
      x-wsdl: false
      tags:
        - Decision Log
      summary: Poll Curation Decision Import Job
      description: Poll curation decision import job.
      parameters:
        - name: jobId
          description: Unique identifier of a job.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationDecisionImportJob'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
  /configurations/augmentation:
    get:
      tags:
        - Configuration
      summary: List Augmentation Configurations
      description: Read augmentation configurations of this workspace.
      parameters:
        - name: startAfter
          in: query
          description: Pagination parameter for determining next page.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - name: limit
          in: query
          description: Size of the page.
          required: false
          schema:
            $ref: '#/components/schemas/Limit'
        - in: query
          name: defaultConfiguration
          required: false
          description: Is default workspace configuration of given type.
          schema:
            type: boolean
            example: true
        - in: query
          name: clientId
          required: false
          description: >-
            API Key ID or Client ID. When present returns only configurations
            assigned to the given API key.
          schema:
            type: string
            description: >-
              API Key ID or Client ID. When present returns only configurations
              assigned to the given API key.
            example: 12345678-1234-5678-1234-567812345678
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationsPage'
    post:
      tags:
        - Configuration
      summary: Create Augmentation Configuration
      description: Endpoint to create a new augmentation configuration.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AugmentationConfigurationCreate'
            examples:
              clientConf:
                summary: Client Configuration (VIES and CH_UIDR)
                value:
                  configuration:
                    lookupConfiguration:
                      outputSettings:
                        maxCandidates: 50
                        limit: 20
                        matchingThreshold: 0.5
                    curationConfiguration:
                      curationSettings:
                        - outputSettings:
                            outputCharsets:
                              - concept: ADDRESS
                                charset: UTF8
                            outputLanguage:
                              technicalKey: ''
                          addressCurationSettings:
                            ignoreAddressConcepts: []
                            curationLevelThreshold: ''
                            numberSeparator: {}
                          featureSettings:
                            featuresOn: []
                            featuresOff: []
                            profile: FEATURES_OFF
                          countryScope:
                            shortName: WORLD
                    referenceDataSourceUsages:
                      - referenceDataSource:
                          technicalKey: VIES
                        updates:
                          enabled: true
                      - referenceDataSource:
                          technicalKey: CH_UIDR
                        updates:
                          enabled: true
                  name: Client configuration
              clientConfGoldenRecord:
                summary: Client Configuration with Golden Record (VIES and CH_UIDR)
                value:
                  configuration:
                    lookupConfiguration:
                      outputSettings:
                        maxCandidates: 50
                        limit: 20
                        matchingThreshold: 0.5
                    curationConfiguration:
                      curationSettings:
                        - outputSettings:
                            outputCharsets:
                              - concept: ADDRESS
                                charset: UTF8
                            outputLanguage:
                              technicalKey: ''
                          addressCurationSettings:
                            ignoreAddressConcepts: []
                            curationLevelThreshold: ''
                            numberSeparator: {}
                          featureSettings:
                            featuresOn: []
                            featuresOff: []
                            profile: GOLDEN_RECORD
                          countryScope:
                            shortName: WORLD
                    referenceDataSourceUsages:
                      - referenceDataSource:
                          technicalKey: VIES
                        updates:
                          enabled: true
                      - referenceDataSource:
                          technicalKey: CH_UIDR
                        updates:
                          enabled: true
                  name: Client configuration
      responses:
        '200':
          description: Augmentation configuration created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationResult'
        '400':
          description: Bad Request.
  /configurations/augmentation/{configurationId}:
    parameters:
      - $ref: '#/components/parameters/configurationId'
    get:
      tags:
        - Configuration
      summary: Read Augmentation Configuration
      description: Endpoint to retrieve an augmentation configuration based on its ID.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationResult'
    put:
      tags:
        - Configuration
      summary: Update Augmentation Configuration
      description: Endpoint to update an existing augmentation configuration.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AugmentationConfigurationUpdate'
      responses:
        '200':
          description: Augmentation configuration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationResult'
        '400':
          description: Bad Request.
    delete:
      tags:
        - Configuration
      summary: Delete Augmentation Configuration
      description: Endpoint to delete an existing augmentation configuration.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationResult'
        '400':
          description: Bad Request.
  /configurations/augmentation/{configurationId}/versions/{version}:
    get:
      tags:
        - Configuration
      summary: Read Augmentation Configuration Version
      description: >-
        Read a specific version of an augmentation configuration by id and
        version number.
      parameters:
        - $ref: '#/components/parameters/configurationId'
        - $ref: '#/components/parameters/configurationVersion'
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AugmentationConfigurationVersionResult'
  /configurations/augmentation/lookup/features:
    get:
      tags:
        - Augmented Configuration Properties
      summary: List Lookup Features
      description: Retrieve a list of available features for lookup settings.
      parameters:
        - name: page
          description: Page number.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Page'
        - name: pageSize
          description: Page size.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupFeaturesPage'
  /configurations/augmentation/fetch/features:
    get:
      tags:
        - Augmented Configuration Properties
      summary: List Fetch Features
      description: Retrieve a list of available features for fetch settings.
      parameters:
        - name: page
          description: Page number.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Page'
        - name: pageSize
          description: Page size.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchFeaturesPage'
  /configurations/augmentation/curation/features:
    get:
      tags:
        - Augmented Configuration Properties
      summary: List Curation Features
      description: Retrieve a list of available features for curation settings.
      parameters:
        - name: page
          description: Page number.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Page'
        - name: pageSize
          description: Page size.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationFeaturesPage'
  /configurations/augmentation/curation/profiles:
    get:
      tags:
        - Augmented Configuration Properties
      summary: List Curation Profiles
      description: Retrieve a list of available profiles for curation settings.
      parameters:
        - name: page
          description: Page number.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Page'
        - name: pageSize
          description: Page size.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationProfilesPage'
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      description: Detailed information about API errors.
      properties:
        status:
          $ref: '#/components/schemas/Status'
    Status:
      type: object
      description: Details about status or error of a service.
      properties:
        code:
          $ref: '#/components/schemas/HttpStatusCode'
        technicalKey:
          $ref: '#/components/schemas/HttpStatusTechnicalKey'
        details:
          type: array
          description: List of details about the status or error.
          items:
            $ref: '#/components/schemas/StatusDetails'
        path:
          $ref: '#/components/schemas/HttpPath'
        timestamp:
          $ref: '#/components/schemas/StatusTimestamp'
    StatusDetails:
      type: object
      description: Details about this status or error.
      required:
        - id
        - message
      properties:
        id:
          $ref: '#/components/schemas/StatusDetailsMessageId'
        message:
          $ref: '#/components/schemas/StatusDetailsMessage'
        technicalKey:
          $ref: '#/components/schemas/StatusDetailsTechnicalKey'
        jsonPath:
          $ref: '#/components/schemas/JsonPath'
        jsonRecord:
          $ref: '#/components/schemas/JsonObject'
    FetchAugmentedBusinessPartnerRequest:
      type: object
      description: >-
        Used to specify the parameters for a request to fetch an Augmented
        Business Partner from a given data source.
      required:
        - externalId
      properties:
        externalId:
          minLength: 1
          type: string
          description: >
            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.
        from:
          type: string
          description: Filter updates by date.
          example: '2025-10-14T07:32:29Z'
        featuresOn:
          type: array
          description: >-
            List of feature to be used during the fetch Augmented Business
            Partner.
          items:
            $ref: '#/components/schemas/FetchAugmentedBusinessPartnerFeatureParam'
    UpdateTagEnum:
      type: string
      description: >-
        Tags an update summary to allow searching or filtering. The tag has the
        format `<type>_<concept>_<action>`.
      example: IDENTIFIER_ADDED
      enum:
        - BANKRUPTCY_BUSINESS_PARTNER
        - BUSINESS_PARTNER_CATEGORY_ADDED
        - BUSINESS_PARTNER_CATEGORY_MODIFIED
        - BUSINESS_PARTNER_CLASSIFICATION_ADDED
        - BUSINESS_PARTNER_CLASSIFICATION_MODIFIED
        - BUSINESS_PARTNER_STATUS_ADDED
        - BUSINESS_PARTNER_STATUS_MODIFIED
        - BUSINESS_PARTNER_TYPE_ADDED
        - BUSINESS_PARTNER_TYPE_MODIFIED
        - DIRECT_LEGAL_RELATION_ADDED
        - DIRECT_LEGAL_RELATION_MODIFIED
        - DISSOLUTION_BUSINESS_PARTNER
        - DOMESTIC_BRANCH_RELATION_ADDED
        - DOMESTIC_BRANCH_RELATION_MODIFIED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_MODIFIED
        - IDENTIFIER_ADDED
        - IDENTIFIER_HARMONIZED
        - IDENTIFIER_MODIFIED
        - IDENTIFIER_STATUS_ADDED
        - IDENTIFIER_STATUS_MODIFIED
        - IDENTIFIER_VALUE_MODIFIED
        - IN_LIQUIDATION_BUSINESS_PARTNER
        - INACTIVE_BUSINESS_PARTNER
        - INSOLVENCY_BUSINESS_PARTNER
        - INTERNAL_RELATION_ADDED
        - INTERNAL_RELATION_MODIFIED
        - INTERNATIONAL_BRANCH_RELATION_ADDED
        - INTERNATIONAL_BRANCH_RELATION_MODIFIED
        - LEGAL_FORM_ADDED
        - LEGAL_FORM_MODIFIED
        - LEI_DIRECT_PARENT_ADDED
        - LEI_DIRECT_PARENT_MODIFIED
        - LEI_INTERNATIONAL_BRANCH_ADDED
        - LEI_INTERNATIONAL_BRANCH_MODIFIED
        - LEI_ULTIMATE_PARENT_ADDED
        - LEI_ULTIMATE_PARENT_MODIFIED
        - LOCAL_ADDRESS_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LOCAL_ADDRESS_COUNTRY_ADDED
        - LOCAL_ADDRESS_COUNTRY_MODIFIED
        - LOCAL_ADDRESS_GEO_COORDINATES_ADDED
        - LOCAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LOCAL_ADDRESS_LOCALITY_ADDED
        - LOCAL_ADDRESS_LOCALITY_MODIFIED
        - LOCAL_ADDRESS_MODIFIED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LOCAL_ADDRESS_POST_CODE_ADDED
        - LOCAL_ADDRESS_POST_CODE_MODIFIED
        - LOCAL_ADDRESS_PREMISE_ADDED
        - LOCAL_ADDRESS_PREMISE_MODIFIED
        - LOCAL_ADDRESS_THOROUGHFARE_ADDED
        - LOCAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LOCAL_NAME_ADDED
        - LOCAL_NAME_MODIFIED
        - OTHER_NAME_ADDED
        - OTHER_NAME_MODIFIED
        - POST_CODE_HARMONIZED
        - LEGAL_ADDRESS_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LEGAL_ADDRESS_COUNTRY_ADDED
        - LEGAL_ADDRESS_COUNTRY_MODIFIED
        - LEGAL_ADDRESS_GEO_COORDINATES_ADDED
        - LEGAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LEGAL_ADDRESS_LOCALITY_ADDED
        - LEGAL_ADDRESS_LOCALITY_MODIFIED
        - LEGAL_ADDRESS_MODIFIED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LEGAL_ADDRESS_POST_CODE_ADDED
        - LEGAL_ADDRESS_POST_CODE_MODIFIED
        - LEGAL_ADDRESS_PREMISE_ADDED
        - LEGAL_ADDRESS_PREMISE_MODIFIED
        - LEGAL_ADDRESS_THOROUGHFARE_ADDED
        - LEGAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LEGAL_NAME_ADDED
        - LEGAL_NAME_MODIFIED
        - RESTRUCTURING_BUSINESS_PARTNER
        - RELATION_ADDED
        - RELATION_MODIFIED
        - VALUE_MODIFIED
        - VAT_PAYER_STATUS_ADDED
        - VAT_PAYER_STATUS_MODIFIED
        - VAT_REGISTERED_ADDRESS_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - VAT_REGISTERED_ADDRESS_COUNTRY_ADDED
        - VAT_REGISTERED_ADDRESS_COUNTRY_MODIFIED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_ADDED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_MODIFIED
        - VAT_REGISTERED_ADDRESS_LOCALITY_ADDED
        - VAT_REGISTERED_ADDRESS_LOCALITY_MODIFIED
        - VAT_REGISTERED_ADDRESS_MODIFIED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - VAT_REGISTERED_ADDRESS_POST_CODE_ADDED
        - VAT_REGISTERED_ADDRESS_POST_CODE_MODIFIED
        - VAT_REGISTERED_ADDRESS_PREMISE_ADDED
        - VAT_REGISTERED_ADDRESS_PREMISE_MODIFIED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_ADDED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_MODIFIED
        - VAT_REGISTERED_NAME_ADDED
        - VAT_REGISTERED_NAME_MODIFIED
    AugmentedBusinessPartnerPage:
      type: object
      description: Gather all Augmented Business Partners that matches the request.
      properties:
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        values:
          type: array
          description: List of Augmented Business Partners.
          items:
            $ref: '#/components/schemas/AugmentedBusinessPartner'
        request:
          $ref: '#/components/schemas/AugmentedBusinessPartnersRequest'
    ModifiedFrom:
      type: string
      example: '2025-10-14T07:32:29Z'
      description: >
        Filter records that were modified since the given date. Provide date in
        ISO format: `RRRR-MM-DDTHH:MM:SSZ`.
    AugmentedBusinessPartnersRequest:
      type: object
      description: Parameters for a request to read Augmented Business Partners.
      properties:
        dataSourceIds:
          type: array
          description: >-
            List of IDs of Data Sources of the Data Mirror for filtering only
            Business Partners that are managed in these sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        effectiveDataSourceIds:
          type: array
          description: List of effective Data Source IDs.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        externalIds:
          type: array
          description: List of External IDs.
          items:
            $ref: '#/components/schemas/BusinessPartnerExternalId'
        typeTechnicalKeys:
          type: array
          description: List of Business Partner Type Technical Keys.
          items:
            $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKey'
        from:
          $ref: '#/components/schemas/ModifiedFrom'
        countryShortNames:
          type: array
          description: List of Country Short Names.
          items:
            $ref: '#/components/schemas/CountryShortName'
        triggerTypeTechnicalKeys:
          type: array
          description: List of Trigger Type Technical Keys.
          items:
            $ref: '#/components/schemas/TriggerTypeTechnicalKey'
        triggerProvenanceTechnicalKeys:
          type: array
          description: List of Trigger Provenance Technical Keys.
          items:
            $ref: '#/components/schemas/ProvenanceTechnicalKey'
        summaryClassifications:
          type: array
          description: List of Classification Technical Keys.
          items:
            $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
        conceptClassifications:
          type: array
          description: List of Classification Technical Keys.
          items:
            $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
        tags:
          type: array
          description: List of Update Summary Tags.
          items:
            $ref: '#/components/schemas/UpdateTag'
        featuresOn:
          type: array
          description: List of Features that were enabled.
          items:
            $ref: '#/components/schemas/ReadAugmentedBusinessPartnersFeature'
        featuresOff:
          type: array
          description: List of Features that were disabled.
          items:
            $ref: '#/components/schemas/ReadAugmentedBusinessPartnersFeature'
        effectiveFeatures:
          type: array
          description: List of Features that were used during request.
          items:
            $ref: '#/components/schemas/ReadAugmentedBusinessPartnersFeature'
    AugmentedBusinessPartner:
      type: object
      description: A Business Partner from a Data Mirror with updates as proposed by CDQ.
      properties:
        updatedBusinessPartner:
          $ref: '#/components/schemas/UpdatedBusinessPartner'
        updates:
          type: array
          description: Raw updates from Reference Data Sources.
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartner'
        metadata:
          $ref: '#/components/schemas/AugmentedBusinessPartnerMetadata'
        originalBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    AugmentedBusinessPartnerMetadata:
      type: object
      description: Metadata for an Augmented Business Partner.
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        executedAt:
          $ref: '#/components/schemas/ExecutedAt'
        country:
          $ref: '#/components/schemas/AugmentedBusinessPartnerMetadataCountry'
        trigger:
          $ref: '#/components/schemas/AugmentedBusinessPartnerMetadataTrigger'
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatus'
    ProcessingStatus:
      type: object
      description: Processing status.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProcessingStatusTechnicalKey'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    UpdatedBusinessPartner:
      type: object
      description: >-
        A Business Partner which contains also contextual information about
        applied updates.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        summary:
          $ref: '#/components/schemas/UpdateSummary'
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/UpdatedName'
        legalForm:
          $ref: '#/components/schemas/UpdatedLegalForm'
        identifiers:
          type: array
          description: List of identifiers.
          items:
            $ref: '#/components/schemas/UpdatedIdentifier'
        categories:
          type: array
          description: List of categories.
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/UpdatedBusinessPartnerStatus'
        addresses:
          type: array
          description: List of addresses.
          items:
            $ref: '#/components/schemas/UpdatedAddress'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        relations:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerRelation'
        types:
          type: array
          description: List of types.
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerType'
        jsonRecord:
          $ref: '#/components/schemas/JsonRecord'
    UpdateSummary:
      type: object
      description: Summarizes the applied updates for easy consumption.
      properties:
        tags:
          type: array
          description: List of tags.
          items:
            $ref: '#/components/schemas/UpdateTag'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
    UpdateAssessment:
      type: object
      description: Details and assessment of an applied update.
      properties:
        action:
          $ref: '#/components/schemas/UpdateAction'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
        provenances:
          type: array
          description: List of provenances.
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Provenance'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        tags:
          type: array
          description: List of tags.
          items:
            $ref: '#/components/schemas/UpdateTag'
    UpdateAction:
      type: object
      description: Type of update action which has been applied.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateActionTechnicalKey'
    UpdateClassification:
      type: object
      description: >
        Gives a user an indicator how "much" the attribute was changed OR how
        important the change was.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
        reason:
          $ref: '#/components/schemas/UpdateClassificationReason'
    Provenance:
      type: object
      description: >-
        The source of the change or update. Could be the reference data source
        as VIES or Organization.
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        url:
          $ref: '#/components/schemas/ProvenanceUrl'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    UpdatedName:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/Name'
        - type: object
          description: Update assessment for a name.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/NameUpdateAssessment'
    NameUpdateAssessment:
      type: object
      description: Update assessment for a name.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Name before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Name'
            requestSimilarity:
              $ref: '#/components/schemas/Similarity'
    Similarity:
      type: object
      description: Contains similarity values for Business Partner after Curation.
      properties:
        value:
          $ref: '#/components/schemas/SimilarityValue'
    SimilarityValue:
      type: number
      format: double
      description: >
        The similarity value is a number between 0.0 and 1.0. The higher the
        value, the more similar the request is to the curated Business Partner.
      example: '0.8'
    UpdatedLegalForm:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/LegalForm'
        - type: object
          description: Update assessment for a legal form.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/LegalFormUpdateAssessment'
    LegalFormUpdateAssessment:
      type: object
      description: Update assessment for a legal form.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Legal form before applied update.
          properties:
            before:
              $ref: '#/components/schemas/LegalForm'
    UpdatedIdentifier:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/Identifier'
        - type: object
          description: Update assessment for a identifier.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/IdentifierUpdateAssessment'
    IdentifierUpdateAssessment:
      type: object
      description: Update assessment for an identifier.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Identifier before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Identifier'
    UpdatedBusinessPartnerRelation:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerRelation'
        - type: object
          description: Update assessment for a Business Partner relation.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerRelationUpdateAssessment'
    BusinessPartnerRelationUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner relation.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Name before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerRelation'
    BusinessPartnerRelation:
      type: object
      description: >-
        Business Partner hierarchy, or any other kind of relation between two
        Business Partner entities. The data about relationships between
        companies come from official, external data sources.
      properties:
        startedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationStartedAt'
        endedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationEndedAt'
        type:
          $ref: '#/components/schemas/BusinessPartnerRelationType'
        class:
          $ref: '#/components/schemas/BusinessPartnerRelationClass'
        startNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        endNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        deactivatedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationDeactivatedAt'
    BusinessPartnerRelationType:
      type: object
      description: >-
        Provides information about the type of the relationship between two
        Business Partners like:\ direct parent/child, ultimate parent, branch.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeTechnicalKey'
    BusinessPartnerRelationClass:
      type: object
      description: Provides information about the classification of the relation.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationClassName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
    BusinessPartnerRelationNode:
      type: object
      description: Unique identifiers for Business Partner in the relation
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    BusinessPartnerRelationDeactivatedAt:
      type: string
      description: Describe when this relationship was deactivated. Read only.
      example: '2025-10-14T07:32:29Z'
    UpdatedBusinessPartnerType:
      type: object
      description: >-
        A business partner type which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerType'
        - type: object
          description: Update assessment for a Business Partner type.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerTypeUpdateAssessment'
    BusinessPartnerTypeUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner type.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner type before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerType'
    UpdatedBusinessPartnerStatus:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerStatus'
        - type: object
          description: Update assessment for a Business Partner status.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerStatusUpdateAssessment'
    BusinessPartnerStatusUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner status.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner status before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerStatus'
    UpdatedBusinessPartnerCategory:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerCategory'
        - type: object
          description: Update assessment for a Business Partner category.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerCategoryUpdateAssessment'
    BusinessPartnerCategoryUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner category.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner category before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerCategory'
    PartnerProfile:
      type: object
      description: >-
        A Business Partner profile contains important information about a
        company, such as its classification, tags, contact details, or minority
        indicator.
      properties:
        classifications:
          type: array
          description: List of classifications.
          items:
            $ref: '#/components/schemas/Classification'
        phoneNumbers:
          type: array
          description: List of phone numbers.
          items:
            $ref: '#/components/schemas/PhoneNumber'
        websites:
          type: array
          description: List of websites.
          items:
            $ref: '#/components/schemas/Website'
        contactEmails:
          type: array
          description: List of contact emails.
          items:
            $ref: '#/components/schemas/ContactEmail'
    Classification:
      type: object
      description: >
        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.
      properties:
        value:
          $ref: '#/components/schemas/ClassificationValue'
        code:
          $ref: '#/components/schemas/ClassificationCode'
        type:
          $ref: '#/components/schemas/ClassificationType'
    ClassificationType:
      type: object
      description: >-
        Type of classification such as NACE, SIC, NAF or other industry
        classification standards.
      properties:
        name:
          $ref: '#/components/schemas/ClassificationTypeName'
        url:
          $ref: '#/components/schemas/ClassificationTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ClassificationTypeTechnicalKey'
    PhoneNumber:
      type: object
      description: >-
        The main phone number of a Business Partner, usually some info-line of
        the headquarters.
      properties:
        countryPrefix:
          $ref: '#/components/schemas/PhoneNumberCountryPrefix'
        number:
          $ref: '#/components/schemas/PhoneNumberNumber'
        type:
          $ref: '#/components/schemas/PhoneNumberType'
        value:
          $ref: '#/components/schemas/PhoneNumberValue'
    PhoneNumberType:
      type: object
      description: >-
        The type of phone number such as mobile phone or fixed line
        [here](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      properties:
        name:
          $ref: '#/components/schemas/PhoneNumberTypeName'
        url:
          $ref: '#/components/schemas/PhoneNumberTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PhoneNumberTypeTechnicalKey'
    UpdatedAddress:
      type: object
      description: >
        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).
      properties:
        updateAssessment:
          $ref: '#/components/schemas/AddressUpdateAssessment'
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          description: List of contexts.
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/UpdatedCountry'
        administrativeAreas:
          type: array
          description: List of administrative areas.
          items:
            $ref: '#/components/schemas/UpdatedAdministrativeArea'
        postCodes:
          type: array
          description: List of post codes.
          items:
            $ref: '#/components/schemas/UpdatedPostCode'
        localities:
          type: array
          description: List of localities.
          items:
            $ref: '#/components/schemas/UpdatedLocality'
        thoroughfares:
          type: array
          description: List of thoroughfares.
          items:
            $ref: '#/components/schemas/UpdatedThoroughfare'
        premises:
          type: array
          description: List of premises.
          items:
            $ref: '#/components/schemas/UpdatedPremise'
        postalDeliveryPoints:
          type: array
          description: List of postal delivery points.
          items:
            $ref: '#/components/schemas/UpdatedPostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/UpdatedGeographicCoordinates'
        types:
          type: array
          description: List of types.
          items:
            $ref: '#/components/schemas/AddressType'
    AddressUpdateAssessment:
      type: object
      description: Update assessment for an address.
      properties:
        provenances:
          type: array
          items:
            $ref: '#/components/schemas/Provenance'
        curationAssessment:
          $ref: '#/components/schemas/AddressCurationAssessment'
        requestSimilarity:
          $ref: '#/components/schemas/Similarity'
    Decision:
      type: object
      description: Represents the action taken based on the address curation level.
      properties:
        action:
          type: string
          description: >
            * `ACCEPT` - set when address curation level threshold is not
            violated or there is no threshold set * `REJECT` - set when address
            curation level threshold is violated
          example: ACCEPT
    AddressCurationAssessment:
      type: object
      description: >-
        Contains indicators concerning address curation. All indicators are
        calculated against address specified in inputAddressType.
      properties:
        curationLevel:
          $ref: '#/components/schemas/CurationLevel'
        accuracyIndicator:
          type: integer
          format: int32
          description: Measure used to assess the degree of accuracy in a given context.
          example: '0.9'
        outputLanguage:
          $ref: '#/components/schemas/Language'
        curationDecision:
          $ref: '#/components/schemas/Decision'
        geographicCoordinatesAccuracy:
          $ref: '#/components/schemas/GeographicCoordinatesAccuracy'
        inputAddressType:
          $ref: '#/components/schemas/CurationAssessmentInputAddressType'
    CurationAssessmentInputAddressType:
      description: Address which was used as an input for address curation.
      type: string
      example: INPUT_LOCAL_ADDRESS
    CurationLevel:
      type: string
      description: >
        Indicator for curation quality. Defines how good curation was.


        UNKNOWN: No possibility to determine curation level.

        LEVEL_1: The address was not found by the CDQ in the employed external
        data sources.

        LEVEL_2: The address was found, but there were significant changes in
        critical fields.

        LEVEL_3: The address was found and there are minor changes in highly
        important fields.

        LEVEL_4: The address was found by the CDQ. There were only  changes in
        less critical fields such as the address/premise or
        address/thoroughfare/number.

        LEVEL_5: The address was found by the CDQ, but no major changes have
        been made as the address was correct.

        LEVEL_6: The address was found in the shared CDQ data pool. This means
        another company uses the same address which is a very reliable indicator
        that the address is correct (only  in a alpha version)


        Additional documentation can be found
        [here](https://meta.cdq.com/Quality_indicator/address_cleansing_curation_level#Curation_level).
      example: LEVEL_1
    Language:
      type: object
      description: Name of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    GeographicCoordinatesAccuracy:
      type: string
      description: |
        Level of accuracy for geo-coordinates. 
        * `THOROUGHFARE_NUMBER`
        * `THOROUGHFARE_VALUE`
        * `LOCALITY`
        * `ADMINISTRATIVE_AREA`
        * `COUNTRY`
      example: LOCALITY
    UpdatedAdministrativeArea:
      type: object
      description: >-
        An administrative area which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/AdministrativeArea'
        - type: object
          description: Update assessment for an administrative area.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/AdministrativeAreaUpdateAssessment'
    AdministrativeAreaUpdateAssessment:
      type: object
      description: Update assessment for an administrative area.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Administrative area before applied update.
          properties:
            before:
              $ref: '#/components/schemas/AdministrativeArea'
    UpdatedCountry:
      type: object
      description: >-
        A country which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Country'
        - type: object
          description: Update assessment for a country.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/CountryUpdateAssessment'
    CountryUpdateAssessment:
      type: object
      description: Update assessment for a country.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Country before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Country'
    UpdatedLocality:
      type: object
      description: >-
        A locality which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Locality'
        - type: object
          description: Update assessment for a locality.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/LocalityUpdateAssessment'
    LocalityUpdateAssessment:
      type: object
      description: Update assessment for a locality.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Locality before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Locality'
    UpdatedThoroughfare:
      type: object
      description: >-
        A thoroughfare area which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/Thoroughfare'
        - type: object
          description: Update assessment for a thoroughfare.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/ThoroughfareUpdateAssessment'
    ThoroughfareUpdateAssessment:
      type: object
      description: Update assessment for a thoroughfare.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Thoroughfare before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Thoroughfare'
    UpdatedPostCode:
      type: object
      description: >-
        A postcode which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/PostCode'
        - type: object
          description: Update assessment for a post code.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PostCodeUpdateAssessment'
    PostCodeUpdateAssessment:
      type: object
      description: Update assessment for a post code.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Post code before applied update.
          properties:
            before:
              $ref: '#/components/schemas/PostCode'
    UpdatedPremise:
      type: object
      description: >-
        A premise which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Premise'
        - type: object
          description: Update assessment for a premise.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PremiseUpdateAssessment'
    PremiseUpdateAssessment:
      type: object
      description: Update assessment for a premise.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Premise before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Premise'
    UpdatedPostalDeliveryPoint:
      type: object
      description: >-
        A postal delivery point which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/PostalDeliveryPoint'
        - type: object
          description: Update assessment for a postal delivery point.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PostalDeliveryPointUpdateAssessment'
    PostalDeliveryPointUpdateAssessment:
      type: object
      description: Update assessment for a postal delivery point.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Postal delivery point before applied update.
          properties:
            before:
              $ref: '#/components/schemas/PostalDeliveryPoint'
    UpdatedGeographicCoordinates:
      type: object
      description: >-
        Geographic coordinates which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/GeographicCoordinates'
        - type: object
          description: Update assessment for geographic coordinates.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/GeographicCoordinatesUpdateAssessment'
    GeographicCoordinatesUpdateAssessment:
      type: object
      description: Update assessment for geographic coordinates.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Geographic coordinates before applied update.
          properties:
            before:
              $ref: '#/components/schemas/GeographicCoordinates'
    BusinessPartner:
      type: object
      description: >
        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.
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        jsonRecord:
          $ref: '#/components/schemas/JsonObject'
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/Name'
        legalForm:
          $ref: '#/components/schemas/LegalForm'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/Identifier'
        categories:
          type: array
          description: List of categories of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        types:
          type: array
          description: List of types of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
        relations:
          type: array
          description: List of relations.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/Address'
    Address:
      type: object
      description: >
        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).
      properties:
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        cdqId:
          $ref: '#/components/schemas/AddressCdqId'
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          description: List of contexts of the address.
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of administrative areas of the address.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
        postCodes:
          type: array
          description: List of post codes of the address.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of localities of the address.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of thoroughfares of the address.
          items:
            $ref: '#/components/schemas/Thoroughfare'
        premises:
          type: array
          description: List of premises of the address.
          items:
            $ref: '#/components/schemas/Premise'
        postalDeliveryPoints:
          type: array
          description: List of postal delivery points of the address.
          items:
            $ref: '#/components/schemas/PostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        types:
          type: array
          description: List of types of the address.
          items:
            $ref: '#/components/schemas/AddressType'
    AddressCdqId:
      type: string
      description: CDQ ID of an address.
      example: CDQID-123456789
    ConfirmBusinessPartnerRequest:
      type: object
      description: >
        Request schema for trading partner data confirmation. It includes all
        necessary identifiers and attributes of the trading partner needed for
        verification processes.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/ConfirmFeatureParam'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/ConfirmFeatureParam'
    ConfirmFeatureParam:
      type: string
      description: Feature to be used during confirmation.
      example: ENABLE_QUALIFICATION_CONFIRMATION
      enum:
        - ENABLE_SANCTION_CONFIRMATION
        - ENABLE_QUALIFICATION_CONFIRMATION
      x-enumDescriptions:
        ENABLE_SANCTION_CONFIRMATION: Sanction confirmation is used to confirm business partner.
        ENABLE_QUALIFICATION_CONFIRMATION: Qualification functionality is used to confirm business partner.
    ConfirmBusinessPartnerResult:
      type: object
      description: >
        Provides the results of the confirmation checks on a trading partner's
        data. Each section of the response details the outcomes of different
        data validations such as data quality, company legitimacy, VAT number
        verification, and sanction compliance.
      properties:
        status:
          $ref: '#/components/schemas/Status'
        dataQualityConfirmation:
          $ref: '#/components/schemas/DataQualityConfirmation'
        companyConfirmation:
          $ref: '#/components/schemas/CompanyConfirmation'
        qualificationConfirmation:
          $ref: '#/components/schemas/QualificationConfirmation'
        sanctionComplianceConfirmation:
          $ref: '#/components/schemas/ScreeningComplianceConfirmation'
    DataQualityConfirmation:
      type: object
      description: >
        Describes the outcome of data quality checks, including an overall
        decision and detailed reports of any issues found.
      properties:
        decision:
          $ref: '#/components/schemas/ConfirmationDecision'
        summary:
          $ref: '#/components/schemas/DataQualityConfirmationSummary'
        details:
          $ref: '#/components/schemas/DataQualityConfirmationDetails'
    CompanyConfirmation:
      type: object
      description: >
        Contains results of the company confirmation process, verifying the
        existence and registration details of the company against trusted
        databases.
      properties:
        decision:
          $ref: '#/components/schemas/ConfirmationDecision'
        summary:
          $ref: '#/components/schemas/CompanyConfirmationSummary'
        details:
          $ref: '#/components/schemas/CompanyConfirmationDetails'
    QualificationConfirmation:
      type: object
      description: >
        Outputs the results of identifier validation checks against official tax
        databases to ensure its validity.
      properties:
        decision:
          $ref: '#/components/schemas/ConfirmationDecision'
        summary:
          $ref: '#/components/schemas/QualificationConfirmationSummary'
        details:
          $ref: '#/components/schemas/QualificationConfirmationDetails'
    ScreeningComplianceConfirmation:
      type: object
      description: >
        Provides outcomes of checks against compliance lists like sanctions or
        watch lists to verify if the trading partner is compliant with
        regulatory standards.
      properties:
        decision:
          $ref: '#/components/schemas/ConfirmationDecision'
        summary:
          $ref: '#/components/schemas/ScreeningComplianceSummary'
        details:
          $ref: '#/components/schemas/ScreeningComplianceDetails'
    DataQualityConfirmationSummary:
      type: object
      description: >
        Summarizes the results of data quality checks including counts of
        errors, warnings, and informational messages.
      properties:
        numErrors:
          $ref: '#/components/schemas/DataQualityConfirmationSummaryNumberOfErrors'
        numWarnings:
          $ref: '#/components/schemas/DataQualityConfirmationSummaryNumberOfWarnings'
        numInfos:
          $ref: '#/components/schemas/DataQualityConfirmationSummaryNumberOfInfos'
    DataQualityConfirmationSummaryNumberOfErrors:
      type: integer
      description: Number of errors found during data quality checks.
      example: '0'
    DataQualityConfirmationSummaryNumberOfWarnings:
      type: integer
      description: Number of warnings found during data quality checks.
      example: '0'
    DataQualityConfirmationSummaryNumberOfInfos:
      type: integer
      description: Number of informational messages found during data quality checks.
      example: '0'
    DataQualityConfirmationDetails:
      type: object
      description: >
        Provides detailed reports of data quality issues categorized into
        errors, warnings, and informational messages.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/DataDefect'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/DataDefect'
        infos:
          type: array
          items:
            $ref: '#/components/schemas/DataDefect'
    CompanyConfirmationSummary:
      type: object
      description: >
        Summarizes the company confirmation results, including the data source
        used for verification and the classification and score of the match.
      properties:
        dataSource:
          $ref: '#/components/schemas/DataSource'
        overallMatchingClassification:
          $ref: '#/components/schemas/MatchingClassification'
        overallMatchingScore:
          $ref: '#/components/schemas/MatchingScoreValue'
    DataSource:
      type: object
      description: Data Source of the Data Pool.
      properties:
        name:
          $ref: '#/components/schemas/DataSourceName'
        aleiPrefix:
          $ref: '#/components/schemas/DataSourceAleiPrefix'
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    DataSourceAleiPrefix:
      type: string
      description: |
        The ALEI prefix element is the ISO 3166-2 code for country
        and subdivision if applicable followed by the stop character ‘.’
        This is followed by an acronym representing the register
        maintained by the administrative agency for the governing
        body of a nation, state, or community that assigned 
        the identifier element. The prefix is assigned by ECCMA
      example: VIES
    CompanyConfirmationDetails:
      type: object
      description: >
        Provides detailed results of the company verification process, including
        the matched company profile and related data.
      properties:
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        matchedCompanyData:
          $ref: '#/components/schemas/BusinessPartner'
    QualificationConfirmationSummary:
      type: object
      description: >
        Summarizes the results of the VAT number confirmation including the data
        source used and details on various decision aspects.
      properties:
        dataSource:
          $ref: '#/components/schemas/DataSource'
        decisionIdentifier:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
        decisionName:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
        decisionCity:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
        decisionStreet:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
        decisionPostalCode:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
    QualificationConfirmationDetails:
      type: object
      description: >
        Detailed results of the Qualification verification process including
        individual decision reports for each check performed.
      properties:
        identifierResults:
          $ref: '#/components/schemas/IdentifierResults'
    IdentifierResults:
      type: object
      description: >
        Contains the results of a qualification check on a specific identifier,
        including the rule applied and the decision made.
      properties:
        qualificationDecisions:
          type: array
          items:
            $ref: '#/components/schemas/QualificationDecision'
    ScreeningComplianceSummary:
      type: object
      description: >
        Summarizes the sanction screening results including the compliance list
        name and the matching score.
      properties:
        matchingScore:
          $ref: '#/components/schemas/MatchingScore'
        complianceList:
          $ref: '#/components/schemas/ComplianceList'
    ScreeningComplianceDetails:
      type: object
      description: >
        Details the specific matches found during the sanction screening
        process, including the list and score of each match.
      properties:
        complianceListMatches:
          type: array
          items:
            $ref: '#/components/schemas/ScreeningMatch'
    ConfirmationDecision:
      type: object
      description: |
        Provides decision of checks against compliance lists.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ConfirmationDecisionTechnicalKey'
    ConfirmationDecisionTechnicalKey:
      type: string
      example: OK
      description: >
        Represents the possible outcomes of a data validation process, including
        successful validation, failure, or non-applicability.
    DataDefect:
      type: object
      description: >
        Represents specific issues found during data quality checks, categorized
        by the rule they violated.
      properties:
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
        violationLevel:
          $ref: '#/components/schemas/ViolationLevel'
        violationMessage:
          $ref: '#/components/schemas/DataDefectViolationMessage'
    DataDefectViolationMessage:
      type: string
      description: Descriptive message detailing the nature of the data defect.
      example: Business Partner identifier is mandatory.
    BusinessRule:
      type: object
      description: >
        Details the specific business rule that has been violated, including its
        name and a link to its definition.
      properties:
        name:
          $ref: '#/components/schemas/BusinessRuleName'
        url:
          $ref: '#/components/schemas/BusinessRuleUrl'
        ruleStatus:
          $ref: '#/components/schemas/ValidationRuleStatus'
    MatchingProfile:
      type: object
      description: >
        Contains a profile of matching scores that evaluate how well the trading
        partner data matches against various criteria.
      properties:
        matchingScores:
          $ref: '#/components/schemas/MatchingScores'
    MatchingScores:
      type: object
      description: >
        Provides detailed matching scores broken down into overall, business
        partner specific, and address specific evaluations.
      properties:
        overall:
          $ref: '#/components/schemas/MatchingScore'
        businessPartner:
          $ref: '#/components/schemas/MatchingScore'
        address:
          $ref: '#/components/schemas/MatchingScore'
    MatchingScore:
      type: object
      description: >
        Describes the matching score, including a classification, value, and
        explanation of the match.
      properties:
        classification:
          $ref: '#/components/schemas/MatchingClassification'
        value:
          $ref: '#/components/schemas/MatchingScoreValue'
        explanation:
          $ref: '#/components/schemas/MatchingScoreExplanation'
    MatchingClassification:
      type: string
      example: FULL_MATCH
      description: >
        Enumerates the possible classifications for data matching, providing a
        clearer interpretation of the matching score.
    MatchingScoreValue:
      type: number
      format: double
      example: '0.9'
      description: >
        Numeric value representing the degree of match calculated during data
        validation processes.
    MatchingScoreExplanation:
      type: string
      description: Explanation for matching score value.
      example: >-
        BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall:
        [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]
    QualificationDecision:
      type: object
      description: >
        Details the decisions made during the qualification process of data
        validation, including the rule applied and the specific target of the
        qualification.
      properties:
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
        qualificationTarget:
          $ref: '#/components/schemas/QualificationTarget'
        decision:
          $ref: '#/components/schemas/QualificationDecisionTechnicalKey'
        dataSource:
          $ref: '#/components/schemas/DataSource'
    QualificationTarget:
      type: string
      example: IDENTIFIER
      description: >
        Specify the target attribute of the trading partner data that was
        subject to qualification.
    QualificationDecisionTechnicalKey:
      type: string
      example: VALID
      description: >
        Enumerates the potential outcomes of data qualification checks, useful
        for understanding validation results.
    ScreeningMatch:
      type: object
      description: >
        Represents the results of a screening process, detailing the specific
        list on which a match was found and the respective matching score.
      properties:
        complianceList:
          $ref: '#/components/schemas/ComplianceList'
        matchingScore:
          $ref: '#/components/schemas/MatchingScore'
    ComplianceList:
      type: object
      description: >
        Describes a compliance or sanction list used during the screening
        process, including its type, name, and issuing body.
      properties:
        type:
          $ref: '#/components/schemas/ComplianceListType'
        name:
          $ref: '#/components/schemas/ComplianceListName'
        technicalKey:
          type: string
          $ref: '#/components/schemas/ComplianceListTechnicalKey'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
        rationale:
          $ref: '#/components/schemas/ComplianceListRationale'
    ComplianceListRationale:
      type: string
      description: >
        Explanation of the compliance list, e.g., country scope, political
        background, or legal basis.
      example: political background
    IssuingBody:
      type: object
      description: >
        Represents the authority or organization that issued a compliance or
        sanction list.
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
    ComplianceListType:
      type: string
      example: SANCTIONLIST
      description: >
        Specifies the type of compliance list used during sanction screening
        processes.
    DecisionsUpsertRequest:
      type: object
      description: Request to upsert decisions.
      required:
        - decisions
      properties:
        decisions:
          type: array
          description: List of decisions to be upserted.
          minItems: 1
          items:
            $ref: '#/components/schemas/DecisionsUpsertEntry'
    DecisionsUpsertResult:
      type: object
      description: Represents the result of the upsert operation.
      properties:
        numberOfProvidedDecisions:
          type: integer
          description: Number of decisions provided in the request.
          example: '10'
        numberOfInserts:
          type: integer
          description: Number of decisions inserted.
          example: '5'
        numberOfUpdates:
          type: integer
          description: Number of decisions updated.
          example: '5'
    DecisionsUpsertEntry:
      type: object
      description: An entry for the upsert operation.
      required:
        - type
        - businessPartnerId
        - dataSourceId
      properties:
        type:
          $ref: '#/components/schemas/DecisionLogType'
        businessPartnerId:
          $ref: '#/components/schemas/DecisionLogBusinessPartnerId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        externalId:
          $ref: '#/components/schemas/DecisionLogExternalId'
        updateDecisions:
          type: array
          items:
            $ref: '#/components/schemas/UpdateDecision'
        validationDecisions:
          type: array
          items:
            $ref: '#/components/schemas/ValidationDecision'
    DecisionsPage:
      type: object
      description: Decisions page with pagination information and list of decisions.
      properties:
        values:
          type: array
          description: List of decisions.
          items:
            $ref: '#/components/schemas/DecisionLogSearchResult'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
    DecisionLogSearchResult:
      type: object
      description: Decision log entry with decisions and metadata.
      properties:
        id:
          $ref: '#/components/schemas/DecisionLogEntryId'
        type:
          $ref: '#/components/schemas/DecisionLogType'
        businessPartnerId:
          $ref: '#/components/schemas/DecisionLogBusinessPartnerId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        lastUpdatedAt:
          type: string
          description: Date and time of the last update.
          example: '2025-10-14T07:32:29Z'
        lastUpdatedBy:
          type: string
          description: User who last updated the entry.
          example: username
        updateDecisions:
          type: array
          description: List of update decisions.
          items:
            $ref: '#/components/schemas/UpdateDecision'
        validationDecisions:
          type: array
          description: List of validation decisions.
          items:
            $ref: '#/components/schemas/ValidationDecision'
    UpdateDecision:
      type: object
      description: Determine which properties are to be updated.
      properties:
        context:
          $ref: '#/components/schemas/UpdateContext'
        proposal:
          $ref: '#/components/schemas/PropertyChange'
        status:
          $ref: '#/components/schemas/DecisionStatusParam'
        reliability:
          $ref: '#/components/schemas/UpdateReliabilityParam'
    ValidationDecision:
      type: object
      description: Determine which data defects are to be REJECTED.
      properties:
        context:
          $ref: '#/components/schemas/ValidationContext'
        dataDefect:
          $ref: '#/components/schemas/DataDefect'
        status:
          $ref: '#/components/schemas/ValidationDecisionStatusParam'
    ValidationContext:
      type: object
      description: >-
        Metadata of a validation decision, including information about who
        created the decision and when it was created.
      properties:
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
    DataDefectPropertyParentConcept:
      type: object
      description: >-
        Concept of a property that is affected by a data defect, providing a
        link to the metadata concept.
      properties:
        url:
          $ref: '#/components/schemas/ConceptUrl'
    UpdateContext:
      type: object
      description: >-
        Metadata of an update decision, including information about who created
        the decision and when it was created.
      properties:
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        scope:
          $ref: '#/components/schemas/DecisionScope'
    DecisionScope:
      type: object
      description: >-
        Scope of a decision, including the data source IDs and country short
        names it applies to, and the curation similarity threshold.
      properties:
        dataSourceIds:
          type: array
          description: List of data source IDs the decision applies to.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        countryShortNames:
          type: array
          description: List of country short names.
          items:
            $ref: '#/components/schemas/CountryShortName'
        curationSimilarity:
          type: number
          format: double
          description: The similarity threshold for curation decisions.
          example: '0.8'
    PropertyChange:
      type: object
      description: >-
        Describes how a property has been changed and how confident we are that
        the change was a good improvement.
      properties:
        externalIds:
          type: array
          description: List of external IDs for the property.
          items:
            $ref: '#/components/schemas/ExternalId'
        property:
          $ref: '#/components/schemas/Property'
        newContent:
          $ref: '#/components/schemas/PropertyNewContent'
        previousContent:
          $ref: '#/components/schemas/PropertyPreviousContent'
        provenance:
          $ref: '#/components/schemas/Provenance'
        changeType:
          $ref: '#/components/schemas/PropertyChangeType'
        changeClassification:
          $ref: '#/components/schemas/PropertyChangeClassification'
        confidenceScore:
          $ref: '#/components/schemas/PropertyChangeConfidenceScore'
        maxConfidenceScore:
          $ref: '#/components/schemas/PropertyChangeMaxConfidenceScore'
        matchingScores:
          $ref: '#/components/schemas/MatchingScores'
    ExternalId:
      type: object
      description: >
        Arbitrary identifier type to mark customer IDs which are "external" from
        CDQ's perspective. This is the 

        identifier a customer provides to identify her records, e.g. the ID she
        manages in her SAP systems.
      properties:
        externalId:
          $ref: '#/components/schemas/ExternalIdValue'
        dataSourceId:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        id:
          $ref: '#/components/schemas/ExternalIdValue'
        concept:
          $ref: '#/components/schemas/Concept'
        language:
          $ref: '#/components/schemas/schemas-Language'
        characterSet:
          $ref: '#/components/schemas/schemas-CharacterSet'
        type:
          $ref: '#/components/schemas/AddressType'
    Concept:
      type: object
      description: >
        The Concept is a part of the CDQ data model. For example Address is a
        concept of the Business Partner and have 

        many subconcepts as Locality, Thoroughfare, Administrative Area etc.
      properties:
        name:
          $ref: '#/components/schemas/ConceptName'
        technicalKey:
          $ref: '#/components/schemas/ConceptTechnicalKey'
    Property:
      type: object
      description: Part of a concept. It describes a single attribute of a concept.
      properties:
        parentConcept:
          $ref: '#/components/schemas/Concept'
        name:
          $ref: '#/components/schemas/PropertyName'
        technicalKey:
          $ref: '#/components/schemas/PropertyTechnicalKey'
        contentSelector:
          $ref: '#/components/schemas/PropertyContentSelector'
        instanceSelectors:
          type: array
          description: List of Instance Selectors.
          items:
            $ref: '#/components/schemas/PropertyContentInstanceSelector'
    PropertyContentInstanceSelector:
      type: object
      description: Contains JSON paths allowing to select specific instance of a property.
      properties:
        key:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorKey'
        value:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorValue'
    DecisionsClearRequest:
      type: object
      description: >-
        Request to remove decisions of a specified type or from certain Data
        Sources, used during a clear operation on decisions.
      properties:
        type:
          $ref: '#/components/schemas/DecisionLogType'
        dataSources:
          type: array
          description: List of Data Source IDs to be cleared.
          items:
            $ref: '#/components/schemas/DecisionClearDataSourceParam'
    DecisionClearDataSourceParam:
      type: object
      description: Data Source ID to be cleared.
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    DecisionDeletes:
      type: object
      description: Request to delete decisions.
      required:
        - decisions
      properties:
        decisions:
          type: array
          description: List of decisions to be deleted.
          minItems: 1
          items:
            $ref: '#/components/schemas/DecisionDelete'
    DecisionDelete:
      type: object
      description: An entry for the delete operation.
      properties:
        id:
          $ref: '#/components/schemas/DecisionLogEntryId'
        businessPartnerId:
          $ref: '#/components/schemas/DecisionLogBusinessPartnerId'
    DecisionDeleteResults:
      type: object
      description: Result of the delete operation.
      properties:
        numberOfDeleted:
          type: integer
          description: Number of decisions deleted.
          example: '10'
    DecisionLogEntryId:
      type: string
      description: A CDQ ID identifies a Decision Log Entry.
      example: 63e635235c06b7396330fe40
    DecisionLogBusinessPartnerId:
      type: string
      description: >-
        A CDQ ID identifies a Business Partner uniquely in the context of the
        Corporate Data League.
      example: 63e635235c06b7396330fe40
    DecisionLogExternalId:
      type: string
      description: >-
        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.
    DecisionLogType:
      type: object
      description: Type of decision log entry.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DecisionLogTypeTechnicalKeyParam'
    DecisionLogTypeTechnicalKeyParam:
      type: string
      description: Technical key of the decision log type.
      example: CURATIONS
      enum:
        - CURATIONS
        - NATURAL_PERSONS
        - DUPLICATES
      x-enumDescriptions:
        CURATIONS: Curation decisions.
        NATURAL_PERSONS: Natural person decisions.
        DUPLICATES: Duplicate decisions.
    DecisionStatusParam:
      type: string
      description: Status of a decision.
      example: ACCEPTED
      enum:
        - ACCEPTED
        - REJECTED
      x-enumDescriptions:
        ACCEPTED: Decision is accepted.
        REJECTED: Decision is rejected.
    ValidationDecisionStatusParam:
      type: string
      description: Status of a validation decision.
      example: ACCEPTED
      enum:
        - ACCEPTED
        - REJECTED
      x-enumDescriptions:
        ACCEPTED: Decision is accepted.
        REJECTED: Decision is rejected.
    UpdateReliabilityParam:
      type: string
      description: Reliability of an update decision.
      example: TRUSTED_SOURCE
      enum:
        - UNKNOWN
        - UNCERTAIN
        - TRUSTED_SOURCE
        - AUTOMATED
        - CONFIRMED_REVIEW
      x-enumDescriptions:
        UNKNOWN: Reliability of the decision is unknown.
        UNCERTAIN: Decision is based on uncertain data.
        TRUSTED_SOURCE: Decision is based on data from a trusted source.
        AUTOMATED: Decision is based on automated processing.
        CONFIRMED_REVIEW: Decision is based on a confirmed review.
    ReviewStatusParam:
      type: string
      description: Review status.
      example: REVIEWED
      enum:
        - REVIEWED
        - NOT_REVIEWED
      x-enumDescriptions:
        REVIEWED: Decisions have been reviewed.
        NOT_REVIEWED: Decisions have not been reviewed.
    CurationDecisionImportJobRequest:
      type: object
      description: Request to import curation decisions.
      required:
        - storageId
        - scope
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        onlyNotReviewed:
          type: boolean
          default: false
          description: >
            If set to true, only curation decisions that have not been reviewed
            yet will be imported.

            If set to false, all curation decisions will be imported.
          example: 'true'
        scope:
          $ref: '#/components/schemas/CurationDecisionImportJobScope'
    CurationDecisionImportJobScope:
      type: object
      description: Scope of a curation decision import job.
      properties:
        accepted:
          $ref: '#/components/schemas/CurationDecisionImportJobConfig'
        rejected:
          $ref: '#/components/schemas/CurationDecisionImportJobConfig'
    CurationDecisionImportJobConfig:
      type: object
      description: Configuration of a curation decision import job.
      properties:
        identifiers:
          type: array
          description: List of identifiers to be imported.
          items:
            $ref: '#/components/schemas/CurationDecisionImportJobProperty'
    CurationDecisionImportJobProperty:
      type: object
      description: Property of a curation decision import job.
      properties:
        technicalKey:
          type: string
          description: Technical key of the property.
          example: EU_VAT_ID_DE
        changeTypes:
          type: array
          description: List of change types.
          items:
            type: string
            description: |
              Change type. Possible values are:
                * `ADDED`
                * `DELETED`
            example: ADDED
        countryShortNames:
          type: array
          description: List of country short names to be imported.
          items:
            $ref: '#/components/schemas/CountryShortName'
        thresholds:
          type: object
          description: Thresholds for curation decisions.
          properties:
            businessPartnerRequestSimilarity:
              description: >-
                Threshold for business partner request similarity. Defines how
                similar the name from the request is to the name after curation.
                Related to businessPartnerCurationResult.requestSimilarity.name
              $ref: '#/components/schemas/Threshold'
            addressRequestSimilarity:
              description: >-
                Threshold for address request similarity. Defines how similar
                the address from the request is to the address after curation.
                Related to
                businessPartnerCurationResult.requestSimilarity.address
              $ref: '#/components/schemas/Threshold'
            businessPartnerMatchingScore:
              description: >-
                Threshold for business partner matching score. Defines the
                matching score of the business partner from which the identifier
                was enriched. Related to
                businessPartnerCurationResult.changes.matchingScores.businessPartner
              $ref: '#/components/schemas/Threshold'
            addressMatchingScore:
              description: >-
                Threshold for address matching score. Defines the matching score
                of the business partner from which the identifier was enriched.
                Related to
                businessPartnerCurationResult.changes.matchingScores.address
              $ref: '#/components/schemas/Threshold'
    Threshold:
      type: number
      format: double
      description: Threshold value.
      example: '0.8'
    CurationDecisionImportJob:
      type: object
      description: Represents a curation decision import job.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        user:
          $ref: '#/components/schemas/JobUser'
        progress:
          $ref: '#/components/schemas/JobStatusMessage'
        attachments:
          type: array
          description: List of attachments.
          items:
            $ref: '#/components/schemas/FileResource'
    FileResource:
      type: object
      description: File resource which can be uploaded or downloaded.
      properties:
        url:
          $ref: '#/components/schemas/FileResourceUrl'
        tags:
          $ref: '#/components/schemas/Tags'
    Tags:
      type: array
      description: List of tags.
      items:
        $ref: '#/components/schemas/Tag'
    AugmentationConfigurationCreate:
      type: object
      description: Data structure for creating a new augmentation configuration.
      properties:
        featuresOn:
          $ref: '#/components/schemas/TransactionFeaturesOn'
        workspaceId:
          $ref: '#/components/schemas/WorkspaceId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        configuration:
          $ref: '#/components/schemas/AugmentationConfiguration'
    AugmentationConfigurationUpdate:
      type: object
      description: Data structure for updating an existing augmentation configuration.
      properties:
        featuresOn:
          $ref: '#/components/schemas/AugmentationConfigurationUpdateFeaturesOn'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        defaultConfiguration:
          type: boolean
          description: >-
            Is default workspace configuration. Only one configuration of the
            same type can be a default configuration in a given workspace.
          default: false
          example: true
        configuration:
          $ref: '#/components/schemas/AugmentationConfiguration'
    RelatedConfiguration:
      type: object
      description: ID of the related configuration.
      properties:
        id:
          $ref: '#/components/schemas/RelatedConfigurationId'
        owner:
          $ref: '#/components/schemas/RelatedConfigurationOwner'
    RelatedConfigurationId:
      type: string
      description: Id of the related configuration.
      example: a0200062daa56952a8640005
    RelatedConfigurationOwner:
      type: object
      description: Configuration which relates to the root configuration.
      properties:
        service:
          $ref: '#/components/schemas/RelatedConfigurationOwnerService'
        path:
          $ref: '#/components/schemas/RelatedConfigurationOwnerPath'
    RelatedConfigurationOwnerService:
      type: string
      description: Name of the service which is the owner of the configuration.
      example: reference-data-api
    RelatedConfigurationOwnerPath:
      type: string
      description: Endpoint used to read the related configuration.
      example: /public/configurations/businesspartnerlookup
    TransactionFeaturesOn:
      description: >-
        Features to be enabled. Do not use CREATE_TRANSACTION and
        COMMIT_TRANSACTION at the same time.
      type: array
      items:
        $ref: '#/components/schemas/TransactionFeatureParam'
    TransactionFeatureParam:
      type: string
      description: Feature used to control transaction process.
      example: CREATE_TRANSACTION
      enum:
        - CREATE_TRANSACTION
        - COMMIT_TRANSACTION
      x-enumDescriptions:
        CREATE_TRANSACTION: >-
          Creates a new transaction and makes the current request a part of it.
          By default turned off.
        COMMIT_TRANSACTION: Commit transaction. By default turned off.
    AugmentationConfigurationResult:
      type: object
      description: >-
        Data structure representing the result of an augmentation configuration
        operation.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        configuration:
          $ref: '#/components/schemas/AugmentationConfiguration'
    AugmentationConfigurationVersionResult:
      type: object
      description: Specific version of an augmentation configuration configuration.
      properties:
        id:
          type: string
          description: >-
            Unique identifier of the augmentation configuration configuration
            version. Not to be confused with the configuration ID.
          example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
        name:
          type: string
          description: The name of the configuration
          example: Configuration Name
        configurationId:
          $ref: '#/components/schemas/ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/AugmentationConfiguration'
        createdAt:
          type: string
          description: >-
            Date and time when the first version of the configuration was
            created (ISO 8601-compliant).
          example: '2025-10-14T07:32:29Z'
        modifiedAt:
          type: string
          description: >-
            Date and time when this version of the configuration was created
            (ISO 8601-compliant).
          example: '2025-10-14T07:32:29Z'
        createdBy:
          type: string
          description: User who created the first version of the configuration.
          example: '69129435489347624'
        modifiedBy:
          type: string
          description: User who created this version of the configuration.
          example: '76248934691294444'
    ConfigurationVersionNumber:
      type: integer
      description: Version number of the configuration.
      example: 1
    AugmentationConfiguration:
      type: object
      description: The effective settings for the augmentation.
      properties:
        lookupConfiguration:
          $ref: '#/components/schemas/LookupConfiguration'
        fetchConfiguration:
          $ref: '#/components/schemas/FetchConfiguration'
        curationConfiguration:
          $ref: '#/components/schemas/CurationConfiguration'
        updateClassificationConfiguration:
          $ref: '#/components/schemas/UpdateClassificationConfiguration'
        referenceDataSourceUsages:
          type: array
          description: >-
            At least 1 element required when updating configuration for
            prevention of removal.
          items:
            $ref: '#/components/schemas/ReferenceDataSourceUsageSettings'
        storageDataSourceUsages:
          type: array
          description: >-
            At least 1 element required when updating configuration for
            prevention of removal.
          items:
            $ref: '#/components/schemas/StorageDataSourceUsageSettings'
    AugmentationConfigurationUpdateFeaturesOn:
      type: array
      description: Features to be activated.
      items:
        $ref: '#/components/schemas/AugmentationConfigurationUpdateFeatureParam'
    AugmentationConfigurationUpdateFeatureParam:
      type: string
      description: Feature used during configuration update.
      example: REEVALUATION_ON_CHANGES
      enum:
        - REEVALUATION_ON_CHANGES
      x-enumDescriptions:
        REEVALUATION_ON_CHANGES: Re-evaluates business partners based on changes in the configuration.
    CurationConfiguration:
      description: Data structure representing a curation configuration.
      type: object
      properties:
        curationSettings:
          description: List of curation settings.
          type: array
          items:
            $ref: '#/components/schemas/CurationSettings'
        goldenRecordSettings:
          $ref: '#/components/schemas/GoldenRecordSettings'
    CurationSettings:
      description: Curation settings for a specific configuration.
      type: object
      required:
        - countryScope
      properties:
        countryScope:
          $ref: '#/components/schemas/CountryScope'
        featureSettings:
          $ref: '#/components/schemas/CurationFeatureSettings'
        addressCurationSettings:
          $ref: '#/components/schemas/AddressCurationSettings'
        outputSettings:
          $ref: '#/components/schemas/CurationOutputSettings'
    GoldenRecordSettings:
      description: Golden Record settings for a specific configuration.
      type: object
      required:
        - dataSources
      properties:
        dataSources:
          type: array
          items:
            $ref: '#/components/schemas/GoldenRecordSettingsDataSources'
    GoldenRecordSettingsDataSources:
      type: object
      description: Golden Record settings for data sources per country.
      required:
        - countryScope
        - primaryDataSource
      properties:
        countryScope:
          $ref: '#/components/schemas/CountryScope'
        primaryDataSource:
          $ref: '#/components/schemas/GoldenRecordSettingsDataSource'
        secondaryDataSources:
          type: array
          items:
            $ref: '#/components/schemas/GoldenRecordSettingsDataSource'
        otherDataSources:
          type: array
          items:
            $ref: '#/components/schemas/GoldenRecordSettingsDataSource'
        unallowedDataSources:
          type: array
          items:
            $ref: '#/components/schemas/GoldenRecordSettingsDataSource'
    GoldenRecordSettingsDataSource:
      type: object
      description: Golden Record settings for a single data source.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    AddressCurationSettings:
      description: Settings for address curation.
      type: object
      properties:
        curationLevelThreshold:
          $ref: '#/components/schemas/CurationLevelThreshold'
        dataSourcePriority:
          $ref: '#/components/schemas/AddressDataSourcePriority'
        numberSeparator:
          $ref: '#/components/schemas/NumberSeparator'
        ignoreAddressConcepts:
          deprecated: true
          description: deprecated, please use inputAddressConceptsIgnored instead
          type: array
          items:
            $ref: '#/components/schemas/AddressConcept'
        inputAddressConceptsIgnored:
          type: array
          items:
            $ref: '#/components/schemas/AddressConcept'
    AddressConcept:
      description: Address concept for address curation.
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/AddressConceptTechnicalKey'
    AddressConceptTechnicalKey:
      description: Address concept technical key for address curation.
      type: string
      example: THOROUGHFARE_VALUE
    CurationLevelThreshold:
      description: >-
        Defines threshold for address found in external source like HERE above
        which it is consider as good. Range 0..1.
      type: string
      example: '0.75'
    AddressDataSourcePriority:
      description: >-
        Preferred data sources for curation. Default PrimaryAddressDataSource is
        HERE. Default SecondaryAddressDataSource is CDQ.
      type: object
      properties:
        primaryAddressDataSource:
          $ref: '#/components/schemas/AddressDataSource'
        secondaryAddressDataSources:
          description: List of secondary address data sources.
          type: array
          items:
            $ref: '#/components/schemas/AddressDataSource'
    NumberSeparator:
      description: >-
        Number separator for features `JOIN_THOROUGHFARE_NUMBER_PREFIX`,
        `JOIN_THOROUGHFARE_NUMBER_POSTFIX`.
      type: object
      properties:
        value:
          $ref: '#/components/schemas/NumberSeparatorValue'
    NumberSeparatorValue:
      description: The value of the separator.
      type: string
      example: ','
    UpdateClassificationConfiguration:
      type: object
      description: Model that allows customization of update classification rules.
      properties:
        updateClassificationRules:
          type: array
          description: >-
            List of update classification rules, each linked to
            customer-provided classification keys.
          items:
            $ref: '#/components/schemas/UpdateClassificationRule'
    UpdateClassificationRule:
      type: object
      description: Rule for update classification.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationRuleTechnicalKey'
        classification:
          $ref: '#/components/schemas/UpdateClassificationOverwrite'
    UpdateClassificationRuleTechnicalKey:
      type: string
      description: Unique identifier for the update classification rule.
      example: RULE123
    UpdateClassificationOverwrite:
      type: object
      description: >-
        Container for classification details. Overwrites the default
        classification of the rule.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
    ReferenceDataSourceUsageSettings:
      description: Describes the usage of data sources.
      type: object
      required:
        - referenceDataSource
      properties:
        referenceDataSource:
          $ref: '#/components/schemas/ReferenceDataSource'
        lookup:
          $ref: '#/components/schemas/ReferenceDataSourceUsageLookupSettings'
        updates:
          $ref: '#/components/schemas/ReferenceUpdateMonitorSettings'
    StorageDataSourceUsageSettings:
      description: Describes the usage of data sources.
      type: object
      required:
        - storageDataSource
      properties:
        storageDataSource:
          $ref: '#/components/schemas/StorageDataSource'
        lookup:
          $ref: '#/components/schemas/StorageDataSourceUsageLookupSettings'
        updates:
          $ref: '#/components/schemas/StorageUpdateMonitorSettings'
    ReferenceDataSourceUsageLookupSettings:
      description: Lookup for ReferenceDataSourceUsageSettings.
      example: true
      type: object
      required:
        - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/DataSourceUsageLookupSettingsEnabled'
    StorageDataSourceUsageLookupSettings:
      description: Lookup for StorageDataSourceUsageSettings.
      example: true
      type: object
      required:
        - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/DataSourceUsageLookupSettingsEnabled'
    DataSourceUsageLookupSettingsEnabled:
      description: Boolean indicates that lookup is enabled.
      type: boolean
      example: true
    ReferenceDataSource:
      description: Data Source of the Data Pool.
      type: object
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    StorageDataSource:
      description: Describes a storage data source.
      type: object
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    StorageUpdateMonitorSettings:
      description: Settings for update monitoring.
      type: object
      required:
        - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/UpdateMonitorSettingsEnabled'
        linkageStrategy:
          $ref: '#/components/schemas/LinkageStrategy'
    ReferenceUpdateMonitorSettings:
      description: Settings for update monitoring.
      type: object
      required:
        - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/UpdateMonitorSettingsEnabled'
    UpdateMonitorSettingsEnabled:
      description: Indicates whether the monitoring is enabled or not.
      example: true
      type: boolean
    LinkageStrategyExternalContextIdentifierType:
      description: LinkageStrategyExternalContextIdentifierType.
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    LinkageStrategyExternalContextIdentifier:
      description: LinkageStrategyExternalContextIdentifier.
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LinkageStrategyExternalContextIdentifierType'
    LinkageStrategyExternalContext:
      description: The strategy context for external linkage with an array of identifiers.
      type: object
      properties:
        identifiers:
          type: array
          maxItems: 1
          minItems: 1
          items:
            $ref: '#/components/schemas/LinkageStrategyExternalContextIdentifier'
    LinkageStrategy:
      type: object
      description: Linkage strategy.
      properties:
        externalContext:
          $ref: '#/components/schemas/LinkageStrategyExternalContext'
    LookupConfiguration:
      type: object
      description: Describes the lookup configuration.
      properties:
        featureSettings:
          $ref: '#/components/schemas/LookupFeatureSettings'
        outputSettings:
          $ref: '#/components/schemas/LookupOutputSettings'
    FetchConfiguration:
      type: object
      description: Describes the fetch configuration.
      properties:
        featuresOn:
          type: array
          description: Fetch Feature Settings featuresOn.
          items:
            $ref: '#/components/schemas/FetchFeatureTechnicalKey'
        featuresOff:
          type: array
          description: Fetch Feature Settings featuresOff.
          items:
            $ref: '#/components/schemas/FetchFeatureTechnicalKey'
        screeningMatchingThreshold:
          $ref: '#/components/schemas/FetchScreeningMatchingThreshold'
    LookupFeatureSettings:
      type: object
      description: Feature settings for lookup.
      properties:
        featuresOn:
          type: array
          description: Lookup Feature Settings featuresOn.
          items:
            $ref: '#/components/schemas/LookupFeatureTechnicalKey'
        featuresOff:
          type: array
          description: Lookup Feature Settings featuresOff.
          items:
            $ref: '#/components/schemas/LookupFeatureTechnicalKey'
    LookupFeatureTechnicalKey:
      type: string
      description: >-
        A feature for lookup. List of available lookup features is available
        under (List lookup
        features)[https://developer.cdq.com/reference-docs/data-clinic/tag/Configuration/#tag/Configuration/paths/~1configurations~1augmentation~1lookup~1features/get].
      example: CURATE_REQUEST
    FetchFeatureTechnicalKey:
      type: string
      description: A feature for fetch.
      example: FORCE_EXTERNAL_CALL
    LookupOutputSettings:
      description: Settings used for the response.
      type: object
      properties:
        matchingClassifications:
          type: array
          items:
            $ref: '#/components/schemas/LookupOutputSettingsMatchingClassification'
        matchingThreshold:
          $ref: '#/components/schemas/LookupOutputSettingsMatchingThreshold'
        maxCandidates:
          $ref: '#/components/schemas/LookupOutputSettingsMaxCandidates'
        limit:
          $ref: '#/components/schemas/LookupConfigurationLimit'
    LookupOutputSettingsMatchingClassification:
      type: object
      description: Matching classifications configuration.
      required:
        - countryScope
        - businessPartnerThreshold
        - addressThreshold
      properties:
        countryScope:
          $ref: >-
            #/components/schemas/LookupOutputSettingsMatchingClassificationCountryScope
        businessPartnerThreshold:
          $ref: >-
            #/components/schemas/LookupOutputSettingsMatchingClassificationThresholds
        addressThreshold:
          $ref: >-
            #/components/schemas/LookupOutputSettingsMatchingClassificationThresholds
    LookupOutputSettingsMatchingClassificationCountryScope:
      type: object
      description: Matching classification countries scope.
      required:
        - shortNames
      properties:
        shortNames:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/CountryShortName'
    LookupOutputSettingsMatchingClassificationThresholds:
      type: object
      description: Matching classification thresholds.
      required:
        - fullMatch
        - maybeMatch
      properties:
        fullMatch:
          $ref: >-
            #/components/schemas/LookupOutputSettingsMatchingClassificationThreshold
        maybeMatch:
          $ref: >-
            #/components/schemas/LookupOutputSettingsMatchingClassificationThreshold
    LookupOutputSettingsMatchingClassificationThreshold:
      description: Matching classification threshold.
      example: 0.75
      minimum: 0
      maximum: 1
      type: number
      format: double
    LookupConfigurationLimit:
      description: Limit
      example: 100
      minimum: 1
      maximum: 1000
      default: 10
      type: integer
    FetchScreeningMatchingThreshold:
      description: ScreenMatchingThreshold.
      example: 0.75
      minimum: 0
      maximum: 1
      type: number
      format: double
    LookupOutputSettingsMatchingThreshold:
      description: LookupOutputSettings matchingThreshold.
      example: 0.75
      minimum: 0
      maximum: 1
      type: number
      format: double
    LookupOutputSettingsMaxCandidates:
      description: LookupOutputSettings maxCandidates.
      example: 50
      type: integer
      minimum: 20
      maximum: 200
    CountryScope:
      description: (Optionally) Describes for which country the settings are for.
      type: object
      required:
        - shortName
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    AddressDataSource:
      type: object
      description: >-
        Object representing the data source for addresses, containing technical
        keys and thresholds.
      properties:
        technicalKey:
          $ref: '#/components/schemas/AddressDataSourceTechnicalKey'
        threshold:
          $ref: '#/components/schemas/AddressDataSourceThreshold'
    CurationFeatureSettings:
      description: Feature settings for curation.
      type: object
      properties:
        profile:
          $ref: '#/components/schemas/CurationProfileTechnicalKey'
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/CurationFeatureTechnicalKey'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/CurationFeatureTechnicalKey'
    CurationProfileTechnicalKey:
      type: string
      description: >-
        The profile for curation. List of available curation profiles is
        available under (List curation
        profiles)[https://developer.cdq.com/reference-docs/data-clinic/tag/Configuration/#tag/Configuration/paths/~1configurations~1augmentation~1curation~1profiles/get].
      example: STANDARD
    CurationFeatureTechnicalKey:
      type: string
      description: >-
        A feature for curation. List of available curation features is available
        under (List curation
        features)[https://developer.cdq.com/reference-docs/data-clinic/tag/Configuration/#tag/Configuration/paths/~1configurations~1augmentation~1curation~1features/get].
      example: ENRICH_IDENTIFIERS
    CurationOutputSettings:
      description: Output settings for curation.
      type: object
      properties:
        outputLanguage:
          $ref: '#/components/schemas/OutputLanguage'
        outputCharsets:
          type: array
          items:
            $ref: '#/components/schemas/OutputCharset'
    OutputLanguage:
      description: The language used for the curation output.
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/OutputLanguageTechnicalKey'
    OutputLanguageTechnicalKey:
      description: Technical key of the language used for the curation output.
      example: en
      type: string
    OutputCharset:
      type: object
      description: Defines the output charset for a concept.
      properties:
        concept:
          $ref: '#/components/schemas/OutputCharsetConcept'
        charset:
          $ref: '#/components/schemas/OutputCharsetCharset'
    TriggerTypeTechnicalKey:
      type: string
      description: >-
        The type of trigger for the generation of a new version of the Business
        Partner.
      example: CREATED
    TriggerTypeTechnicalKeyParam:
      type: string
      description: >-
        The type of trigger for the generation of a new version of the Business
        Partner.
      example: CREATED
      enum:
        - CREATED
        - UPDATED
        - REFERENCE_DATA_CHANGED
        - JOB
      x-enumDescriptions:
        CREATED: >-
          Business Partners that were newly created in the data mirror by the
          user and thus were considered the first time.
        UPDATED: Business Partners that were modified in the data mirror by the user.
        REFERENCE_DATA_CHANGED: >-
          Business Partners in the data mirror for which an update in activated
          data sources was identified resulting in the generation of a new
          version of the Business Partner.
        JOB: Business Partners that were created or updated by a job.
    ReadAugmentedBusinessPartnersFeature:
      type: string
      description: Feature to be used during the read augmented Business Partners.
      example: FETCH_RAW_UPDATES
    ReadAugmentedBusinessPartnersFeatureParam:
      type: string
      description: Feature to be used during the read augmented Business Partners.
      example: FETCH_RAW_UPDATES
      enum:
        - FETCH_RAW_UPDATES
        - FILTER_BY_ENABLED_AUGMENTATION_MONITORS
        - SHOW_ORIGINAL_BUSINESS_PARTNER
      x-enumDescriptions:
        FETCH_RAW_UPDATES: >-
          Allows to switch fetching raw updates field to reduce data size.
          Result is available under **$.values[*].updates** in the result
          object. By default, turned off.
        FILTER_BY_ENABLED_AUGMENTATION_MONITORS: >-
          Filters out results by enabled, existing data sources of augmentation
          monitors. By default, turned on.
        SHOW_ORIGINAL_BUSINESS_PARTNER: >-
          Include business partner that was used as an input for curation in the
          result. By default, turned off.
    FetchAugmentedBusinessPartnerFeatureParam:
      type: string
      description: Feature used during fetch Augmented Business Partner.
      example: FETCH_RAW_UPDATES
      enum:
        - FETCH_RAW_UPDATES
        - SHOW_ORIGINAL_BUSINESS_PARTNER
      x-enumDescriptions:
        FETCH_RAW_UPDATES: >-
          Allows to switch fetching raw updates field to reduce data size.
          Result is available under **$.updates** in the result object. By
          default, turned off.
        SHOW_ORIGINAL_BUSINESS_PARTNER: >-
          Include business partner that was used as an input for curation in the
          result. By default, turned off.
    AugmentedBusinessPartnerMetadataCountry:
      type: object
      description: Country short name for an Augmented Business Partner.
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    AugmentedBusinessPartnerMetadataTrigger:
      type: object
      description: Trigger for an Augmented Business Partner.
      properties:
        type:
          $ref: '#/components/schemas/AugmentedBusinessPartnerMetadataTriggerType'
        provenance:
          $ref: >-
            #/components/schemas/AugmentedBusinessPartnerMetadataTriggerProvenance
    AugmentedBusinessPartnerMetadataTriggerType:
      type: object
      description: Trigger type for an Augmented Business Partner.
      properties:
        technicalKey:
          type: string
          description: Technical key of the trigger type.
          example: PROCESSING_LOG
    AugmentedBusinessPartnerMetadataTriggerProvenance:
      type: object
      description: Provenance for an Augmented Business Partner.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
    BusinessPartnerType:
      type: object
      description: >
        A distinct type a Business Partner is assigned to. It determines the
        business context a business partner is 

        involved in. In the Corporate Data League, most business partners are
        legal entities.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKey'
    Name:
      type: object
      description: The name of a Business Partner.
      properties:
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        shortName:
          $ref: '#/components/schemas/NameShortName'
        language:
          $ref: '#/components/schemas/Language'
    NameType:
      type: object
      description: >-
        The type of the name, e.g. a locally used name or an international
        version.
      properties:
        url:
          $ref: '#/components/schemas/NameTypeUrl'
        name:
          $ref: '#/components/schemas/NameTypeName'
        technicalKey:
          $ref: '#/components/schemas/NameTypeTechnicalKey'
    LegalForm:
      type: object
      description: >
        The legal form of a Business Partner is the form it takes in the eyes of
        the law governing it. The legal form 

        of a company 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's name (e.g. AG, Inc., LLC, S.A.).
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormTechnicalKey'
        language:
          $ref: '#/components/schemas/schemas-Language'
        mainAbbreviation:
          $ref: '#/components/schemas/LegalFormMainAbbreviation'
        cdlElfCode:
          $ref: '#/components/schemas/LegalFormCdlElfCode'
        categories:
          type: array
          description: List of categories of the legal form.
          items:
            $ref: '#/components/schemas/LegalFormCategory'
    LegalFormCategory:
      type: object
      description: The categorization of a Legal Form.
      properties:
        name:
          $ref: '#/components/schemas/LegalFormCategoryName'
        url:
          $ref: '#/components/schemas/LegalFormCategoryUrl'
    Identifier:
      type: object
      description: >-
        Identifies a Business Partner in a given context uniquely such as a VAT
        identification number.
      properties:
        type:
          $ref: '#/components/schemas/IdentifierType'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
        status:
          $ref: '#/components/schemas/IdentifierStatus'
    IdentifierType:
      type: object
      description: Type of the identifier.
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/IdentifierTypeTechnicalKey'
    IdentifierStatus:
      type: object
      description: >
        Describes the status of an identifier with respect to its level of
        activity (e.g. out of business) or legally 

        relevant conditions (e.g. in liquidation).
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    BusinessPartnerCategory:
      type: object
      description: >-
        A Business Partner category of a Business Partner groups similar
        Business Partners.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        url:
          $ref: '#/components/schemas/BusinessPartnerCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    BusinessPartnerStatus:
      type: object
      description: >
        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).
      properties:
        type:
          $ref: '#/components/schemas/BusinessPartnerStatusType'
        officialDenotation:
          $ref: '#/components/schemas/BusinessPartnerStatusOfficialDenotation'
        validFrom:
          $ref: '#/components/schemas/BusinessPartnerStatusValidFrom'
        validUntil:
          $ref: '#/components/schemas/BusinessPartnerStatusValidUntil'
    BusinessPartnerStatusType:
      type: object
      description: The standardized status which the business partner currently has.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    Website:
      type: object
      description: >-
        Webpages related to the Business Partner, e.g. the main corporate
        website as also provided by some company registers.
      properties:
        url:
          $ref: '#/components/schemas/WebsiteUrl'
        type:
          $ref: '#/components/schemas/WebsiteType'
    WebsiteType:
      type: object
      description: >-
        Describes the type of website of a Business Partner, e.g. corporate
        website, official LinkedIn profile, etc.
      properties:
        name:
          $ref: '#/components/schemas/WebsiteTypeName'
        url:
          $ref: '#/components/schemas/WebsiteTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/WebsiteTypeTechnicalKey'
    ContactEmail:
      type: object
      description: Actual email address of the Business Partner.
      properties:
        value:
          $ref: '#/components/schemas/ContactEmailValue'
    AddressVersion:
      type: object
      description: >
        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.
      properties:
        language:
          $ref: '#/components/schemas/Language'
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
    CharacterSet:
      type: object
      description: >-
        Character set. Available values can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    AddressIdentifyingName:
      type: object
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      properties:
        value:
          $ref: '#/components/schemas/AddressIdentifyingNameValue'
    CareOf:
      type: object
      description: >
        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.
      properties:
        value:
          $ref: '#/components/schemas/CareOfValue'
    AddressContext:
      type: object
      description: >
        The address context provides us with some additional information about
        the usage or specific recipient 

        information of the addresses. It may hold multiple information organized
        as "tags".
      properties:
        value:
          $ref: '#/components/schemas/AddressContextValue'
    Country:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
        value:
          $ref: '#/components/schemas/CountryValue'
    AdministrativeArea:
      type: object
      description: A top-level geographical or political area division in a country.
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        fipsCode:
          $ref: '#/components/schemas/AdministrativeAreaFipsCode'
        shortName:
          $ref: '#/components/schemas/AdministrativeAreaShortName'
        type:
          $ref: '#/components/schemas/AdministrativeAreaType'
        language:
          $ref: '#/components/schemas/Language'
    AdministrativeAreaType:
      type: object
      description: The type of the administrative area.
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    PostCode:
      type: object
      description: >-
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or an combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    PostCodeType:
      type: object
      description: >
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or a combination of 

        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      properties:
        name:
          $ref: '#/components/schemas/PostCodeTypeName'
        url:
          $ref: '#/components/schemas/PostCodeTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostCodeTypeTechnicalKey'
    Locality:
      type: object
      description: >
        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.
      properties:
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        value:
          $ref: '#/components/schemas/LocalityValue'
        language:
          $ref: '#/components/schemas/Language'
    LocalityType:
      type: object
      description: Type of the [Locality](https://meta.cdq.com/Address/locality).
      properties:
        name:
          $ref: '#/components/schemas/LocalityTypeName'
        url:
          $ref: '#/components/schemas/LocalityTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/LocalityTypeTechnicalKey'
    Thoroughfare:
      type: object
      description: >
        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.
      properties:
        type:
          $ref: '#/components/schemas/ThoroughfareType'
        shortName:
          $ref: '#/components/schemas/ThoroughfareShortName'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        name:
          $ref: '#/components/schemas/ThoroughfareName'
        direction:
          $ref: '#/components/schemas/ThoroughfareDirection'
        language:
          $ref: '#/components/schemas/Language'
    ThoroughfareType:
      type: object
      description: Type of the thoroughfare.
      properties:
        name:
          $ref: '#/components/schemas/ThoroughfareTypeName'
        url:
          $ref: '#/components/schemas/ThoroughfareTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    Premise:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sublevels to precisely identify.
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        shortName:
          $ref: '#/components/schemas/PremiseShortName'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseType'
        language:
          $ref: '#/components/schemas/Language'
    PremiseType:
      type: object
      description: Type of the Premise.
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PremiseTypeTechnicalKey'
    PostalDeliveryPoint:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        type:
          $ref: '#/components/schemas/PostalDeliveryPointType'
        shortName:
          $ref: '#/components/schemas/PostalDeliveryPointShortName'
        number:
          $ref: '#/components/schemas/PostalDeliveryPointNumber'
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        language:
          $ref: '#/components/schemas/Language'
    PostalDeliveryPointType:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostalDeliveryPointTypeTechnicalKey'
    GeographicCoordinates:
      type: object
      description: Decimal geographic coordinates (WGS 84 - reference coordinate system).
      properties:
        latitude:
          $ref: '#/components/schemas/GeographicCoordinatesLatitude'
        longitude:
          $ref: '#/components/schemas/GeographicCoordinatesLongitude'
    AddressType:
      type: object
      description: >
        An address type characterizes an address. The type of address is a
        structural statement and provides a truth that 

        is applicable to any user (e.g. a legal address is a fact, or that an
        address is a PO BOX address), other than 

        address functions that may differ from user to user. Address functions
        determine the particular business context 

        in which an address is in use.
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    ExecutedAt:
      type: string
      description: >-
        ISO 8601 representation of the timestamp when the result data was
        created.
      example: '2025-10-14T07:32:29Z'
    AugmentationConfigurationsPage:
      type: object
      description: Page of augmentation configurations in the current workspace.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of augmentation configurations.
          items:
            $ref: '#/components/schemas/AugmentationConfigurationSearchResult'
    AugmentationConfigurationSearchResult:
      type: object
      description: Augmentation configurations found in the current workspace.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    ProvenanceTechnicalKeyParam:
      type: string
      description: >
        Data sources that triggered the generation of a new version of the
        Business Partner. Data source prefixes 

        (see all Data Source prefixes here: [Data sources -
        CDQ](https://meta.cdq.com/Data_sources)
      example: CDQ_POOL
      enum:
        - AR_NRC
        - AT_CR
        - AT_FON
        - AU_BR
        - BR_RF
        - BZST
        - CA_CR
        - CDQ_AA
        - CDQ_BANKPOOL
        - CDQ_CRS
        - CDQ_CTRY
        - CDQ_IDS
        - CDQ_LF
        - CDQ_POOL
        - CH_MEDREG
        - CH_UIDR
        - CX_BPN
        - CX_POOL
        - CZ_REE
        - DE_RC
        - DK_CR
        - DNB
        - DNB_LINKAGE_LNKELI
        - DNB_MASTER_DATA_BASIC
        - DNB_MASTER_DATA_EXTENDED
        - EE_CR
        - FR_RC
        - GB_EAW_CR
        - GEON
        - GMAPS
        - GOOGLEPLACES
        - GTRANSLATE
        - HERE
        - HK_CR
        - IE_CR
        - IL_CR
        - IRS
        - JP_CR
        - LEI
        - NL_BR
        - NZ_CR
        - ORGANIZATION
        - OSM
        - PL_NOBR
        - RO_TR
        - SAP
        - SG_BR
        - SK_FS
        - UK_VAT
        - USPS
        - US_AK_BER
        - US_CO_BER
        - US_EDU
        - US_FL_BER
        - US_IO_BER
        - US_LA_BER
        - US_NY_BER
        - US_OR_BER
        - US_SEC
        - US_SF_BER
        - US_WA_BER
        - VIES
        - WIKIDATA
      x-enumDescriptions:
        AR_NRC: Argentina - National Registry of Companies
        AT_CR: Austria - Company Register
        AT_FON: Austria - Financial Online
        AU_BR: Australia - Business Register
        BR_RF: Brazil - Receita Federal
        BZST: Germany - Federal Central Tax Office
        CA_CR: Canada - Company Register
        CDQ_AA: CDQ - Address Augmentation
        CDQ_BANKPOOL: CDQ - Bank Pool
        CDQ_CRS: CDQ - Company Register Service
        CDQ_CTRY: CDQ - Country Service
        CDQ_IDS: CDQ - Identification Service
        CDQ_LF: CDQ - Legal Form Service
        CDQ_POOL: CDQ - Pool
        CH_MEDREG: Switzerland - Medical Register
        CH_UIDR: Switzerland - UID Register
        CX_BPN: CDQ - Business Partner Network
        CX_POOL: CDQ - Pool
        CZ_REE: Czech Republic - Register of Economic Entities
        DE_RC: Germany - Company Register
        DK_CR: Denmark - Company Register
        DNB: Dun & Bradstreet
        DNB_LINKAGE_LNKELI: Dun & Bradstreet - Linkage - Linkage Eligibility
        DNB_MASTER_DATA_BASIC: Dun & Bradstreet - Master Data - Basic
        DNB_MASTER_DATA_EXTENDED: Dun & Bradstreet - Master Data - Extended
        EE_CR: Estonia - Company Register
        FR_RC: France - Company Register
        GB_EAW_CR: United Kingdom - Companies House
        GEON: Geonames
        GMAPS: Google Maps
        GOOGLEPLACES: Google Places
        GTRANSLATE: Google Translate
        HERE: Here
        HK_CR: Hong Kong - Company Register
        IE_CR: Ireland - Company Register
        IL_CR: Israel - Company Register
        IRS: Internal Revenue Service
        JP_CR: Japan - Company Register
        LEI: Legal Entity Identifier
        NL_BR: Netherlands - Business Register
        NZ_CR: New Zealand - Company Register
        OSM: OpenStreetMap
        ORGANIZATION: Organization
        PL_NOBR: Poland - National Official Business Register
        RO_TR: Romania - Trade Register
        SAP: SAP
        SG_BR: Singapore - Business Register
        SK_FS: Slovakia - Financial Statements
        UK_VAT: United Kingdom - VAT Register
        USPS: United States Postal Service
        US_AK_BER: United States - Alaska - Business Entity Register
        US_CO_BER: United States - Colorado - Business Entity Register
        US_EDU: United States - Education
        US_FL_BER: United States - Florida - Business Entity Register
        US_IO_BER: United States - Iowa - Business Entity Register
        US_LA_BER: United States - Louisiana - Business Entity Register
        US_NY_BER: United States - New York - Business Entity Register
        US_OR_BER: United States - Oregon - Business Entity Register
        US_SEC: United States - Securities and Exchange Commission
        US_SF_BER: United States - South Dakota - Business Entity Register
        US_WA_BER: United States - Washington - Business Entity Register
        VIES: VIES
        WIKIDATA: Wikidata
    LookupFeaturesPage:
      type: object
      description: Page of lookup features.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          description: List of lookup features.
          items:
            $ref: '#/components/schemas/LookupFeatureSearchResult'
    FetchFeaturesPage:
      type: object
      description: Page of fetch features.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          description: List of fetch features.
          items:
            $ref: '#/components/schemas/FetchFeatureSearchResult'
    LookupFeatureSearchResult:
      type: object
      description: Lookup feature.
      properties:
        technicalKey:
          $ref: '#/components/schemas/LookupFeatureTechnicalKey'
    FetchFeatureSearchResult:
      type: object
      description: Fetch feature.
      properties:
        technicalKey:
          $ref: '#/components/schemas/FetchFeatureTechnicalKey'
    CurationFeaturesPage:
      type: object
      description: Page of curation features.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          description: List of curation features.
          items:
            $ref: '#/components/schemas/CurationFeatureSearchResult'
    CurationFeatureSearchResult:
      type: object
      description: Curation feature.
      properties:
        technicalKey:
          $ref: '#/components/schemas/CurationFeatureTechnicalKey'
    CurationProfilesPage:
      type: object
      description: Page of curation profiles
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          items:
            $ref: '#/components/schemas/CurationProfileSearchResult'
    CurationProfileSearchResult:
      type: object
      description: Curation profile.
      properties:
        features:
          type: array
          description: List of curation features.
          items:
            $ref: '#/components/schemas/CurationFeatureSearchResult'
        technicalKey:
          $ref: '#/components/schemas/CurationProfileTechnicalKey'
    BusinessPartnerExternalId:
      type: string
      description: >-
        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.
    JsonObject:
      type: string
      description: Object provided in plain JSON format.
      example: '{ "key" : "value"}'
      additionalProperties: true
    NameTypeUrl:
      type: string
      description: >-
        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
    NameTypeName:
      type: string
      description: Display label for the Name Type.
      example: Local Name
    NameTypeTechnicalKey:
      type: string
      description: Technical Keys of the Name Type.
      example: LOCAL
    NameValue:
      type: string
      description: The actual name.
      example: Corporate Data Quality AG
    NameShortName:
      type: string
      description: The abbreviated variant of a company's full name.
      example: CDQ AG
    LanguageName:
      type: string
      description: ISO 639-1 name of language.
      example: German
    LanguageTechnicalKey:
      type: string
      description: ISO 639-1 two-letter code of languages.
      example: DE
    LegalFormName:
      type: string
      description: Display of the Legal Form.
      example: Aktiengesellschaft
    LegalFormUrl:
      type: string
      description: >-
        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
    LegalFormTechnicalKey:
      type: string
      description: >-
        Technical Key of a Legal Form. Descriptions of below enums contain
        `Country Scope`, `International Name` and `Main Abraviation`.
      example: DE_9866
    schemas-Language:
      type: object
      description: Naming of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    LegalFormMainAbbreviation:
      type: string
      description: >-
        The primary abbreviation of a legal form, i.e. the most commonly used
        abbreviation in a country.
      example: AG
    LegalFormCdlElfCode:
      deprecated: true
      type: string
      description: An unique identifier for CDL managed Legal Forms.
      example: AG
    LegalFormCategoryName:
      type: string
      maxLength: 40
      description: Descriptive display name of the Legal Form Category.
      example: Limited Liability Company
    LegalFormCategoryUrl:
      type: string
      description: >-
        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
    IdentifierTypeUrl:
      type: string
      description: >-
        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
    IdentifierTypeName:
      type: string
      description: Display label for the Identifier.
      example: CH_VAT_ID
    IdentifierTypeTechnicalKey:
      type: string
      description: Technical key of the type of the Identifier.
      example: CH_VAT_ID
    IdentifierValue:
      type: string
      description: Value of the identifier.
      example: CHE-218.608.886 HR/MWST
    IssuingBodyName:
      type: string
      description: Preferred display label for an Issuing Body.
      example: Amtsgericht Aachen
    IssuingBodyTechnicalKey:
      description: Technical key of the Issuing Body.
      example: Amtsgericht Aachen
      type: string
    IdentifierStatusName:
      type: string
      description: Display label for the Identifier Status Name.
      example: ACTIVE
    IdentifierStatusTechnicalKey:
      type: string
      description: Technical key of the Identifier Status.
      example: ACTIVE
    BusinessPartnerCategoryName:
      type: string
      description: Display name of the Business Partner Category Name.
      example: Hotel
    BusinessPartnerCategoryUrl:
      type: string
      description: >-
        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
    BusinessPartnerCategoryTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Category.
      example: HOTEL
    BusinessPartnerStatusTypeName:
      type: string
      description: Display name of the Business Partner Status.
      example: In Liquidation
    BusinessPartnerStatusTypeUrl:
      type: string
      description: >-
        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
    BusinessPartnerStatusTypeTechnicalKey:
      type: string
      description: Technical Key of the Business Parter Status.
      example: IN_LIQUIDATION
    BusinessPartnerStatusOfficialDenotation:
      type: string
      description: The status as provided by an official register.
      example: Good Standing
    BusinessPartnerStatusValidFrom:
      type: string
      description: >-
        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-10-14T07:32:29Z'
    BusinessPartnerStatusValidUntil:
      type: string
      description: >-
        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-10-14T07:32:29Z'
    ClassificationValue:
      type: string
      description: A textual description of the Classification.
      example: Manufacture of pesticides and other agrochemical products.
    ClassificationCode:
      type: string
      description: Code that classifies the business partner.
      example: 20.20Z
    ClassificationTypeName:
      type: string
      description: Display label for the Classification Type.
      example: NAF 2003
    ClassificationTypeUrl:
      type: string
      description: >-
        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
    ClassificationTypeTechnicalKey:
      type: string
      description: TechnicalKey for the Classification Type.
      example: NAF 2003
    PhoneNumberCountryPrefix:
      type: string
      description: The country prefix of a phone number.
      example: '+41'
    PhoneNumberNumber:
      type: string
      description: The complete phone number without any country prefixes.
      example: 71 571 10 40
    PhoneNumberTypeName:
      type: string
      description: Display label for a Phone Number Type Name.
      example: FAX
    PhoneNumberTypeUrl:
      type: string
      description: >-
        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
    PhoneNumberTypeTechnicalKey:
      type: string
      description: Technical Keys of the PhoneNumber.
      example: FAX
    PhoneNumberValue:
      type: string
      description: The actual complete phone number incl. country prefix.
      example: +41 71 571 10 40
    WebsiteUrl:
      type: string
      description: The actual company website URL.
      example: https://cdq.com
    WebsiteTypeName:
      type: string
      description: Display label for a Website Type Name
      example: Corporate Website
    WebsiteTypeUrl:
      type: string
      description: >-
        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
    WebsiteTypeTechnicalKey:
      type: string
      description: Technical Keys of the Website Type Name.
      example: WEBSITE_TYPE_CORPORATE
    ContactEmailValue:
      type: string
      description: Value of the email address of the Business Partner.
      example: developer-portal@cdq.com
    BusinessPartnerTypeName:
      type: string
      description: Display name of the Business Partner Type Name.
      example: Legal Entity
    BusinessPartnerTypeUrl:
      type: string
      description: >-
        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
    BusinessPartnerTypeTechnicalKey:
      type: string
      description: Technical key of the Business Partner Type.
      example: LEGAL_ENTITY
    BusinessPartnerRelationStartedAt:
      type: string
      description: Describe when this relationship was first established.
      example: '2025-10-14T07:32:29Z'
    BusinessPartnerRelationEndedAt:
      type: string
      description: Describe when this relationship ended.
      example: '2025-10-14T07:32:29Z'
    BusinessPartnerRelationTypeName:
      type: string
      description: Display name of the Business Partner Relation Type.
      example: Commercial ultimate
    BusinessPartnerRelationTypeTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Relation Type.
      example: COMMERCIAL_ULTIMATE
    BusinessPartnerRelationClassName:
      type: string
      description: Display name of the Business Partner Relation Class.
      example: CDQ Hierarchy
    BusinessPartnerRelationClassTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Relation Class.
      example: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
    BusinessPartnerStorageDataSourceId:
      type: string
      description: Unique identifier for a Data Source of the Storage.
      example: 648824a691d8d2503d65103e
    AddressExternalId:
      type: string
      description: >-
        ID the address has in the external system where the record originates
        from.
      example: '1'
    CharacterSetName:
      type: string
      description: >-
        Name of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: International
    CharacterSetTechnicalKey:
      type: string
      description: >-
        Technical key of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: INTERNATIONAL
    AddressIdentifyingNameValue:
      type: string
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      example: John Doe
    CareOfValue:
      type: string
      description: Value of the CareOf.
      example: CDQ GmbH c/o Product Department
    AddressContextValue:
      type: string
      description: Value of the Address Context.
      example: Production hall 7, Storage field 8.
    CountryShortName:
      type: string
      description: Country code (ISO 3166-1 alpha-2).
      example: CH
    CountryValue:
      type: string
      description: Country name (ISO 3166-1 alpha-2).
      example: Switzerland
    AdministrativeAreaValue:
      type: string
      description: >-
        Name of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: Sankt Gallen
    AdministrativeAreaFipsCode:
      type: string
      description: >-
        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
    AdministrativeAreaShortName:
      type: string
      description: >-
        Abbreviation for the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: SG
    AdministrativeAreaTypeName:
      type: string
      description: Display label for the Administrative Area Type.
      example: COUNTY
    AdministrativeAreaTypeUrl:
      type: string
      description: >-
        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
    AdministrativeAreaTypeTechnicalKey:
      type: string
      description: Technical key of the Administrative Area.
      example: COUNTY
    PostCodeValue:
      type: string
      description: Effective [post code](https://meta.cdq.com/Address/post_code).
      example: '9000'
    PostCodeTypeName:
      type: string
      description: Display label for the Post Code Type.
      example: Regular
    PostCodeTypeUrl:
      type: string
      description: >-
        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
    PostCodeTypeTechnicalKey:
      type: string
      description: Technical key of the Post Code.
      example: REGULAR
    LocalityTypeName:
      type: string
      description: Display label for the Locality Type.
      example: City
    LocalityTypeUrl:
      type: string
      description: >-
        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
    LocalityTypeTechnicalKey:
      type: string
      description: Technical Key of the Locality Type.
      example: CITY
    LocalityShortName:
      type: string
      description: Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
      example: St. Gallen
    LocalityValue:
      type: string
      description: Name of the [Locality](https://meta.cdq.com/Address/locality).
      example: Sankt Gallen
    ThoroughfareTypeName:
      type: string
      description: Display label for the Thoroughfare Type Name.
      example: Industrial zone
    ThoroughfareTypeUrl:
      type: string
      description: >-
        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
    ThoroughfareTypeTechnicalKey:
      type: string
      description: Technical key of the Thoroughfare Type.
      example: INDUSTRIAL_ZONE
    ThoroughfareShortName:
      type: string
      description: >-
        Abbreviation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: Lukasstr. 4
    ThoroughfareNumber:
      type: string
      description: Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: '4'
    ThoroughfareValue:
      type: string
      description: >-
        Comprehensive designation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the
        thoroughfare type such as Street, or Rue.
      example: Lukasstraße 4
    ThoroughfareName:
      type: string
      description: >-
        Pure name of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising
        the thoroughfare type such as Street, or Rue.
      example: Lukasstraße
    ThoroughfareDirection:
      type: string
      description: >-
        Direction of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: 221-bis Baker Street, North
    PremiseValue:
      type: string
      description: The actual value of a Premise in the language of the address.
      example: Lukasstraße 4
    PremiseShortName:
      type: string
      description: Abbreviation of the Premise.
      example: Lukasstr. 4
    PremiseNumber:
      type: string
      description: Number of the Premise.
      example: '4'
    PremiseTypeName:
      type: string
      description: Display label for the Premise Type.
      example: Factory
    PremiseTypeUrl:
      type: string
      description: >-
        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
    PremiseTypeTechnicalKey:
      type: string
      description: Technical key of the Premise Type.
      example: FACTORY
    PostalDeliveryPointTypeName:
      type: string
      description: Display label for the Postal Delivery Point Type.
      example: Mailbox
    PostalDeliveryPointTypeUrl:
      type: string
      description: >-
        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
    PostalDeliveryPointTypeTechnicalKey:
      type: string
      description: Technical key of the Postal Delivery Point.
      example: MAILBOX
    PostalDeliveryPointShortName:
      type: string
      description: >-
        Stort name of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: St Gallen, Postfach 460
    PostalDeliveryPointNumber:
      type: string
      description: >-
        Number of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: '460'
    PostalDeliveryPointValue:
      type: string
      description: >-
        Value of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: Postfach
    GeographicCoordinatesLatitude:
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
      type: number
      format: double
    GeographicCoordinatesLongitude:
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
      type: number
      format: double
    AddressTypeName:
      type: string
      description: Display label for the Address Type.
      example: Legal Address
    AddressTypeUrl:
      type: string
      description: >-
        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
    AddressTypeTechnicalKey:
      type: string
      description: Technical key of the Address Type.
      example: LEGAL_ADDRESS
    HttpStatusCode:
      type: integer
      description: RFC 7231 status code for this error.
      example: '400'
    HttpStatusTechnicalKey:
      type: string
      description: Technical key describing the status or error
      example: OK
    StatusDetailsMessageId:
      type: integer
      description: 9-digit code which is uniquely identifying a message
      example: 200000004
    StatusDetailsMessage:
      type: string
      description: Human-readable message which may also be presented in user interface.
      example: Business Partner Name is mandatory.
    StatusDetailsTechnicalKey:
      type: string
      description: Technical key to uniquely identify a message.
      example: JOB_FINISHED
    JsonPath:
      type: string
      description: JSONPath as specified by the IETF standard
      example: $.businessPartner.names[0].value
    HttpPath:
      type: string
      description: Requested path which caused this error.
      example: /v2/businesspartners/lookup
    StatusTimestamp:
      type: string
      description: ISO 8601 representation of the timestamp.
      example: '2025-10-14T07:32:29Z'
    BusinessRuleName:
      type: string
      description: Represents business rule name.
      example: >-
        Identifier unknown (European value added tax identifier (The
        Netherlands))
    BusinessRuleUrl:
      type: string
      description: Represents Data Quality Rule url.
      example: >-
        https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))
    ValidationRuleStatus:
      type: string
      description: The status of a validation rule.
      example: RELEASED
    ViolationLevel:
      type: string
      description: >
        Indicates the criticality of the applied rule. 

        If a data defect was found then user will get `INFO`, `WARNING` or
        `ERROR` level. Otherwise, it will be NO_DEFECT.
      example: INFO
    DataSourceName:
      type: string
      description: Name of the data source.
      example: Receita Federal Brazil
    DataSourceTechnicalKey:
      type: string
      description: Technical key of the data source.
      example: BR_RF
    ComplianceListName:
      type: string
      description: The name of the compliance list.
      example: Seco List «Al-Qaïda»
    ComplianceListTechnicalKey:
      type: string
      description: Technical key for the Compliance List.
      example: INFO4C_SL_1
    BusinessPartnerStorageId:
      type: string
      description: Unique identifier of the Storage.
      example: 72d6900fce6b326088f5d9d91049e3e6
    UpdateTag:
      type: string
      description: >-
        Tags an update summary to allow searching or filtering. The tag has the
        format `<type>_<concept>_<action>`.
      example: IDENTIFIER_ADDED
    UpdateClassificationTechnicalKey:
      type: string
      example: MAJOR
      description: Technical key of an update classification.
    UpdateClassificationReason:
      type: string
      description: Reason why this classification has been applied
      example: The modified post code has deprecated format.
    UpdateActionTechnicalKey:
      type: string
      description: Technical key of an update assessment action.
      example: ADDED
    ProvenanceName:
      type: string
      description: Display Name of the Provenance Name.
      example: VIES
    ProvenanceUrl:
      type: string
      description: >-
        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=
    ProvenanceTechnicalKey:
      type: string
      description: Technical Key of the Provenance Name.
      example: VIES
    ProvenanceCdqId:
      type: string
      description: The ID provided for a linkage with the source by CDQ.
      example: VIES:PL8660001429
    ModifiedAt:
      type: string
      description: Date of modification (ISO 8601-compliant).
      example: '2025-10-14T07:32:29Z'
    JsonRecord:
      description: Custom-representation of a data record
      type: object
      additionalProperties: true
    ProcessingStatusTechnicalKey:
      type: string
      description: Possible technical states of processing.
      example: IN_PROGRESS
    BusinessPartnerTypeTechnicalKeyParam:
      type: string
      description: Technical key of the business partner type.
      example: BP_ADDRESS
      enum:
        - BP_ADDRESS
        - BRAND
        - LEGAL_ENTITY
        - ORGANIZATIONAL_UNIT
        - UNKNOWN
    CountryShortNameParam:
      type: string
      description: Short name of the country.
      example: DE
      enum:
        - AC
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AN
        - AO
        - AP
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BL
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BU
        - BV
        - BW
        - BX
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CP
        - CQ
        - CR
        - CS
        - CT
        - CU
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DD
        - DE
        - DG
        - DJ
        - DK
        - DM
        - DO
        - DY
        - DZ
        - EA
        - EC
        - EE
        - EF
        - EG
        - EH
        - EM
        - EP
        - ER
        - ES
        - ET
        - EU
        - EV
        - EW
        - EZ
        - FI
        - FJ
        - FK
        - FL
        - FM
        - FO
        - FQ
        - FR
        - FX
        - GA
        - GB
        - GC
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - HV
        - IB
        - IC
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IR
        - IS
        - IT
        - JA
        - JE
        - JM
        - JO
        - JP
        - JT
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KP
        - KR
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LF
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MF
        - MG
        - MH
        - MI
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NH
        - NI
        - NL
        - 'NO'
        - NP
        - NQ
        - NR
        - NT
        - NU
        - NZ
        - OA
        - OM
        - PA
        - PC
        - PE
        - PF
        - PG
        - PH
        - PI
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PU
        - PW
        - PY
        - PZ
        - QA
        - RA
        - RB
        - RC
        - RE
        - RH
        - RI
        - RL
        - RM
        - RN
        - RO
        - RP
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SD
        - SE
        - SF
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - SS
        - ST
        - SU
        - SV
        - SX
        - SY
        - SZ
        - TA
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TP
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UK
        - UM
        - UN
        - US
        - UY
        - UZ
        - VA
        - VC
        - VD
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WG
        - WK
        - WL
        - WO
        - WORLD
        - WS
        - WV
        - XI
        - XK
        - YD
        - YE
        - YT
        - YU
        - YV
        - ZA
        - ZM
        - ZR
        - ZW
    ProcessingStatusTechnicalKeyEnum:
      type: string
      description: Possible technical states of processing.
      enum:
        - READY
        - RETRY
        - BLOCKED
        - IN_PROGRESS
      x-enumDescriptions:
        READY: >-
          Processing Log Data processing has finished and result ready to
          consume.
        RETRY: Processing Log Data processing has failed and needs to be retried.
        BLOCKED: Processing Log Data processing is blocked and needs to be resolved.
        IN_PROGRESS: Processing Log Data is being processed.
      example: IN_PROGRESS
    UpdateClassificationTechnicalKeyEnum:
      type: string
      example: MAJOR
      description: Technical key of an update classification.
      enum:
        - CRITICAL
        - REJECTED
        - MAJOR
        - MINOR
        - TRIVIAL
        - CONFIRMED
        - UNCHANGED
      x-enumDescriptions:
        CRITICAL: Critical
        REJECTED: Update has been rejected
        MAJOR: Major change
        MINOR: Minor update
        TRIVIAL: Trivial update
        CONFIRMED: Contents have been confirmed by a data source and not changed
        UNCHANGED: Contents have been not changed
    Limit:
      type: integer
      description: Number of items per page.
      example: '100'
    PageTotal:
      description: Total number of items which can be paged.
      example: '67'
      type: integer
    StartAfter:
      type: string
      description: The ID which is used to read the page.
      example: '5712566172571652'
    NextStartAfter:
      type: string
      description: Provides a value to be used as a startAfter in next page request.
      example: '5712566172571652'
    CreatedBy:
      type: string
      description: Creator of a resource.
      example: '76248934691294444'
    CreatedAt:
      type: string
      description: Date of creation (ISO 8601-compliant).
      example: '2025-10-14T07:32:29Z'
    ExternalIdValue:
      type: string
      description: Value of the ExternalId of the business partner.
      example: '123'
    ConceptName:
      type: string
      description: Display name of the Concept.
      example: Address
    ConceptTechnicalKey:
      type: string
      description: Technical key of the Concept.
      example: ADDRESS
    schemas-CharacterSet:
      type: object
      description: Character set.
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    PropertyName:
      type: string
      description: Name of the property.
      example: Minority Indicator Value
    PropertyTechnicalKey:
      type: string
      description: Technical key of the property.
      example: MINORITY_INDICATOR_VALUE
    PropertyContentSelector:
      type: string
      description: JSON path to the property in the provided JSON object.
      example: $.partnerProfile.minorityIndicator.value
    PropertyContentInstanceSelectorKey:
      type: string
      description: >-
        JSON subpath to the property allowing to select concrete instance of a
        property in the provided JSON object.
      example: type.technicalKey
    PropertyContentInstanceSelectorValue:
      type: string
      description: >-
        Value of a JSON subpath to the property allowing to select concrete
        instance of a property in the provided JSON object.
      example: CH_UID
    PropertyNewContent:
      type: string
      example: AAB
      description: New value after change
    PropertyPreviousContent:
      type: string
      example: AAB
      description: Value before change
    PropertyChangeType:
      type: string
      description: Type of the Property Change Type.
      example: MODIFIED
    PropertyChangeClassification:
      type: string
      example: MAJOR
      description: >
        Gives a user an indicator how "much" the attribute was changed OR how
        important the change was. Allowed values are:
         * `TRIVIAL` - Trivial change
         * `MINOR` - Minor change
         * `MAJOR` - Major change
         * `CRITICAL` - Critical change
    PropertyChangeConfidenceScore:
      type: number
      description: >-
        Confidence score which shows how confident CDQ is about enrichment of
        that property. Calculation dependes on property type, see here for a
        complete description.
      example: '0.0'
      minimum: 0
    PropertyChangeMaxConfidenceScore:
      type: number
      description: >-
        Maximum confidence score which is achievable for this property type.
        Note that the max value will change over time depending on the
        udnerlying algorithm which will be continously improved.
      example: '1.0'
    JobId:
      type: string
      description: Unique identifier of a job.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    JobName:
      type: string
      description: Name of a Job.
      example: Process vendor data.
    JobDescription:
      type: string
      description: Detailed description of a Job.
      example: I started this job to improve quality of our data.
    JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
    JobStatusMessage:
      type: string
      description: Additional information to explain the status.
      example: The job failed because storage is empty.
    JobUser:
      type: string
      description: ID of (human) user or API key.
      example: 742429-234242-4343-232323
    FileResourceUrl:
      type: string
      description: Url of the file resource linking to s3.
      example: customer-upload/user/file.xlsx
    Tag:
      type: string
      description: String describing and identifying a resource.
      example: Reporting
    ConfigurationId:
      type: string
      description: Uniquely identifies a configuration.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    ConfigurationName:
      type: string
      description: Display name for a configuration.
      example: Client configuration.
    WorkspaceId:
      type: string
      description: Uniquely identifying ID of the workspace.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    AddressDataSourceTechnicalKey:
      type: string
      description: Technical key for Address Data Source.
      example: HERE
    AddressDataSourceThreshold:
      type: number
      description: >-
        Threshold for the address data source. The threshold is a value between
        0.0 and 1.0.
      format: double
      minimum: 0
      maximum: 1
      default: '0.0'
      example: '0.4'
    OutputCharsetConcept:
      type: string
      description: Defines concept for output charset.
      example: ADDRESS
    OutputCharsetCharset:
      type: string
      description: Defines type for output charset.
      example: LATIN
    ExternalContextIdentifierTypeTechnicalKey:
      type: string
      description: Technical key for the External Context Identifier Type.
      example: KUNNR
    Page:
      type: integer
      description: Current page number.
      example: '1'
      default: 0
      minimum: 0
    PageSize:
      type: integer
      description: Number of items per page.
      example: '100'
      default: 10
      minimum: 1
      maximum: 1000
    schemas-UpdateTagEnum:
      type: string
      description: >-
        Tags an update summary to allow searching or filtering. The tag has the
        format `<type>_<concept>_<action>`.
      example: IDENTIFIER_ADDED
      enum:
        - BANKRUPTCY_BUSINESS_PARTNER
        - BUSINESS_PARTNER_CATEGORY_ADDED
        - BUSINESS_PARTNER_CATEGORY_MODIFIED
        - BUSINESS_PARTNER_CLASSIFICATION_ADDED
        - BUSINESS_PARTNER_CLASSIFICATION_MODIFIED
        - BUSINESS_PARTNER_STATUS_ADDED
        - BUSINESS_PARTNER_STATUS_MODIFIED
        - BUSINESS_PARTNER_TYPE_ADDED
        - BUSINESS_PARTNER_TYPE_MODIFIED
        - DIRECT_LEGAL_RELATION_ADDED
        - DIRECT_LEGAL_RELATION_MODIFIED
        - DISSOLUTION_BUSINESS_PARTNER
        - DOMESTIC_BRANCH_RELATION_ADDED
        - DOMESTIC_BRANCH_RELATION_MODIFIED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_MODIFIED
        - IDENTIFIER_ADDED
        - IDENTIFIER_HARMONIZED
        - IDENTIFIER_MODIFIED
        - IDENTIFIER_STATUS_ADDED
        - IDENTIFIER_STATUS_MODIFIED
        - IDENTIFIER_VALUE_MODIFIED
        - IN_LIQUIDATION_BUSINESS_PARTNER
        - INACTIVE_BUSINESS_PARTNER
        - INSOLVENCY_BUSINESS_PARTNER
        - INTERNAL_RELATION_ADDED
        - INTERNAL_RELATION_MODIFIED
        - INTERNATIONAL_BRANCH_RELATION_ADDED
        - INTERNATIONAL_BRANCH_RELATION_MODIFIED
        - LEGAL_FORM_ADDED
        - LEGAL_FORM_MODIFIED
        - LEI_DIRECT_PARENT_ADDED
        - LEI_DIRECT_PARENT_MODIFIED
        - LEI_INTERNATIONAL_BRANCH_ADDED
        - LEI_INTERNATIONAL_BRANCH_MODIFIED
        - LEI_ULTIMATE_PARENT_ADDED
        - LEI_ULTIMATE_PARENT_MODIFIED
        - LOCAL_ADDRESS_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LOCAL_ADDRESS_COUNTRY_ADDED
        - LOCAL_ADDRESS_COUNTRY_MODIFIED
        - LOCAL_ADDRESS_GEO_COORDINATES_ADDED
        - LOCAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LOCAL_ADDRESS_LOCALITY_ADDED
        - LOCAL_ADDRESS_LOCALITY_MODIFIED
        - LOCAL_ADDRESS_MODIFIED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LOCAL_ADDRESS_POST_CODE_ADDED
        - LOCAL_ADDRESS_POST_CODE_MODIFIED
        - LOCAL_ADDRESS_PREMISE_ADDED
        - LOCAL_ADDRESS_PREMISE_MODIFIED
        - LOCAL_ADDRESS_THOROUGHFARE_ADDED
        - LOCAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LOCAL_NAME_ADDED
        - LOCAL_NAME_MODIFIED
        - OTHER_NAME_ADDED
        - OTHER_NAME_MODIFIED
        - POST_CODE_HARMONIZED
        - LEGAL_ADDRESS_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LEGAL_ADDRESS_COUNTRY_ADDED
        - LEGAL_ADDRESS_COUNTRY_MODIFIED
        - LEGAL_ADDRESS_GEO_COORDINATES_ADDED
        - LEGAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LEGAL_ADDRESS_LOCALITY_ADDED
        - LEGAL_ADDRESS_LOCALITY_MODIFIED
        - LEGAL_ADDRESS_MODIFIED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LEGAL_ADDRESS_POST_CODE_ADDED
        - LEGAL_ADDRESS_POST_CODE_MODIFIED
        - LEGAL_ADDRESS_PREMISE_ADDED
        - LEGAL_ADDRESS_PREMISE_MODIFIED
        - LEGAL_ADDRESS_THOROUGHFARE_ADDED
        - LEGAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LEGAL_NAME_ADDED
        - LEGAL_NAME_MODIFIED
        - RESTRUCTURING_BUSINESS_PARTNER
        - RELATION_ADDED
        - RELATION_MODIFIED
        - SEED_UPDATE
        - UPDATE_PROPOSAL_INDICATOR
        - VAT_PAYER_STATUS_ADDED
        - VAT_PAYER_STATUS_MODIFIED
        - VAT_REGISTERED_ADDRESS_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - VAT_REGISTERED_ADDRESS_COUNTRY_ADDED
        - VAT_REGISTERED_ADDRESS_COUNTRY_MODIFIED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_ADDED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_MODIFIED
        - VAT_REGISTERED_ADDRESS_LOCALITY_ADDED
        - VAT_REGISTERED_ADDRESS_LOCALITY_MODIFIED
        - VAT_REGISTERED_ADDRESS_MODIFIED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - VAT_REGISTERED_ADDRESS_POST_CODE_ADDED
        - VAT_REGISTERED_ADDRESS_POST_CODE_MODIFIED
        - VAT_REGISTERED_ADDRESS_PREMISE_ADDED
        - VAT_REGISTERED_ADDRESS_PREMISE_MODIFIED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_ADDED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_MODIFIED
        - VAT_REGISTERED_NAME_ADDED
        - VAT_REGISTERED_NAME_MODIFIED
        - VALUE_MODIFIED
    ConceptUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the Business
        Partner [Concepts](https://meta.cdq.com/Business_partner).
      example: https://meta.cdq.com/Business_partner
    PropertyContent:
      type: string
      description: The current content of the property of the provided JSON.
      example: DE12345678
    PropertyUrl:
      type: string
      description: External documentation URL for this property.
      example: http://meta.cdq.com/Business_Partner/Identifier_Value
    MinorityIndicatorValue:
      type: string
      description: >-
        The actual value of the minority indicator, representing the minority
        group.
      example: Social enterprise
  parameters:
    usernameHeaderParam:
      name: X-Credential-Username
      description: >
        Username that is passed as header parameter with the name
        X-Credential-Username.

        The header can take form of:
          * username (e.g. "lukaszmichta")
          * user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
      in: header
      required: false
      schema:
        type: string
        example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
    startAfterQueryParam:
      name: startAfter
      description: >
        Start after the provided pagination ID. Leave empty for the first
        query. 

        The response will contain a property `nextStartAfter`, which needs to be
        used for any subsequent queries until nextStartAfter is empty. 

        See <a
        href='https://developer.cdq.com/documentation/developer-guidelines/#pagination'>CDQ
        - Developer Guidelines</a>.
      in: query
      required: false
      schema:
        type: string
        example: NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
    limitQueryParam:
      name: limit
      description: Number of items to be returned on the page.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 500
        example: '100'
    limitQueryMax100Param:
      name: limit
      description: >
        Define the maximum page size of the response.         

        See also <a
        href='https://developer.cdq.com/documentation/developer-guidelines/#pagination'>CDQ
        - Developer Guidelines</a>.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 100
        example: '100'
    configurationId:
      in: path
      name: configurationId
      description: ID of the configuration.
      required: true
      schema:
        type: string
        example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    configurationVersion:
      in: path
      name: version
      required: true
      description: Version number of the configuration.
      schema:
        type: integer
        example: 1
