openapi: 3.0.0
info:
  version: '3'
  title: Data Curation API
  description: >-
    This API provides services to curate and enrich Business Partner and address
    data.
servers:
  - description: Production
    url: https://api.cdq.com/data-curation/rest
    x-cdq-soap-url: https://api.corporate-data-league.ch/data-curation/soap/v3
security:
  - apiKey: []
tags:
  - name: Batch Curation
    description: Everything about Batch Curation
  - name: Business Partners
    description: Everything about Business Partners
externalDocs:
  description: Address Curation
  url: https://meta.cdq.com/Address_curation
paths:
  /v3/businesspartners/curate:
    post:
      x-wsdl: false
      summary: Curate Business Partner
      description: |
        Analyze and improve the quality of data through a curation process.

        Curate Business Partner or address.
      tags:
        - Business Partners
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurationRequest'
            examples:
              curateCDQ:
                summary: Curate CDQ with standard profile
                value:
                  businessPartner:
                    names:
                      - value: CDQ Poland Sp. z o.o.
                        type:
                          technicalKey: INTERNATIONAL
                    addresses:
                      - country:
                          shortName: PL
              curateOneFeatureActive:
                summary: Curate with only one feature on
                value:
                  businessPartner:
                    addresses:
                      - country:
                          shortName: PL
                        thoroughfares:
                          - value: ul. Legnicka 27, Wroclaw
                  profile: FEATURES_OFF
                  featuresOn:
                    - PARSE_ADDRESS
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationResult'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v3/curationlogs/{storageId}/results:
    get:
      x-wsdl: false
      tags:
        - Processing Logs
      summary: List Processing Log Results
      description: >
        Retrieves latest data curation results persisted in Processing Log.


        Data is populated only when [Data
        Monitor](https://developer.cdq.com/reference-docs/data-exchange/V4/tag/Business-Partner-Storages/#tag/Business-Partner-Storages/paths/~1v2~1storages~1{storageId}~1datamonitors/post)
        is configured for provided storage.
      parameters:
        - name: storageId
          in: path
          description: Business Partner Storage ID.
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageId'
        - name: businessPartnerId
          in: query
          description: Business Partner IDs.
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: dataSourceId
          in: query
          description: Business Partner Data Source ID.
          required: false
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: externalId
          in: query
          description: Business Partner External IDs.
          required: false
          schema:
            type: array
            description: List of Business Partner External IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: processingStatusTechnicalKey
          in: query
          description: Processing status technical key.
          required: false
          schema:
            $ref: '#/components/schemas/ProcessingStatusTechnicalKeyEnum'
        - name: startAfter
          in: query
          description: Used to retrieve the next page of results.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - name: limit
          in: query
          description: >-
            Number of results that should be fetched. Maximum 100 results can be
            returned in one page.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            format: int32
            default: 100
            example: '50'
        - name: from
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result since when
            data was created.
          required: false
          schema:
            type: string
            example: '2025-09-12T14:57:38Z'
        - name: to
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result until when
            data was created.
          required: false
          schema:
            type: string
            example: '2025-09-12T14:57:38Z'
        - name: featuresOn
          in: query
          description: Features to be activated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProcessingLogResultsReadFeatureEnum'
        - name: featuresOff
          in: query
          description: Features to be deactivated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProcessingLogResultsReadFeatureEnum'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationProcessingLogResultPage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /curationjobs:
    post:
      x-wsdl: true
      tags:
        - Batch Curation
      summary: Start Curation Job
      description: Start a batch curation job on a given storage.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurationJobRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationJob'
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/400_BadRequest'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /curationjobs/{id}:
    get:
      x-wsdl: true
      tags:
        - Batch Curation
      summary: Poll Curation Job
      description: >
        After you have started a curation job, you will receive a job id in the
        response. {
          'id' : `<ID>`
        } Use this ID to poll for the status of the job using this endpoint.
        Once the status is FINISHED, you can download the results.
      parameters:
        - name: id
          in: path
          description: ID of the Data Curation job.
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /features:
    get:
      tags:
        - Configuration
      summary: List Available Features
      description: >-
        Allows users to retrieve a list of all the available features that can
        be used for data curation.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationFeaturePage'
  /profiles:
    get:
      tags:
        - Configuration
      summary: List Available Profiles
      description: >-
        Allows users to retrieve a list of all the available Profiles with its
        features that can be used for data curation.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfilePage'
  /outputcharsets/concepts:
    get:
      tags:
        - Configuration
      summary: List Available Concepts
      description: >-
        Allows users to retrieve a list of all the available concepts that can
        be used for data curation.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationConceptPage'
  /outputcharsets/charactersets:
    get:
      tags:
        - Configuration
      summary: List Available Character Sets
      description: >-
        Allows users to retrieve a list of all the available character sets that
        can be used for data curation.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationCharacterSetPage'
  /v2/businesspartners/goldenrecords/generate:
    post:
      x-wsdl: false
      summary: Generate Golden Record
      description: Generate a Golden Record from a list of provided Business Partners.
      tags:
        - Business Partners
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleGoldenRecordGenerationResult'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleGoldenRecordGenerationRequest'
            examples:
              generateGoldenRecord:
                summary: Generate golden record from candidates
                value:
                  countryShortName: AT
                  profile: STANDARD
                  candidates:
                    - businessPartner:
                        status:
                          type:
                            name: inactive
                            url: url92
                            technicalKey: technicalKey92
                        identifiers:
                          - value: 078038M
                            type:
                              technicalKey: BR_ID_AT
                        names:
                          - value: ENGEL AUSTRIA GmbH
                        addresses:
                          - country:
                              value: AT
                            localities:
                              - value: Schwertberg
                            thoroughfares:
                              - value: Ludwig-Engel-Str. 1
                      matchingProfile:
                        matchingScores:
                          overall:
                            classification:
                              technicalKey: FULL_MATCH
                              name: Full Match
                            value: 99.0869848239641
                            explanation: explanation23
                          businessPartner:
                            classification:
                              technicalKey: technicalKey23
                              name: name23
                            value: 44.0869848239641
                            explanation: explanation23
                          address:
                            classification:
                              technicalKey: technicalKey23
                              name: name23
                            value: 44.0869848239641
                            explanation: explanation23
                      dataSource:
                        name: name23
                        technicalKey: AT.CR
        required: true
  /v2/curationjobs/{id}/results:
    get:
      x-wsdl: true
      tags:
        - Batch Curation
      summary: List Business Partner Curation Results
      description: Retrieves curation results for particular job.
      parameters:
        - name: id
          in: path
          description: ID of the Data Curation job.
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
        - $ref: '#/components/parameters/businessPartnerId'
        - name: startAfter
          in: query
          description: Used to retrieve the next page of results.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - name: limit
          in: query
          description: >-
            Number of results that should be fetched. Maximum 100 results can be
            returned in one page.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            format: int32
            default: 100
            example: '50'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurationJobResultPage'
        '400':
          description: Unauthorized or missing
  /configurations/businesspartnercuration:
    get:
      tags:
        - Configuration
      summary: List User Configurations
      description: Allows user to retrieve their configurations for their workspace.
      parameters:
        - in: query
          name: startAfter
          description: Used to retrieve the next page of results.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - in: query
          name: limit
          description: >-
            Number of items per page. Maximum 100 items can be returned in one
            page.
          required: false
          schema:
            $ref: '#/components/schemas/Limit'
        - in: query
          name: defaultConfiguration
          required: false
          description: >-
            Limit search to configurations with provided default flag value. If
            left empty, all configurations will be returned.
          schema:
            type: boolean
            example: true
            default: null
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationPage'
  /configurations/businesspartnercuration/{configurationId}:
    parameters:
      - $ref: '#/components/parameters/configurationId'
    get:
      tags:
        - Configuration
      summary: Read Users Configuration
      description: Allows users to retrieve their configuration for their organization.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerCurationConfiguration'
    put:
      tags:
        - Configuration
      summary: Update Configuration
      description: Allows users to update their configuration for their organization.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerCurationUpdate'
      responses:
        '200':
          description: Configuration updated successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerCurationConfiguration'
        '400':
          description: Bad Request.
    delete:
      tags:
        - Configuration
      summary: Delete Configuration
      description: Allows to delete their configuration for their organization.
      parameters: []
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerCurationConfiguration'
        '400':
          description: Bad Request.
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
  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
          items:
            $ref: '#/components/schemas/StatusDetails'
        path:
          $ref: '#/components/schemas/HttpPath'
        timestamp:
          $ref: '#/components/schemas/StatusTimestamp'
    StatusTimestamp:
      type: string
      description: ISO 8601 representation of the timestamp.
      example: '2025-09-12T14:57:38Z'
    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'
    ProcessingLogResultsReadFeatureEnum:
      type: string
      description: Processing log results read feature.
      example: FILTER_BY_ENABLED_AUGMENTATION_MONITORS
      enum:
        - FILTER_BY_ENABLED_AUGMENTATION_MONITORS
        - NUMBER_OF_TOTAL
        - SHOW_LOOKUP_RESULTS
      x-enumDescription:
        FILTER_BY_ENABLED_AUGMENTATION_MONITORS: >-
          Filters out results by enabled, existing data sources of augmentation
          monitors. By default, turned on.
        NUMBER_OF_TOTAL: >-
          Allows to switch fetching the total number of results to improve
          performance. By default, turned off.
        SHOW_LOOKUP_RESULTS: >-
          Allows to include lookup results in the response. By default, turned
          off.
    CurationProcessingLogResultPage:
      type: object
      description: Page of Curation Processing Log Results with search results.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        from:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result since when
            data was created.
          example: '2025-09-12T14:57:38Z'
        to:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result until when
            data was created.
          example: '2025-09-12T14:57:38Z'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Curation Processing Log Results.
          items:
            $ref: '#/components/schemas/CurationProcessingLogResult'
    CurationProcessingLogResult:
      type: object
      description: Allows to search for and find specific Curation Processing Log Results.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        addressId:
          type: string
          description: ID of the address in the Storage or Data Mirror.
          example: '1'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        addressExternalId:
          $ref: '#/components/schemas/AddressExternalId'
        status:
          type: string
          default: OK
          description: OK or FAILED.
          example: OK
        message:
          type: string
          description: Additional explanations for status - especially for the FAILED case.
          example: >-
            Input data is not representing a Business Partner. Reason: Unallowed
            pattern detected.
        curationResult:
          $ref: '#/components/schemas/CurationResult'
        executedAt:
          $ref: '#/components/schemas/ExecutedAt'
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatus'
    ProcessingStatus:
      type: object
      description: Processing status.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProcessingStatusTechnicalKey'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    CurationResult:
      type: object
      description: Curation result for a Business Partner or address.
      properties:
        updatedBusinessPartner:
          $ref: '#/components/schemas/UpdatedBusinessPartner'
        originalBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        settings:
          $ref: '#/components/schemas/Settings'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
    UpdatedBusinessPartner:
      type: object
      description: >-
        A Business Partner which contains also contextual information about
        applied updates.
      properties:
        summary:
          $ref: '#/components/schemas/UpdateSummary'
        names:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedName'
        legalForm:
          $ref: '#/components/schemas/UpdatedLegalForm'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedIdentifier'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/UpdatedBusinessPartnerStatus'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedAddress'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        formattedSapRecord:
          $ref: '#/components/schemas/FormattedSapRecord'
        types:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerType'
    FormattedSapRecord:
      description: >-
        Provides Business Partner and address information in a data structure
        similar to SAP Business Partner table BUT000 and SAP Business Address
        Services table ADRC. Field names are equal or very similar to SAP field
        names in order to simplify field mapping. Data for name and street
        fields is already split into chunks of max. 35 characters.
      type: object
      properties:
        name1:
          $ref: '#/components/schemas/FormattedSapRecordName1'
        name2:
          $ref: '#/components/schemas/FormattedSapRecordName2'
        name3:
          $ref: '#/components/schemas/FormattedSapRecordName3'
        name4:
          $ref: '#/components/schemas/FormattedSapRecordName4'
        nameCo:
          $ref: '#/components/schemas/FormattedSapRecordNameCo'
        legalEntity:
          $ref: '#/components/schemas/FormattedSapRecordLegalEntity'
        legalForm:
          $ref: '#/components/schemas/FormattedSapRecordLegalForm'
        indSector:
          $ref: '#/components/schemas/FormattedSapRecordIndSector'
        indSectorCode:
          $ref: '#/components/schemas/FormattedSapRecordIndSectorCode'
        emailAddress:
          $ref: '#/components/schemas/FormattedSapRecordEmailAddress'
        narp:
          $ref: '#/components/schemas/FormattedSapRecordNarp'
        stceg:
          $ref: '#/components/schemas/FormattedSapRecordStceg'
        stcd1:
          $ref: '#/components/schemas/FormattedSapRecordStcd1'
        stcd2:
          $ref: '#/components/schemas/FormattedSapRecordStcd2'
        stcd3:
          $ref: '#/components/schemas/FormattedSapRecordStcd3'
        stcd4:
          $ref: '#/components/schemas/FormattedSapRecordStcd4'
        stcd5:
          $ref: '#/components/schemas/FormattedSapRecordStcd5'
        url:
          $ref: '#/components/schemas/FormattedSapRecordUrl'
        telNumber:
          $ref: '#/components/schemas/FormattedSapRecordTelNumber'
        country:
          $ref: '#/components/schemas/FormattedSapRecordCountry'
        countryCode:
          $ref: '#/components/schemas/FormattedSapRecordCountryCode'
        region:
          $ref: '#/components/schemas/FormattedSapRecordRegion'
        regionCodeSap:
          $ref: '#/components/schemas/FormattedSapRecordRegionCodeSap'
        regionCode:
          $ref: '#/components/schemas/FormattedSapRecordRegionCode'
        county:
          $ref: '#/components/schemas/FormattedSapRecordCounty'
        countyCode:
          $ref: '#/components/schemas/FormattedSapRecordCountyCode'
        township:
          $ref: '#/components/schemas/FormattedSapRecordTownship'
        townshipCode:
          $ref: '#/components/schemas/FormattedSapRecordTownshipCode'
        city:
          $ref: '#/components/schemas/FormattedSapRecordCity'
        district:
          $ref: '#/components/schemas/FormattedSapRecordDistrict'
        postalCode:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode'
        postalCode3:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode3'
        street1:
          $ref: '#/components/schemas/FormattedSapRecordStreet1'
        street2:
          $ref: '#/components/schemas/FormattedSapRecordStreet2'
        street5:
          $ref: '#/components/schemas/FormattedSapRecordStreet5'
        houseNum:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum'
        houseNum2:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum2'
        building:
          $ref: '#/components/schemas/FormattedSapRecordBuilding'
        floor:
          $ref: '#/components/schemas/FormattedSapRecordFloor'
        roomnumber:
          $ref: '#/components/schemas/FormattedSapRecordRoomnumber'
        poBoxCountry:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCountry'
        poBoxCity:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCity'
        poBoxPostalCode:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxPostalCode'
        poBox:
          $ref: '#/components/schemas/FormattedSapRecordPoBox'
        latitude:
          $ref: '#/components/schemas/FormattedSapRecordLatitude'
        longitude:
          $ref: '#/components/schemas/FormattedSapRecordLongitude'
    UpdateSummary:
      type: object
      description: Summarizes the applied updates for easy consumption.
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/UpdateTag'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
    UpdateAssessment:
      type: object
      description: Details and assessment of an applied update.
      required:
        - action
        - classification
        - provenances
      properties:
        action:
          $ref: '#/components/schemas/UpdateAction'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
        provenances:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Provenance'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        tags:
          type: array
          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.
      required:
        - technicalKey
      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'
        subscribers:
          $ref: '#/components/schemas/ProvenanceSubscribers'
        subscribed:
          $ref: '#/components/schemas/ProvenanceSubscribed'
        lastUpdatedAt:
          $ref: '#/components/schemas/ProvenanceLastUpdatedAt'
        lastSyncAt:
          $ref: '#/components/schemas/ProvenanceLastSyncAt'
    ProvenanceSubscribers:
      type: integer
      description: Number of Provenance Subscribers.
      example: '7'
    ProvenanceSubscribed:
      type: boolean
      description: Is Provenance Subscribed.
      example: 'true'
    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'
    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'
    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'
    UpdatedBusinessPartnerType:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerType'
        - type: object
          description: Update assessment for a Business Partner status.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerTypeUpdateAssessment'
    BusinessPartnerTypeUpdateAssessment:
      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/BusinessPartnerType'
    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'
    AddressUpdateAssessment:
      type: object
      description: Update assessment for an address.
      properties:
        provenances:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Provenance'
        curationAssessment:
          $ref: '#/components/schemas/AddressCurationAssessment'
        requestSimilarity:
          $ref: '#/components/schemas/Similarity'
    Similarity:
      type: object
      description: Contains similarity values for Business Partner after Curation.
      properties:
        value:
          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'
    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
    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
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/UpdatedCountry'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedAdministrativeArea'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPostCode'
        localities:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedLocality'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedThoroughfare'
        premises:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPremise'
        postalDeliveryPoints:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/UpdatedGeographicCoordinates'
        types:
          type: array
          items:
            $ref: '#/components/schemas/AddressType'
    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'
    CurationRequest:
      type: object
      description: Parameters for a Business Partner and address Curation.
      required:
        - businessPartner
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartnerParam'
        outputLanguage:
          $ref: '#/components/schemas/LanguageRequest'
        addressDataSources:
          $ref: '#/components/schemas/AddressDataSourcesParam'
        profile:
          $ref: '#/components/schemas/CurationProfileParam'
        featuresOn:
          type: array
          description: List of feature to be activated.
          items:
            $ref: '#/components/schemas/CurationFeatureParam'
        featuresOff:
          type: array
          description: List of feature to be deactivated.
          items:
            $ref: '#/components/schemas/CurationFeatureParam'
        outputCharsets:
          type: array
          description: List of Output Character Sets.
          items:
            $ref: '#/components/schemas/OutputCharsetParam'
        addressCurationLevelThreshold:
          $ref: '#/components/schemas/CurationLevelParam'
        configurationId:
          $ref: '#/components/schemas/DataCurationConfigurationId'
        numberSeparator:
          $ref: '#/components/schemas/NumberSeparator'
        inputAddressConceptsIgnored:
          $ref: '#/components/schemas/InputAddressConceptsIgnored'
    LanguageRequest:
      type: object
      description: Expected language of curation result, compliant to ISO 639-1.
      properties:
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    BusinessPartner:
      type: object
      description: >-
        An organization which has some degree of involvement with another
        organization's business dealings. Typically, a company's Business
        Partner is another company in the role of a customer, a supplier, a
        vendor, or a service provider. In the CDL context, the Business Partner
        is the core managed entity. A Business Partner is globally uniquely
        identifiable by a CDL ID, and all managed information such as addresses,
        documents, and hierarchies is linked to a Business Partner. Additional
        documentation can be found
        [here](https://meta.cdq.com/Business_partner).
      properties:
        names:
          type: array
          description: List of Names.
          items:
            $ref: '#/components/schemas/Name'
        legalForm:
          $ref: '#/components/schemas/LegalForm'
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/Identifier'
        categories:
          type: array
          description: List of Categories.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        addresses:
          type: array
          description: List of Addresses.
          items:
            $ref: '#/components/schemas/Address'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        types:
          type: array
          description: List of Business Partner Types.
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
    PartnerProfile:
      type: object
      description: >-
        A Business Partner profile contains important information about a
        company, such as its classification, tags, contact details, or minority
        indicator. Additional documentation can be found
        [here](https://meta.cdq.com/Partner_profile).
      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'
    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). Additional documentation can be
        found [here](https://meta.cdq.com/Address).
      properties:
        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 Address Contexts.
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
        postCodes:
          type: array
          description: List of additional Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
        premises:
          type: array
          description: List of Premises.
          items:
            $ref: '#/components/schemas/Premise'
        postalDeliveryPoints:
          type: array
          description: List of Postal Delivery Points.
          items:
            $ref: '#/components/schemas/PostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        types:
          type: array
          description: List of Address Types.
          items:
            $ref: '#/components/schemas/AddressType'
    BusinessPartnerParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner).
      type: object
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        names:
          type: array
          items:
            $ref: '#/components/schemas/NameParam'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/IdentifierParam'
        addresses:
          type: array
          maxItems: 1
          items:
            $ref: '#/components/schemas/AddressParam'
    NameParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/name).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/NameValue'
        type:
          $ref: '#/components/schemas/NameTypeParam'
    NameTypeParam:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Business_partner/name/type).
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/NameTypeTechnicalKey'
    IdentifierParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/identifier).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/IdentifierValue'
        type:
          $ref: '#/components/schemas/IdentifierTypeParam'
        issuingBody:
          $ref: '#/components/schemas/IssuingBodyParam'
    IdentifierTypeParam:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Category:Business_partner/identifier/type).
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/IdentifierTypeTechnicalKey'
    IdentifierTypeTechnicalKey:
      type: string
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Category:Business_partner/identifier/type)
        under Technical Key property.
      example: BVD_ID
      enum:
        - ABN_AU
        - ACN_AU
        - AD_FI_CODE
        - AE_BRN
        - AE_CCN
        - AE_VAT
        - AL_BRN
        - AL_TRN
        - AM_BRN
        - AM_COC
        - AM_GGN
        - AM_TRN
        - ANID
        - AO_BRN
        - AO_TIN
        - AR_AGENT_NO
        - AR_CUIL
        - AR_CUIT
        - AR_IATAIN
        - AR_NIP
        - AR_PGRTN
        - AR_SEN
        - AR_UTIK
        - AT_ARN
        - AZ_BRN
        - AZ_CCN
        - AZ_GGN
        - AZ_TRN
        - AZ_VAT
        - BAN_US_SF
        - BA_BRN
        - BA_COC
        - BA_GGN
        - BA_TRN
        - BD_CIN
        - BD_TIN
        - BE_ARN
        - BE_BUN
        - BE_ENT_NO
        - BE_VAT_ID
        - BF_BRN
        - BG_BRN
        - BG_CCN
        - BG_GGN
        - BG_SEC_ID
        - BG_TAX_ID
        - BG_UID
        - BH_BRN
        - BH_CCN
        - BH_VAT
        - BIC
        - BIC_FI
        - BI_BRN
        - BI_US_AK
        - BI_US_CO
        - BI_US_CT
        - BJ_BRN
        - BN_CA
        - BN_TIN
        - BO_NIT
        - BR_CNPJ
        - BR_CPF
        - BR_GRT
        - BR_ID_AT
        - BR_SUF
        - BR_TAX_MUN
        - BR_TAX_STATE
        - BT_TIN
        - BVD_ID
        - BW_BRN
        - BY_BRN
        - BY_COC
        - BY_GGN
        - BY_TRN
        - CA_CNUM
        - CDN_US_FL
        - CDQ_GR
        - CDQ_ID
        - CDQ_POOL_ID
        - CF_BRN
        - CG_BRN
        - CH_EHRA_ID
        - CH_ESTV_ID
        - CH_OID
        - CH_UID
        - CH_VAT_ID
        - CI_BRN
        - CI_CCN
        - CI_TRN
        - CID_NY_US
        - CIF_ES
        - CIK_US
        - CL_RUT
        - CM_BRN
        - CM_CCN
        - CM_TRN
        - CN_BRN
        - CN_IE
        - CN_JP
        - CN_US_IA
        - CN_VAT_15
        - CO_NIT
        - CR_CPJ
        - CREFO_ID
        - CRIF_ID
        - CS_BRN
        - CS_CCN
        - CS_GGN
        - CS_TRN
        - CUSIP_9
        - CVR_DK
        - CV_BRN
        - CX_BPN
        - CX_POOL_ID
        - CY_BRN
        - CY_CCN
        - CY_GGN
        - CY_TRN
        - CZ_CBN
        - CZ_DIC
        - CZ_ICO
        - CZ_TRN
        - DE_BNUM
        - DE_TAX_ID
        - DJ_BRN
        - DO_RNC
        - DUNS_ID
        - DUNS_ID_CU
        - DUNS_ID_DU
        - DUNS_ID_GU
        - DZ_BRN
        - DZ_CCN
        - DZ_TRN
        - EC_RUC
        - EE_BRN
        - EE_COC
        - EE_GGN
        - EE_TRN
        - EG_BRN
        - EG_CCN
        - EG_TRN
        - EID_US_VA
        - EN_US_CA
        - EORI
        - ES_IRUS
        - ES_NIE
        - ES_NIF
        - ET_BRN
        - EU_CUST_REF
        - EU_ID
        - EU_VAT_ID
        - EU_VAT_ID_AT
        - EU_VAT_ID_BE
        - EU_VAT_ID_BG
        - EU_VAT_ID_CY
        - EU_VAT_ID_CZ
        - EU_VAT_ID_DE
        - EU_VAT_ID_DK
        - EU_VAT_ID_EE
        - EU_VAT_ID_EL
        - EU_VAT_ID_ES
        - EU_VAT_ID_FI
        - EU_VAT_ID_FR
        - EU_VAT_ID_HR
        - EU_VAT_ID_HU
        - EU_VAT_ID_IE
        - EU_VAT_ID_IT
        - EU_VAT_ID_LT
        - EU_VAT_ID_LU
        - EU_VAT_ID_LV
        - EU_VAT_ID_MT
        - EU_VAT_ID_NL
        - EU_VAT_ID_PL
        - EU_VAT_ID_PT
        - EU_VAT_ID_RO
        - EU_VAT_ID_SE
        - EU_VAT_ID_SI
        - EU_VAT_ID_SK
        - EU_VAT_ID_UK
        - EU_VAT_ID_XI
        - FID_US_WY
        - FK_BRN
        - FO_FIN
        - FO_FPN
        - FO_FVN
        - FRC_RO
        - FR_ANA
        - FR_CCN
        - FR_RNA
        - FR_SIREN
        - FR_SIRET
        - GA_BRN
        - GA_CCN
        - GA_TRN
        - GE_BRN
        - GE_COC
        - GE_GGN
        - GE_TRN
        - GH_BRN
        - GH_TRN
        - GI_BRN
        - GI_CCN
        - GI_GGN
        - GI_TRN
        - GL_CPR
        - GL_GER
        - GM_BRN
        - GN_BRN
        - GQ_BRN
        - GR_AFM
        - GR_BRN
        - GR_COC
        - GR_GGN
        - GR_PERS_ID
        - GR_TRN
        - GS1_GLN
        - GST_CA
        - GST_MY
        - GT_NIT
        - GW_BRN
        - HK_BRN
        - HK_CRN
        - HN_NTRN
        - HR_BRN
        - HR_COC
        - HR_COMP_ID
        - HR_GGN
        - HR_OIB
        - HST_CA
        - HU_CRN
        - HU_TAX_ID
        - HU_TIN
        - ID_CRN
        - ID_GST
        - ID_NL_OB
        - ID_TIN
        - ID_TVA_FR
        - ID_TVA_LU
        - ID_UTR
        - ID_VAT_UK
        - IL_VAT
        - IN_CIN
        - IN_GST
        - IN_IEC
        - IN_LBT
        - IN_LLPIN
        - IN_PAN
        - IN_SERVICE_TAX_ID
        - IN_SRN
        - IN_UDYAM
        - IPEDS_ID
        - IQ_BRN
        - IR_BRN
        - IR_CCN
        - IS_BRN
        - IS_CCN
        - IS_GGN
        - IS_IIN
        - IS_VAT
        - ISIN
        - IT_FISC_ID
        - IT_REA
        - IT_VAT_ID
        - JE_SSN
        - JE_TRN
        - JM_TIN
        - JO_BRN
        - JO_CCN
        - JO_GST
        - JP_JCT
        - KE_BRN
        - KE_PIN
        - KE_VAT
        - KG_BRN
        - KG_COC
        - KG_GGN
        - KG_TRN
        - KH_BRN
        - KH_TIN
        - KM_BRN
        - KR_CORP_ID
        - KR_CRBN
        - KR_RES_ID
        - KR_VAT_ID
        - KVK_NL
        - KW_BRN
        - KW_CCN
        - KZ_IIN
        - LA_TIN
        - LB_BRN
        - LB_CCN
        - LEI_ID
        - LI_BRN
        - LID_US_CH
        - LIN_US_LA
        - LIN_US_SF
        - LK_TIN
        - LR_BRN
        - LS_BRN
        - LT_BRN
        - LT_COC
        - LT_GGN
        - LT_TRN
        - LU_RCS
        - LV_COC
        - LV_BRN
        - LV_GGN
        - LV_TRN
        - MA_CCN
        - MA_ICE
        - MA_TRN
        - MD_BRN
        - MD_COC
        - MD_GGN
        - MD_TRN
        - ME_GGN
        - ME_TRN
        - MG_BRN
        - MK_BRN
        - MK_TRN
        - ML_BRN
        - MM_TIN
        - MO_CRBRN
        - MR_BRN
        - MT_BRN
        - MT_COC
        - MT_GGN
        - MT_TRN
        - MU_BRN
        - MU_TRN
        - MV_TIN
        - MW_BRN
        - MX_CURP
        - MX_RFC
        - MY_BRN
        - MY_SST
        - MZ_BRN
        - NA_BRN
        - NE_BRN
        - NG_BRN
        - NG_TIN
        - NL_BSN
        - NL_SI_ID
        - NL_TAX_ID
        - NO_ORGID
        - NP_TIN
        - NZ_BN
        - NZ_GST
        - OM_BRN
        - OM_CCN
        - OPENCORP_ID
        - ORBIS_ID
        - PA_RUC
        - PE_RUC
        - PEPPOL_ID
        - PH_TAX_ID
        - PIC_ID
        - PK_CNIC
        - PK_TIN
        - PL_KRS
        - PL_NIP
        - PL_REG
        - PL_TAX_ID
        - PST_CA
        - PST_CA_MB
        - PST_CA_SK
        - PT_NIF
        - PT_NIPC
        - PY_RUC
        - QA_BRN
        - QA_CCN
        - QST_CA
        - RIAD
        - RN_US_OR
        - RO_BRN
        - RO_CCN
        - RO_GGN
        - RO_TAX_ID
        - RSIN_NL
        - RS_BRN
        - RS_PIB
        - RU_BRN
        - RU_CCN
        - RU_GGN
        - RU_INN
        - RU_KPP
        - RU_OFK
        - RU_OKPO
        - RU_TRN
        - RW_BRN
        - SA_BRN
        - SA_CCN
        - SA_VAT
        - SC_BRN
        - SC_CCN
        - SCI_ID
        - SD_BRN
        - SE_ORG_ID
        - SG_GST
        - SG_UEN
        - SH_BRN
        - SI_BRN
        - SI_CCN
        - SI_GGN
        - SI_TAX_ID
        - SK_DIC
        - SK_ICO
        - SK_TRN
        - SL_BRN
        - SM_COE
        - SM_SSI
        - SN_BRN
        - SN_CCN
        - SN_TRN
        - SPCOMP_ID
        - SPOR_LOC_ID
        - SPOR_ORG_ID
        - SV_NIT
        - SY_BRN
        - SY_CCN
        - SZ_BRN
        - TD_BRN
        - TG_BRN
        - TH_PERS_ID
        - TH_TAX_ID
        - TIN_EG
        - TJ_BRN
        - TJ_COC
        - TJ_GGN
        - TJ_TRN
        - TL_TIN
        - TM_BRN
        - TM_COC
        - TM_GGN
        - TM_TRN
        - TN_TVA
        - TR_BRN
        - TR_CCN
        - TR_GGN
        - TR_TAX_ID
        - TR_TAX_OFFICE_ID
        - TRN_RO
        - TT_TIN
        - TW_BRN
        - TW_GUID
        - TW_TAX_ID
        - TZ_BRN
        - UA_BRN
        - UA_CCN
        - UA_GGN
        - UA_TAX_ID
        - UA_USREOU
        - UA_VAT_ID
        - UBI_US_WS
        - UG_BRN
        - UI_US_SF
        - UK_DRV_LIC
        - UK_IN_ID
        - UK_NHS_ID
        - UK_RCN
        - US_BRN
        - US_DEA
        - US_EMPL_ID
        - US_FTIN
        - US_NPI
        - US_SAM_ID
        - US_SEC_ID
        - UY_UTR
        - UZ_BRN
        - UZ_COC
        - UZ_GGN
        - UZ_TRN
        - VAT_ID_NO
        - VEN_NL
        - VE_NIT
        - VE_RIF
        - VN_BRN
        - VN_TIN
        - VN_VAT
        - WR_BTRN
        - WR_CAGE
        - WR_CINS
        - WR_CUSIP
        - XK_BRN
        - XK_GGN
        - YE_BRN
        - YE_CCN
        - ZA_CRN
        - ZA_TIN
        - ZA_VAT
        - ZER_CDQ_ID
        - ZM_BRN
        - ZM_TRN
        - ZM_VAT
        - ZW_BRN
        - ZW_COC
        - ZW_GGN
        - ZW_TRN
    IssuingBodyParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/identifier/issuing_body).
      type: object
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
    AddressParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address).
      type: object
      properties:
        country:
          $ref: '#/components/schemas/CountryParam'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/AdministrativeAreaParam'
        localities:
          type: array
          items:
            $ref: '#/components/schemas/LocalityParam'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/PostCodeParam'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/ThoroughfareParam'
        premises:
          type: array
          items:
            $ref: '#/components/schemas/PremiseParam'
        postalDeliveryPoints:
          type: array
          maxItems: 1
          items:
            $ref: '#/components/schemas/PostalDeliveryPointParam'
        careOf:
          $ref: '#/components/schemas/CareOfParam'
        contexts:
          type: array
          items:
            $ref: '#/components/schemas/AddressContextParam'
    BusinessPartnerRequest:
      type: object
      description: >-
        An organization which has some degree of involvement with another
        organization's business dealings. Typically, a company's Business
        Partner is another company in the role of a customer, a supplier, a
        vendor, or a service provider. In the CDL context, the Business Partner
        is the core managed entity. A Business Partner is globally uniquely
        identifiable by a CDL ID, and all managed information such as addresses,
        documents, and hierarchies is linked to a Business Partner. Additional
        documentation can be found
        [here](https://meta.cdq.com/Business_partner).
      properties:
        names:
          type: array
          description: List of Names.
          items:
            $ref: '#/components/schemas/NameRequest'
        legalForm:
          $ref: '#/components/schemas/LegalFormRequest'
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/IdentifierRequest'
        categories:
          type: array
          description: List of Categories.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategoryRequest'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatusRequest'
        addresses:
          type: array
          description: List of Addresses.
          items:
            $ref: '#/components/schemas/AddressRequest'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/PartnerProfileRequest'
        types:
          type: array
          description: List of Business Partner Types.
          items:
            $ref: '#/components/schemas/BusinessPartnerTypeRequest'
    AddressRequest:
      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). Additional documentation can be
        found [here](https://meta.cdq.com/Address).
      properties:
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingNameRequest'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        careOf:
          $ref: '#/components/schemas/CareOfRequest'
        contexts:
          type: array
          description: List of Address Contexts.
          items:
            $ref: '#/components/schemas/AddressContextRequest'
        country:
          $ref: '#/components/schemas/CountryRequest'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeAreaRequest'
        postCodes:
          type: array
          description: List of additional Post Codes.
          items:
            $ref: '#/components/schemas/PostCodeRequest'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/LocalityRequest'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/ThoroughfareRequest'
        premises:
          type: array
          description: List of Premises.
          items:
            $ref: '#/components/schemas/PremiseRequest'
        postalDeliveryPoints:
          type: array
          description: List of Postal Delivery Points.
          items:
            $ref: '#/components/schemas/PostalDeliveryPointRequest'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinatesRequest'
        types:
          type: array
          description: List of Address Types.
          items:
            $ref: '#/components/schemas/AddressTypeRequest'
    PartnerProfileRequest:
      type: object
      description: >-
        A Business Partner profile contains important information about a
        company, such as its classification, tags, contact details, or minority
        indicator. Additional documentation can be found
        [here](https://meta.cdq.com/Partner_profile).
      properties:
        classifications:
          type: array
          description: List of Classifications.
          items:
            $ref: '#/components/schemas/ClassificationRequest'
        phoneNumbers:
          type: array
          description: List of Phone Numbers.
          items:
            $ref: '#/components/schemas/PhoneNumberRequest'
        websites:
          type: array
          description: List of Websites.
          items:
            $ref: '#/components/schemas/WebsiteRequest'
        contactEmails:
          type: array
          description: List of Contact Emails.
          items:
            $ref: '#/components/schemas/ContactEmailRequest'
    DebugInfo:
      type: object
      description: >-
        This is just a reference implementation how to structure external
        service responses. Usually this should be hidden behind a feature
        `SHOW_DEBUG_INFO`.
      properties:
        externalServiceResponses:
          type: array
          description: List of external service responses.
          items:
            $ref: '#/components/schemas/ExternalServiceResponse'
        lookupServiceResponses:
          type: array
          description: List of external service responses.
          items:
            $ref: '#/components/schemas/LookupServiceResponse'
    LookupServiceResponse:
      type: object
      description: Pair of single request and response from lookup service.
      properties:
        request:
          type: object
          description: Lookup request.
          $ref: '#/components/schemas/BusinessPartnerLookupRequest'
        result:
          type: object
          description: Lookup response.
          $ref: '#/components/schemas/BusinessPartnerLookupResult'
    BusinessPartnerLookupRequest:
      type: object
      description: Specify the parameters for a Business Partner lookup.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        dataSources:
          type: array
          description: Filter data sources used during lookup
          items:
            type: string
            description: Data source to be used for the lookup.
            example: VIES
        matchingThreshold:
          type: number
          format: double
          description: Matching threshold for the lookup. Default 0.5.
          example: '0.8'
        maxCandidates:
          type: integer
          description: Maximum number of candidates to be returned. Default 10.
          example: '20'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        page:
          type: integer
          description: Current page number.
          example: '1'
        limit:
          type: integer
          description: Number of items per page.
          example: '100'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        featuresOn:
          type: array
          description: The features to be activated.
          items:
            type: string
            description: The feature to be activated.
            example: ACTIVATE_DATASOURCE_BVD
        featuresOff:
          type: array
          description: The features to be deactivated.
          items:
            type: string
            description: The feature to be deactivated.
            example: ACTIVATE_DATASOURCE_BVD
    BusinessPartnerLookupResult:
      type: object
      description: >-
        Display results of Business Partner Lookup with the Golden Record and
        other records with na matching score.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        totals:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        values:
          type: array
          description: List of Business Partner Lookup Matches.
          items:
            $ref: '#/components/schemas/BusinessPartnerLookupMatch'
    BusinessPartnerLookupMatch:
      type: object
      description: Business Partner found in the Data Mirror with the match.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        lastSyncAt:
          type: string
          description: Date of last synchronization
          example: '2025-09-12T14:57:38Z'
        lastUpdatedAt:
          type: string
          description: Date of last business partner modification
          example: '2025-09-12T14:57:38Z'
        dataSourceName:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        storageDataSource:
          type: string
          description: Identifier of Data Source in data Mirror Storage.
          example: 648824a691d8d2503d65103e
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    CurationChunkWorkerResult:
      type: object
      description: Result of curation chunk.
      properties:
        numberOfProcessed:
          $ref: '#/components/schemas/CurationChunkWorkerResultNumberOfProcessed'
        numberOfFailed:
          $ref: '#/components/schemas/CurationChunkWorkerResultNumberOfFailed'
        numberOfProcessingLogTasksSent:
          $ref: >-
            #/components/schemas/CurationChunkWorkerResultNumberOfProcessingLogTasksSent
        results:
          type: array
          description: List of curation results.
          items:
            $ref: '#/components/schemas/BusinessPartnerCurationWorkerResult'
    CurationChunkWorkerResultNumberOfProcessingLogTasksSent:
      type: integer
      description: Number of processing logs tasks sent.
      example: '1'
    BusinessPartnerCurationWorkerResult:
      type: object
      description: Result of curation for Business Partner.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        businessPartnerExternalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
        results:
          type: array
          description: List of curation results.
          items:
            $ref: '#/components/schemas/CurationWorkerResult'
    CurationWorkerResult:
      type: object
      description: Result of curation for Business Partner.
      properties:
        status:
          $ref: '#/components/schemas/SingleCurationWorkerResultStatus'
        message:
          $ref: '#/components/schemas/SingleCurationWorkerResultMessage'
        result:
          $ref: '#/components/schemas/SingleCurationResult'
        resultV3:
          $ref: '#/components/schemas/CurationResult'
        addressId:
          $ref: '#/components/schemas/SingleCurationWorkerResultAddressId'
    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
    BusinessPartnerTypeIdentificationRequestEcho:
      type: object
      description: Original request parameters together with evaluated effective features.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartnerRequest'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerTypeIdentificationFeature'
        featuresOff:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerTypeIdentificationFeature'
        effectiveFeatures:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerTypeIdentificationFeature'
    BusinessPartnerTypeIdentificationFeature:
      type: string
      description: Features to be used during identification of Business Partner type.
      example: KEYWORD_ANALYSIS
    BusinessPartnerTypeIdentificationFeatureParam:
      type: string
      description: Features to be used during identification of Business Partner type.
      example: KEYWORD_ANALYSIS
      enum:
        - KEYWORD_ANALYSIS
        - REFERENCE_SOURCES
        - USE_CDQ_POOL
        - RELATIONS
      x-enumDEscriptions:
        KEYWORD_ANALYSIS: Allows keyword analysis.
        REFERENCE_SOURCES: Allows reference sources.
        USE_CDQ_POOL: Allows usage of CDQ.POOL.
        RELATIONS: Shows relations.
    BusinessPartnerTypeIdentificationLegalEntity:
      type: object
      description: Legal entity identified for the Business Partner.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    CurationJob:
      type: object
      description: Task dedicated to the curation of the provided data set.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          type: string
          description: Name of a Job.
          example: Process vendor data
        description:
          type: string
          description: Detailed description of a Job.
          example: I started this job to improve quality of our data.
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceIds:
          type: array
          description: List of Data Source IDs.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        countryShortNames:
          type: array
          description: List of country short names.
          items:
            $ref: '#/components/schemas/CountryShortName'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        user:
          $ref: '#/components/schemas/JobUser'
        progress:
          $ref: '#/components/schemas/JobProgress'
        attachments:
          type: array
          description: List of attachments.
          items:
            $ref: '#/components/schemas/FileResource'
        reportsJobId:
          type: string
          description: Unique identifier of a Reports Job.
          example: 6be92567-4327-4463-813f-a8c990410d79
        reportsConfiguration:
          $ref: '#/components/schemas/DataCurationReportsConfiguration'
    CurationJobRequest:
      type: object
      description: Parameters for a curation job.
      required:
        - storageId
      properties:
        name:
          type: string
          maxLength: 50
          description: Name of a Job.
          example: Process vendor data.
        description:
          type: string
          maxLength: 200
          description: Detailed description of a Job.
          example: I started this job to improve quality of our data.
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceIds:
          type: array
          description: >-
            If set, only the records that belong to the data sources identified
            by these IDs are processed. By default, all records of the storage
            (means from all data sources) are processed (considering other
            filters).
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        countryShortNames:
          description: >-
            If set, only the records that belong to the countries identified by
            these short names are processed. By default, all records of the
            storage (means from all countries) are processed (considering other
            filters).
          type: array
          items:
            $ref: '#/components/schemas/CountryShortName'
        workers:
          type: integer
          description: >-
            Number of workers to be used for the job. By default, the number of
            workers is 1.
          example: '3'
          default: 1
          minimum: 1
          maximum: 8
        profile:
          $ref: '#/components/schemas/Profile'
        language:
          $ref: '#/components/schemas/LanguageTechnicalKey'
        outputCharsets:
          type: array
          description: List of Output Character Sets.
          items:
            $ref: '#/components/schemas/OutputCharset'
        addressDataSources:
          $ref: '#/components/schemas/AddressDataSources'
        addressCurationLevelThreshold:
          $ref: '#/components/schemas/CurationLevel'
        fields:
          description: Fields are deprecated.
          type: array
          items:
            type: string
            description: Fields are deprecated.
            example: formattedAddress
            enum:
              - formattedAddress
              - legalAddress
              - companyStatus
              - classifications
            x-enumDEscriptions:
              formattedAddress: Deprecated.
              legalAddress: Deprecated.
              companyStatus: Deprecated.
              classifications: Deprecated.
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/Feature'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/Feature'
        optionSkipReport:
          type: boolean
          deprecated: true
          description: >-
            Deprecated and not usable. For a report creation, use
            `reportsRequest`.
          default: true
          example: 'true'
        reportsRequest:
          $ref: '#/components/schemas/DataCurationReportsRequest'
        configurationId:
          $ref: '#/components/schemas/DataCurationConfigurationId'
    ProcessingLogId:
      type: string
      description: >-
        Processing log ID to which data should be upserted by worker. In the
        future, when processing log ID is provided, data is not upserted to job
        result storage.
      example: CURATION_LOG
    ProcessingLogTriggerType:
      type: string
      description: >-
        Processing log trigger type determining way how the curation item or job
        has been triggered.
      example: INITIALIZED
    DataCurationConfigurationId:
      type: string
      description: >
        Configuration ID used to set up curation. If provided, those parameters
        will be affected.

        If any of them is provided in this request, will overwrite one from
        configuration (except for features which are merged):

        * `outputLanguageTechnicalKey`

        * `addressDataSources`

        * `profile`

        * `featuresOn`

        * `featuresOff`

        * `outputCharsets`

        * `addressCurationLevelThreshold`

        * `numberSeparator`

        * `inputAddressConceptsIgnored`
      example: 5c5356588c72a028c448adbd
    JobTag:
      type: string
      description: String describing and identifying a job.
      example: Reporting
      maxLength: 100
    Settings:
      type: object
      description: The effective settings for the request.
      properties:
        enabled:
          type: boolean
          description: Indicates if settings should be used.
          example: 'true'
        dataCurationRules:
          type: array
          description: List of Data Curation Rules.
          items:
            $ref: '#/components/schemas/DataCurationRule'
    BusinessPartnerRequestSimilarity:
      type: object
      description: >
        Contains similarity values for the request. The similarity values are
        calculated based on the similarity of the request to the curated
        Business Partner.
      properties:
        name:
          $ref: '#/components/schemas/Similarity'
        address:
          $ref: '#/components/schemas/Similarity'
    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.
          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/MatchingScores2'
    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:
          type: string
          description: Unique identifier of the external ID.
          example: '123'
        concept:
          $ref: '#/components/schemas/Concept'
        language:
          $ref: '#/components/schemas/schemas-Language'
        characterSet:
          $ref: '#/components/schemas/schemas-CharacterSet'
        type:
          $ref: '#/components/schemas/AddressType'
    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'
    AddressCurationAnalysis:
      type: object
      description: >-
        Process of analyzing and refining address data to ensure accuracy,
        completeness, and standardization.
      properties:
        requestSimilarity:
          $ref: '#/components/schemas/RequestSimilarity'
        curationLevel:
          $ref: '#/components/schemas/CurationLevel'
        accuracyIndicator:
          type: number
          description: Measure used to assess the degree of accuracy in a given context.
          example: '0.9'
        outputLanguage:
          type: string
          description: ISO 639-1 code of requested language of the curation result.
          example: CH
        curationDecision:
          $ref: '#/components/schemas/Decision'
        geographicCoordinatesAccuracy:
          $ref: '#/components/schemas/GeographicCoordinatesAccuracy'
    GeographicCoordinatesAccuracy:
      type: string
      description: |
        Level of accuracy for geo-coordinates. 
        * `THOROUGHFARE_NUMBER`
        * `THOROUGHFARE_VALUE`
        * `LOCALITY`
        * `ADMINISTRATIVE_AREA`
        * `COUNTRY`
      example: LOCALITY
    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
    RequestSimilarity:
      type: object
      description: >-
        Measure of similarity between two requests to find similar content.
        Additional documentation can be found
        [here](https://meta.cdq.com/Address_curation#Request_similarity).
      properties:
        geoCoordinates:
          type: boolean
          description: Indicates if Address is enhanced with geographic coordinates.
          example: 'true'
        locality:
          type: number
          description: Similarity value of localities.
          example: '0.85'
        postCode:
          type: number
          description: Similarity value of postCodes.
          example: '0.85'
        thoroughfare:
          type: number
          description: Similarity value of thoroughfares.
          example: '0.85'
        thoroughfareNumber:
          type: number
          description: Similarity value of thoroughfareNumbers.
          example: '0.85'
        overall:
          type: number
          description: Overall similarity value for an Address.
          example: '0.85'
    Name:
      type: object
      description: 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'
        details:
          type: array
          items:
            $ref: '#/components/schemas/NameDetail'
    NameType:
      type: object
      description: 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/schemas-NameTypeTechnicalKey'
    Identifier:
      type: object
      description: >-
        Identifies a [Business Partner](https://meta.cdq.com/Business_partner)
        in a given context uniquely such as a VAT identification number.
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/identifier).
      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. Allowed types are documented
        [here](https://meta.cdq.com/Category:Business_partner/identifier/type).
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    LegalForm:
      type: object
      description: >-
        Legal Form of a [Business Partner/type/legal
        entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the
        form it takes in the eyes of the law governing it. The legal form of a
        [company](https://meta.cdq.com/Business_partner) is the general type it
        may legally use to identify itself according to the local, regional,
        national, or international law governing it. This is normally reflected
        in the ending abbreviation after the
        [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc.,
        LLC, S.A.).
      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'
    Language:
      type: object
      description: Name of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    LegalFormCategory:
      type: object
      description: Categorization of a Legal Form.
      properties:
        name:
          $ref: '#/components/schemas/LegalFormCategoryName'
        url:
          $ref: '#/components/schemas/LegalFormCategoryUrl'
        shortName:
          $ref: '#/components/schemas/LegalFormCategoryShortName'
        technicalKey:
          $ref: '#/components/schemas/LegalFormCategoryTechnicalKey'
    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'
    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'
    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'
        score:
          $ref: '#/components/schemas/BusinessPartnerCategoryScore'
    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). Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/status).
      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.
        Allowed types are documented
        [here](https://meta.cdq.com/Business_partner/status/type).
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    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'
    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. Additional documentation can
        be found [here](https://meta.cdq.com/Address/locality).
      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). Allowed
        types are documented [here](https://meta.cdq.com/Address/locality/type).
      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. Additional documentation can be found
        [here](https://meta.cdq.com/Address/thoroughfare).
      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. Allowed types are documented
        [here](https://meta.cdq.com/Address/thoroughfare/type).
      properties:
        name:
          $ref: '#/components/schemas/ThoroughfareTypeName'
        url:
          $ref: '#/components/schemas/ThoroughfareTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    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: >-
        Type of the [Administrative
        Area](https://meta.cdq.com/Address/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 a combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality). Additional
        documentation can be found
        [here](https://meta.cdq.com/Address/post_code).
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    PostCodeType:
      type: object
      description: >-
        Type of the Post Code. Allowed types are documented
        [here](https://meta.cdq.com/Address/post_code/type).
      properties:
        name:
          $ref: '#/components/schemas/PostCodeTypeName'
        url:
          $ref: '#/components/schemas/PostCodeTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/schemas-PostCodeTypeTechnicalKey'
    Premise:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sublevels to precisely identify. Additional documentation can be
        found [here](https://meta.cdq.com/Address/premise).
      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. Allowed types are documented
        [here](https://meta.cdq.com/Address/premise/type).
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/schemas-PremiseTypeTechnicalKey'
    PostalDeliveryPoint:
      type: object
      description: >-
        A single mailbox or other place at which postal mail is delivered.
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/postal_delivery_point).
      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.
        Allowed types are documented
        [here](https://meta.cdq.com/Address/postal_delivery_point/type).
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/schemas-PostalDeliveryPointTypeTechnicalKey'
    GeographicCoordinates:
      type: object
      description: >-
        Decimal geographic coordinates (WGS 84 - reference coordinate system).
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/geographic_coordinates).
      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. Allowed types are documented
        [here](https://meta.cdq.com/Address/type).
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    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'
    Profile:
      type: string
      description: >
        Used to configure the curation process. Available wiki documentation for
        profiles:
           * [STANDARD](https://meta.cdq.com/API/Data_Curation_API/Profile/STANDARD)
           * [ADDRESS_ONLY](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_ONLY)
           * [STANDARD_ADDRESS_CURATION_AND_ENRICHMENT](https://meta.cdq.com/API/Data_Curation_API/Profile/STANDARD_ADDRESS_CURATION_AND_ENRICHMENT)
           * [ADDRESS_STANDARDIZATION](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_STANDARDIZATION)
           * [ADDRESS_TRANSLATION](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_TRANSLATION)
           * [BUSINESS_PARTNER_ONLY](https://meta.cdq.com/API/Data_Curation_API/Profile/BUSINESS_PARTNER_ONLY)
           * [FEATURES_OFF](https://meta.cdq.com/API/Data_Curation_API/Profile/FEATURES_OFF)
           * [NATURAL_PERSON_SCREENING](https://meta.cdq.com/API/Data_Curation_API/Profile/NATURAL_PERSON_SCREENING)
           * [PRECURATION](https://meta.cdq.com/API/Data_Curation_API/Profile/PRECURATION)
           * [GOLDEN_RECORD](https://meta.cdq.com/API/Data_Curation_API/Profile/GOLDEN_RECORD)
      example: STANDARD
      enum:
        - STANDARD
        - ADDRESS_ONLY
        - STANDARD_ADDRESS_CURATION_AND_ENRICHMENT
        - ADDRESS_STANDARDIZATION
        - ADDRESS_TRANSLATION
        - BUSINESS_PARTNER_ONLY
        - FEATURES_OFF
        - NATURAL_PERSON_SCREENING
        - PRECURATION
        - GOLDEN_RECORD
      x-enumDescription:
        STANDARD: >-
          Curation process with standard profile is turned on by default. This
          profile consist of most important API toggle features and because of
          that it's recommended for most data curation cases.
        ADDRESS_ONLY: >-
          This profile is recommended, when the goal is to perform the address
          curation of your business partner. Address only consists of the most
          important address API features from the precuration to harmonization
          phase.
        STANDARD_ADDRESS_CURATION_AND_ENRICHMENT: >-
          The Address Curation & Enrichment profile allows for cleansing
          addresses in terms of parsing the given content, identifying reference
          addresses in specifically configured or default address data sources,
          enriching the input based on the reference addresses and additional
          CDQ reference data, and harmonizing the different address components.
        ADDRESS_STANDARDIZATION: >-
          The Address Standardization profile standardizes a given input address
          according to the CDQ standards without considering any reference
          addresses from address data sources. It extracts different address
          components and places them in distinct fields (e.g. a PO Box
          maintained as street is put into a separate PO Box concept), enriches
          address components only based on already provided input (e.g. country
          name is enriched based on a given country code) and harmonizes given
          components (e.g. post code is formatted according to the reference
          standard in a country).
        ADDRESS_TRANSLATION: >-
          Translates only business partner address without any enrichment. There
          is also a possible to transliterate, by turned it on in the curation
          settings.
        BUSINESS_PARTNER_ONLY: >-
          This profile is recommended, when the goal is to perform the curation
          of the business partner name, legal form, identifiers etc. Business
          partner only consists of the most important API features from the
          precuration to harmonization phase.
        FEATURES_OFF: >-
          This profile turns off all API features enabled by default (standard
          profile). It may be used for a test purpose to check the results of
          the curation using single features.
        NATURAL_PERSON_SCREENING: >-
          Identifies Natural Person data based on identifiers, legal forms, and
          known legal entities.
        PRECURATION: >-
          Parses, preprocess and harmonize business partner data without
          additional enrichment.
        GOLDEN_RECORD: >-
          Golden Record curation profile consist of API toggle features used
          during golden record generation and is recommended to be used in Data
          Clinic monitoring.
    Feature:
      type: string
      description: >-
        Features to be used during curation process. For complete description of
        features see [here](https://meta.cdq.com/API/Data_Curation_API).
      example: ENRICH_ADDRESS
      enum:
        - ACTIVATE_DATASOURCE_BVD
        - ACTIVATE_DATASOURCE_DNB
        - ALL_ADDRESS_VERSIONS
        - CAPITALIZE_ADDRESS
        - CONFIRM_IDENTIFIERS
        - DETECT_INDUSTRIAL_ZONE
        - ENABLE_FUZZY_ENRICHMENTS
        - ENABLE_SETTINGS
        - ENABLE_UNALLOWED_NAME_VALUE_VALIDATION
        - ENRICH_ADDRESS
        - ENRICH_ADDRESS_TYPE
        - ENRICH_ADMINISTRATIVE_AREA_ISO
        - ENRICH_CATEGORY
        - ENRICH_CLASSIFICATIONS
        - ENRICH_COMPANY_STATUS
        - ENRICH_GEOGRAPHIC_COORDINATES
        - ENRICH_GOOGLE_PLACES_INFORMATION
        - ENRICH_IDENTIFIERS
        - ENRICH_LEGAL_ADDRESS
        - ENRICH_LOCAL_ADDRESS
        - ENRICH_LEGAL_FORM
        - ENRICH_MINORITY_INDICATOR
        - ENRICH_POST_CODE
        - ENRICH_POST_CODE_TYPE
        - ENRICH_REGISTERED_NAME
        - ENRICH_VAT_REGISTERED_INFORMATION
        - EXTRACT_ADDRESS_CONTEXT
        - EXTRACT_CARE_OF
        - EXTRACT_DOING_BUSINESS_AS
        - EXTRACT_NAME_DETAILS
        - HARMONIZE_IDENTIFIERS
        - HARMONIZE_NAME
        - JOIN_THOROUGHFARE_NUMBER_POSTFIX
        - JOIN_THOROUGHFARE_NUMBER_PREFIX
        - NORMALIZE_ADDRESS
        - NORMALIZE_BUSINESS_PARTNER
        - PARSE_ADDRESS
        - PARSE_LEGAL_FORM
        - PARSE_LEGAL_FORM_WORLDWIDE
        - PARSE_NAMES
        - PREFER_COUNTY
        - PREFER_THOROUGHFARE_NAME
        - PREFER_THOROUGHFARE_SHORTNAME
        - PREPROCESS_ADDRESS
        - PREPROCESS_BUSINESS_PARTNER
        - REMOVE_CONTACT_INFORMATION
        - REMOVE_INVALID_IDENTIFIERS
        - SHARING_PRIMARY
        - SHOW_DEBUG_INFO
        - SHOW_FORMATTED_ADDRESS
        - SHOW_FORMATTED_SAP_RECORD
        - SHOW_SETTINGS
        - STANDARDIZE_REGISTERED_ADDRESS
        - STANDARDIZE_VAT_REGISTERED_ADDRESS
        - TRANSLATE_ADDRESS
        - TRANSLATE_NAMES
        - USE_ADDRESS_INDEX_KR
        - LAB_ALLOW_LONG_LOOKUP_CALLS
        - LAB_QUERY_CLIENT
        - LAB_QUERY_GOOGLE_WITH_COMPANY
        - LAB_QUERY_PELIAS_WITH_COMPANY
        - LAB_USE_GOOGLE_MAPS
        - LAB_USE_LOOKUP_CLASSIFICATION_ONLY
        - LAB_USE_PELIAS
        - LAB_USE_QUEUES
        - USE_LOCALITY_SHORTNAME_REFERENCE
      x-enumDEscriptions:
        ACTIVATE_DATASOURCE_BVD: >-
          Allows to lookup in BVD datasource (e.g. during identifier
          enrichment).
        ACTIVATE_DATASOURCE_DNB: >-
          Allows to lookup in DNB datasource (e.g. during identifier
          enrichment).
        ALL_ADDRESS_VERSIONS: >-
          Curate all address versions instead of the selected via workspace
          settings.
        CAPITALIZE_ADDRESS: Converts all values in the address data to upper case.
        CONFIRM_IDENTIFIERS: Confirm identifiers.
        DETECT_INDUSTRIAL_ZONE: Detect industrial zone.
        ENABLE_FUZZY_ENRICHMENTS: Enable name-based fuzzy enrichments.
        ENABLE_SETTINGS: Apply rules stored in organizational settings during curation.
        ENABLE_UNALLOWED_NAME_VALUE_VALIDATION: >-
          Validates input business partner names against unallowed patterns and
          returns Bad Request in case of invalid name match.
        ENRICH_ADDRESS: Improve address by filling missing fields and improve consistency.
        ENRICH_ADDRESS_TYPE: >-
          Determines address type based on the enriched address. Turns on
          ENRICH_LEGAL_ADDRESS feature.
        ENRICH_ADMINISTRATIVE_AREA_ISO: Enrich administrative areas and ISO 3166-2 region codes and FIPS code.
        ENRICH_CATEGORY: >-
          Enrich a CDQ community standardized business partner category for a
          given entity.
        ENRICH_CLASSIFICATIONS: Enrich industry classification for a given business partner.
        ENRICH_COMPANY_STATUS: Enrich information about the status of a business partner.
        ENRICH_GEOGRAPHIC_COORDINATES: Enriches geo coordinates.
        ENRICH_GOOGLE_PLACES_INFORMATION: >-
          Enriches name local and legal address from Google Places via
          ReferenceData lookup.
        ENRICH_IDENTIFIERS: Enriches identifiers using external data sources.
        ENRICH_LEGAL_ADDRESS: Enriches the legal address using external data sources.
        ENRICH_LOCAL_ADDRESS: Enriches local address in curated Business Partner.
        ENRICH_LEGAL_FORM: Enriches the legal form using the CDQ managed legal forms.
        ENRICH_MINORITY_INDICATOR: >-
          Enriches the minority indicator based on third-party diversity
          information.
        ENRICH_POST_CODE: Enrich the post code.
        ENRICH_POST_CODE_TYPE: Sets type REGULAR to post code type if empty.
        ENRICH_REGISTERED_NAME: >-
          Enrich the name of the business partner as it is provided in an
          official register.
        ENRICH_VAT_REGISTERED_INFORMATION: >-
          Enrich the name and address of the business partner as it is provided
          in an official VAT register.
        EXTRACT_ADDRESS_CONTEXT: Extract address context from a business partner.
        EXTRACT_CARE_OF: Extract care of information from a business partner.
        EXTRACT_DOING_BUSINESS_AS: Extract doing business as name from a business partner.
        EXTRACT_NAME_DETAILS: Extract name details from a business partner.
        HARMONIZE_IDENTIFIERS: Harmonize identifiers.
        HARMONIZE_NAME: Normalize name local by harmonizing its legal form.
        JOIN_THOROUGHFARE_NUMBER_POSTFIX: >-
          Thoroughfare number in curation result is added to thoroughfare value
          as a postfix.
        JOIN_THOROUGHFARE_NUMBER_PREFIX: >-
          Thoroughfare number in curation result is added to thoroughfare value
          as a prefix.
        NORMALIZE_ADDRESS: Normalize address following CDQ standards (i.e. lower/uppercase).
        NORMALIZE_BUSINESS_PARTNER: >-
          Normalize address following CDQ standards (i.e. formatting
          identifiers).
        PARSE_ADDRESS: Harmonize address data by parsing thoroughfare numbers, etc.
        PARSE_LEGAL_FORM: >-
          Detect a valid legalform from a business partner's localName with
          respect to its country code.
        PARSE_LEGAL_FORM_WORLDWIDE: >-
          Detect a valid legalform from a business partner's localName without
          respect to its country code.
        PARSE_NAMES: Remove parts from a given entity's name that are not part of the name.
        PREFER_COUNTY: County will be used as a Region in Administrative Area if found.
        PREFER_THOROUGHFARE_NAME: >-
          Thoroughfare value in curation result is replaced by thoroughfare
          name.
        PREFER_THOROUGHFARE_SHORTNAME: >-
          Thoroughfare value in curation result is replaced by thoroughfare
          shortname.
        PREPROCESS_ADDRESS: >-
          Prepare provided address data for further processing (i.e. trimming
          values).
        PREPROCESS_BUSINESS_PARTNER: >-
          Prepare provided business partner data for further processing (i.e.
          trimming values).
        REMOVE_CONTACT_INFORMATION: Contact information is just removed.
        REMOVE_INVALID_IDENTIFIERS: >-
          Validate Business partner identifiers according to specific rules and
          remove if invalid.
        SHARING_PRIMARY: >-
          Data from sharing pool (CDQ.POOL or CX.POOL if used api key belongs to
          CX workspace) will be taken first during enrichment, even if it is not
          set as primary data source. Egz. CDQ Pool(full match) > VIES(full
          match) > CDQ Pool(maybe match).
        SHOW_DEBUG_INFO: Return filled debug info.
        SHOW_FORMATTED_ADDRESS: Format address in a unified way to curatedAddress#formattedAddress.
        SHOW_FORMATTED_SAP_RECORD: >-
          Format record in a unified way to
          curatedBusinessPartner#formattedSapRecord.
        SHOW_SETTINGS: Return a list of all turned on curation settings.
        STANDARDIZE_REGISTERED_ADDRESS: Standardize registered address.
        STANDARDIZE_VAT_REGISTERED_ADDRESS: Standardize VAT registered address.
        TRANSLATE_ADDRESS: Translate a given address in a specified language.
        TRANSLATE_NAMES: >-
          Enrich the international name using transliteration and translation
          techniques. The target language is English.
        USE_ADDRESS_INDEX_KR: Use South Korean address index for enrichment.
        USE_LOCALITY_SHORTNAME_REFERENCE: Uses Locality Shortname Reference
    JobStatus:
      type: string
      description: Curation Job execution status.
      example: RUNNING
      enum:
        - UNKNOWN
        - CREATED
        - PERSISTED
        - SCHEDULED
        - WAITING
        - RUNNING
        - FINISHED
        - DIED
        - CANCELED
        - FAILED
        - ARCHIVED
      x-enumDescription:
        UNKNOWN: Job becomes in unknown status.
        CREATED: Job has been created.
        PERSISTED: Job metadata been persisted.
        SCHEDULED: Job has been scheduled for execution.
        WAITING: Job is waiting for being scheduled.
        RUNNING: Job is being executed.
        FINISHED: Job has finished.
        DIED: Job has died due to unhandled exceptions.
        CANCELED: Job has been canceled due to invalid input configuration.
        FAILED: Job has failed.
        ARCHIVED: Job has been archived.
    PremiseTypeTechnicalKey:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/premise/type) under Technical Key
        property.
      type: string
      example: BUILDING
      enum:
        - APARTMENT
        - BUILDING
        - DOOR
        - FACTORY
        - HARBOUR
        - INDUSTRIAL_ZONE
        - LEVEL
        - ROOM
        - SQUARE
        - SUITE
        - UNIT
        - WAREHOUSE
      x-enymDescriptions:
        APARTMENT: A distinct flat in the building.
        BUILDING: >-
          A structure (such as a house, hospital, school, etc.) with a roof and
          walls that is used as a place for people to live, work, do activities,
          store things, etc.
        DOOR: A door number in a building/ level of the building.
        FACTORY: >-
          A building or group of buildings where goods are manufactured or
          assembled mainlyby machine.
        HARBOUR: >-
          A body of water where ships, boats and barges seek shelter from stormy
          weather, or are stored for future use.
        INDUSTRIAL_ZONE: >-
          A zone of industrial land where there is a concentration of industry
          and where manufacturing and industrial companies locate their
          factories and plants.
        LEVEL: The floor/story of the building.
        ROOM: A distinct room in a building.
        SQUARE: >-
          A square is a commercial area in a city or town, located at the
          meeting of two or more streets. It is often used as a meeting place
          for people.
        SUITE: >-
          A suite is the location of a business within a shopping mall or office
          building. The suite's number also serves as a sort of address within
          an address for purposes of mail delivery and pickup.
        UNIT: Commercial units such as in shopping centers.
        WAREHOUSE: >-
          A warehouse is a commercial building for storage of goods. Warehouses
          are used by manufacturers, importers, exporters, wholesalers,
          transport businesses, customs, etc. They are usually large plain
          buildings in industrial areas of cities, towns and villages.
    PostalDeliveryPointTypeTechnicalKey:
      type: string
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/postal_delivery_point/type) under
        Technical Key property.
      example: INTERURBAN_DELIVERY_POINT
      enum:
        - INTERURBAN_DELIVERY_POINT
        - MAIL_STATION
        - MAILBOX
        - POST_OFFICE_BOX
      x-enumDescription:
        INTERURBAN_DELIVERY_POINT: >-
          A delivery point which is specified by a kilometre information along a
          road. In most cases there exist no house number for such locations.
        MAIL_STATION: >-
          A mail station is typically a specific location within a larger postal
          facility where mail is sorted, processed, and distributed.
        MAILBOX: A location at an address where the post is delivered to.
        POST_OFFICE_BOX: >-
          A uniquely addressable lockable box located on the premises of a post
          office station.
    NameTypeTechnicalKey:
      type: string
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Business_partner/name/type) under Technical
        Key property.
      example: LOCAL
      enum:
        - ACRONYM
        - DOING_BUSINESS_AS
        - INTERNATIONAL
        - LOCAL
        - OTHER
        - REGISTERED
        - REGISTERED_NAME
        - TRANSLITERATED
        - TRANSLITERATED_NAME
        - VAT_REGISTERED
        - VAT_REGISTERED_NAME
      x-enumDescriptions:
        ACRONYM: >-
          An acronym commonly used for a business partner. It differs from
          shortnames (e.g. shortname of the name local) by being an
          interchangeable name for the company, whereas shortnames may just be
          composed of abbreviated terms of a name.
        DOING_BUSINESS_AS: >-
          Alternative names a company employs for doing business (very common in
          USA), otherwise Trading Name.
        INTERNATIONAL: >-
          The international version (i.e. English name, Latin characters without
          accents) of the [Local
          Name](https://meta.cdq.com/Business_partner/name/type/local) of a
          [Business Partner](https://meta.cdq.com/Business_partner).
        LOCAL: >-
          The business partner name identifies a business partner in a given
          context, e.g. a country or region. Per definition it uses local
          language and character sets. It is constructed by CDL algorithms based
          on the registered name (if available). This name may differ from the
          registered name, e.g. when the registered name does not comprise a
          legal form the CDL standardizes the name by extending it with the main
          abbreviation of a given legal form (e.g. by the business register). If
          e.g. no registered name is available then this name might be generated
          from a CDL member's input name by removing contact information,
          additional doing business as names, or additional contexts (e.g.
          department or business unit names) and harmonizing an identified legal
          form (e.g. replacing GmbH+CO.KG. with the main abbreviation defined in
          the reference data:\ GmbH & Co. KG).
        OTHER: >-
          Any other alternative name used for a company, such as a specific
          language variant.
        REGISTERED: >-
          The main name under which a business is officially registered in a
          country's business register. The registered name does not necessarily
          comprise a legal form (e.g. abbreviated) in all countries. Usually a
          business register ID is uniquely associated with this name.
        REGISTERED_NAME: Deprecated
        TRANSLITERATED: >-
          The transliterated name is not an officially used name, but a
          construct that helps to better find business partners with registered
          names in non-latin characters (e.g. China, Japan, Korea). It is
          automatically generated from the registered name or the name local (if
          the registered name is not available). Main use case is that a search
          input with non-latin characters is transliterated on the fly and then
          used for searching against the transliterated name (in addition to
          other search strategies).
        TRANSLITERATED_NAME: Deprecated
        VAT_REGISTERED: >-
          The name which is associated with the VAT number of a business
          partner, i.e. the name stored in a VAT register. For example, the
          legal entities under the umbrella of one corporation often use the
          same VAT number (sometimes called the "group VAT"). The name
          associated with such a group VAT usually differs from the legal
          entities name registered in the business register of a country.
          Another example are sole proprietors that are doing business with a
          name different than their private name, whereas the VAT is registered
          with the private name of the sole proprietor.
        VAT_REGISTERED_NAME: Deprecated
    ConfigurationFeaturePage:
      type: object
      description: Defines the output Feature configuration.
      properties:
        numberOfPages:
          type: integer
          format: int32
          description: Number of pages.
          example: '10'
        page:
          $ref: '#/components/schemas/Page'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of available Features.
          items:
            $ref: '#/components/schemas/ConfigurationFeature'
    ConfigurationProfilePage:
      type: object
      description: Defines the output Profile configuration.
      properties:
        numberOfPages:
          type: integer
          format: int32
          description: Number of pages.
          example: '10'
        page:
          $ref: '#/components/schemas/Page'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of available Profiles.
          items:
            $ref: '#/components/schemas/ConfigurationProfile'
    ConfigurationFeature:
      type: object
      description: Configure the Character Set for data curation.
      properties:
        feature:
          type: string
          description: The feature to be configured.
          example: ADDRESS_CORRECTION
    ConfigurationProfile:
      type: object
      description: Configure the Profile for data curation.
      properties:
        features:
          type: array
          description: List of available Features.
          items:
            $ref: '#/components/schemas/BusinessPartnerCurationFeature'
        profile:
          $ref: '#/components/schemas/BusinessPartnerCurationProfile'
    ConfigurationConceptPage:
      type: object
      description: Defines the output Concept configuration.
      properties:
        numberOfPages:
          type: integer
          format: int32
          description: Number of pages.
          example: '10'
        page:
          $ref: '#/components/schemas/Page'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of available Concepts.
          items:
            $ref: '#/components/schemas/ConfigurationConcept'
    ConfigurationConcept:
      type: object
      description: Configure the Concept for data curation.
      properties:
        concept:
          $ref: '#/components/schemas/ConceptName'
    ConfigurationCharacterSetPage:
      type: object
      description: Defines the output Character Set configuration.
      properties:
        numberOfPages:
          type: integer
          format: int32
          description: Number of pages.
          example: '10'
        page:
          $ref: '#/components/schemas/Page'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of available Character Sets.
          items:
            $ref: '#/components/schemas/ConfigurationCharacterSet'
    ConfigurationCharacterSet:
      type: object
      description: Configure the Character Set for data curation.
      properties:
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
    Metadata:
      type: object
      description: >-
        Contains additional information and context about the generation
        process.
      properties:
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        dataSource:
          $ref: '#/components/schemas/DataSource'
        cdqId:
          type: string
          description: CDQ ID of the Business Partner.
          example: VIES:PL1132639219
        inactive:
          type: boolean
          description: Indicate if BP used for Golden Record has inactive status.
          example: 'true'
    DataSource:
      type: object
      description: Represents external Data Source.
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
    GoldenRecordCandidate:
      type: object
      description: >-
        Potential data record that is considered as a candidate for inclusion in
        the final Golden Record.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartnerRequest'
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        dataSource:
          $ref: '#/components/schemas/DataSource'
        cdqId:
          type: string
          description: CDQ ID of the Golden Record.
          example: VIES:PL1132639219
    GoldenRecordGenerationRequest:
      type: object
      description: >-
        Generate a single, and accurate record by combining data from multiple
        Data Sources.
      properties:
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
        profile:
          $ref: '#/components/schemas/GoldenRecordGenerationProfile'
        featuresOn:
          type: array
          description: List of Golden Record Features to be activated.
          items:
            $ref: '#/components/schemas/GoldenRecordFeatureParam'
        featuresOff:
          type: array
          description: List of Golden Record Features to be deactivated.
          items:
            $ref: '#/components/schemas/GoldenRecordFeatureParam'
        dataSources:
          type: array
          description: Data sources enabled for identifiers enrichment in golden record
          items:
            $ref: '#/components/schemas/DataSourceTechnicalKeyEnum'
        configurationId:
          type: string
          description: Configuration ID for the Golden Record Generation.
          example: 12ed4bd757f8e162f8aa496f
    GoldenRecordFeatureParam:
      type: string
      description: >-
        Specific functionality to enhance the generation and quality of a Golden
        Record.
      example: ACTIVATE_DATASOURCE_BVD
      enum:
        - ACTIVATE_DATASOURCE_BVD
        - ACTIVATE_DATASOURCE_DNB
        - GOLDENRECORD_CONFIRM_MODE
        - SKIP_CANDIDATE_SELECTION
      x-enumDescriptions:
        ACTIVATE_DATASOURCE_BVD: >-
          Allows to lookup in DVB datasource (e.g. during identifier
          enrichment).
        ACTIVATE_DATASOURCE_DNB: >-
          Allows to lookup in DNB datasource (e.g. during identifier
          enrichment).
        SKIP_CANDIDATE_SELECTION: >-
          Allows to skip candidate selection step
          (https://meta.cdq.com/Golden_record_rules). Requires exactly one
          candidate provided.
    MatchingProfile:
      type: object
      description: >-
        Matching profile used for the match. It contains the matching threshold
        and the matching scores.
      properties:
        matchingScores:
          $ref: '#/components/schemas/MatchingScores'
    MatchingScores:
      type: object
      description: >-
        List of the numerical value of similarity between Business Partners or
        addresses enhanced with the overall score.
      properties:
        overall:
          $ref: '#/components/schemas/MatchingScore'
        businessPartner:
          $ref: '#/components/schemas/MatchingScore'
        address:
          $ref: '#/components/schemas/MatchingScore'
    MatchingScore:
      type: object
      description: >-
        Shows numerical value of similarity between Business Partners or address
        stored in the Data Mirror and the Business Partner from the request.
      properties:
        classification:
          $ref: '#/components/schemas/MatchingClassification'
        value:
          type: number
          description: Matching score value.
          example: '0.9'
        explanation:
          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;]]
    MatchingClassification:
      type: object
      description: >-
        Classification of the matching score. It can be `HIGH`, `MEDIUM` or
        `LOW`.
      properties:
        technicalKey:
          type: string
          description: Technical key of the Matching Classification.
          example: HIGH
        name:
          type: string
          description: Name of the Matching Classification.
          example: My Matching Configuration
    OutputCharset:
      type: object
      description: >-
        Defines the output character set configuration for transliteration of
        the curated data.
      properties:
        concept:
          $ref: '#/components/schemas/OutputCharsetConcept'
        charset:
          $ref: '#/components/schemas/OutputCharsetCharset'
    AddressDataSources:
      type: object
      description: >-
        Preferred data sources for curation. Default PrimaryAddressDataSource is
        HERE. Default SecondaryAddressDataSource is CDQ.
      properties:
        primaryAddressDataSource:
          $ref: '#/components/schemas/AddressDataSource'
        secondaryAddressDataSources:
          type: array
          items:
            $ref: '#/components/schemas/AddressDataSource'
    AddressDataSource:
      type: object
      description: Data source for curation.
      properties:
        technicalKey:
          $ref: '#/components/schemas/AddressDataSourceTechnicalKey'
        threshold:
          $ref: '#/components/schemas/AddressDataSourceThreshold'
    AddressDataSourceTechnicalKeyParam:
      type: string
      description: Technical key for Address Data Source.
      example: HERE
      enum:
        - CDQ
        - HERE
        - GOOGLE_MAPS
      x-enumDescriptions:
        CDQ: CDQ Address Data Source.
        HERE: HERE Address Data Source.
        GOOGLE_MAPS: Google Maps Address Data Source.
    QuotaEntry:
      type: object
      description: Quota entry.
      properties:
        organization:
          type: string
          description: Name of the organization.
          example: CDQ AG
        allowedQuota:
          type: integer
          format: int64
          description: Number of allowed calls.
          example: '1000'
        consumedQuota:
          type: integer
          format: int64
          description: Number of consumed calls.
          example: '100'
        callAttempts:
          type: integer
          format: int64
          description: Number of call attempts.
          example: '100'
    OrganizationCallsEntry:
      type: object
      description: Organization calls entry.
      properties:
        organization:
          type: string
          description: Name of the organization.
          example: CDQ AG
        here:
          type: integer
          format: int64
          description: Number of calls to HERE.
          example: '1000'
        googleMaps:
          type: integer
          format: int64
          description: Number of calls to Google Maps.
          example: '1000'
        curation:
          type: integer
          format: int64
          description: Number of calls to Curation.
          example: '1000'
    CharacterSet:
      type: object
      description: >-
        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'
    DataCurationReportsRequest:
      deprecated: true
      type: object
      description: Deprecated. Reports are available in Data Clinic app.
      allOf:
        - type: object
          description: Parameters for the creation of a Data Curation Reports Job.
          properties:
            dataCurationJobId:
              $ref: '#/components/schemas/DataCurationJobId'
            name:
              type: string
              maxLength: 50
              description: Name of the job.
              example: Data Curation Reports Job
            description:
              type: string
              maxLength: 200
              description: Description of the job.
              example: >-
                The report will be generated for the Data Curation Job with ID:
                a34fb367-85aa-400f-b369-53863432050c.
        - $ref: '#/components/schemas/DataCurationReportsRequestParams'
    DataCurationReportsRequestParams:
      type: object
      description: Parameters for the creation of a Data Curation Reports Job.
      required:
        - reportsConfiguration
      properties:
        reportsConfiguration:
          $ref: '#/components/schemas/DataCurationReportsConfiguration'
    DataCurationJobId:
      type: string
      description: Unique ID of a data curation job.
      example: a34fb367-85aa-400f-b369-53863432050c
    JobDependencyStrategyParam:
      type: string
      description: Defines the strategy of the Job Dependency.
      example: SCHEDULE_NEXT_WHEN_FINISHED
      default: SCHEDULE_NEXT_WHEN_FINISHED
      enum:
        - SCHEDULE_NEXT_WHEN_ENDED
        - SCHEDULE_NEXT_WHEN_FINISHED
        - SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED
      x-enumDescriptions:
        SCHEDULE_NEXT_WHEN_ENDED: Schedule the dependent job when the parent job has ended.
        SCHEDULE_NEXT_WHEN_FINISHED: Schedule the dependent job when the parent job has finished.
        SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED: Schedule the dependent job when the parent job has finished or failed.
    ProvenanceLastUpdatedAt:
      type: string
      description: Provenance Last Updated Date.
      example: '2025-09-12T14:57:38Z'
    ProvenanceLastSyncAt:
      type: string
      description: Provenance Last Sync Date.
      example: '2025-09-12T14:57:38Z'
    SingleCurationResult:
      type: object
      description: Curation result for a Single Business Partner or address.
      properties:
        businessPartnerCurationResult:
          $ref: '#/components/schemas/SingleBusinessPartnerCurationResult'
        addressCurationResults:
          type: array
          description: List of Address Curation results.
          items:
            $ref: '#/components/schemas/SingleAddressCurationResult'
        settings:
          $ref: '#/components/schemas/Settings'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
    SingleBusinessPartnerCurationResult:
      type: object
      description: Curation results for Single Business Partner.
      properties:
        curatedBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        originalBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        changes:
          type: array
          description: List of changes.
          items:
            $ref: '#/components/schemas/PropertyChange'
        requestSimilarity:
          $ref: '#/components/schemas/BusinessPartnerRequestSimilarity'
    SingleAddressCurationResult:
      type: object
      description: Curation results for Single Address.
      properties:
        curatedAddress:
          $ref: '#/components/schemas/Address'
        originalAddress:
          $ref: '#/components/schemas/Address'
        additionalAddresses:
          type: array
          description: List of additional Addresses.
          items:
            $ref: '#/components/schemas/Address'
        curationAnalysis:
          $ref: '#/components/schemas/AddressCurationAnalysis'
    InputAddressConceptsIgnored:
      type: array
      description: >
        A list of technical keys of concepts. Selected concepts will be ignored
        during curation process. 

        This feature is mainly used in configurations, if i.e. for certain
        countries selected inputs 

        should be ignored without changing the current technical integration. 

        Please note that ignored concepts will be taken over to the curation
        result without any change.
      items:
        $ref: '#/components/schemas/InputAddressConceptEnum'
    InputAddressConceptEnum:
      type: string
      description: Technical keys of address concepts.
      example: BUILDING
      enum:
        - BUILDING
        - CITY
        - COUNTY
        - DISTRICT
        - LEVEL
        - POST_CODE
        - REGION
        - ROOM
        - THOROUGHFARE_NUMBER
      x-enumDescriptions:
        BUILDING: >-
          Structure (such as a house, hospital, school, etc.) with a roof and
          walls that is used as a place for people to live, work, do activities,
          store things, etc.
        CITY: Large and permanent human settlement.
        COUNTY: Level 2 subdivision of a country, subdivision of a region.
        DISTRICT: >-
          Subdivision of larger cities, mostly providing administrative services
          to the district residents.
        LEVEL: Floor/story of the building.
        POST_CODE: >-
          Numerical code used to identify specific geographic areas for mail
          sorting and delivery.
        REGION: Top level subdivision of a country.
        ROOM: Distinct room in a building.
        THOROUGHFARE_NUMBER: >-
          A numerical identifier assigned to a specific building or property
          along a thoroughfare.
    CurationMetadataCountry:
      type: object
      description: Country for which the curation was executed.
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    CurationMetadataTrigger:
      type: object
      description: Indicator which tells what was the trigger for curation process.
      properties:
        type:
          $ref: '#/components/schemas/CurationMetadataTriggerType'
        provenance:
          $ref: '#/components/schemas/CurationMetadataTriggerProvenance'
    CurationMetadataTriggerType:
      type: object
      description: Trigger type determining way how the curation item has been triggered.
      properties:
        technicalKey:
          type: string
          description: Technical key of the trigger type.
          example: PROCESSING_LOG
    CurationMetadataTriggerProvenance:
      type: object
      description: Provenance of the trigger.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
    CurationContextEntry:
      type: object
      description: Single context entry.
      properties:
        key:
          type: string
          description: Key of the context entry.
          example: Curation Test
        value:
          type: object
          description: Value of the context entry.
          example: Curation Test
    CurationProfile:
      type: string
      description: Used to configure the curation process.
      example: STANDARD
    CurationFeature:
      type: string
      description: >-
        Features to be used during curation process. For complete description of
        features see [here](https://meta.cdq.com/API/Data_Curation_API).
      example: ENRICH_ADDRESS
    NumberSeparator:
      type: object
      description: >-
        Number separator for features JOIN_THOROUGHFARE_NUMBER_PREFIX,
        JOIN_THOROUGHFARE_NUMBER_POSTFIX. Default ","
      properties:
        value:
          type: string
          description: Character used to separate numbers.
          example: ','
    OutputCharsetParam:
      type: object
      description: >-
        Defines the output character set configuration for transliteration of
        the curated data.
      properties:
        concept:
          $ref: '#/components/schemas/ConceptParam'
        charset:
          $ref: '#/components/schemas/CharsetParam'
      required:
        - concept
        - charset
    ConceptParam:
      type: string
      description: Concept for which the output character set should be applied.
      example: ADDRESS
      enum:
        - ADDRESS
      x-enumDescription:
        ADDRESS: Address concept.
    CharsetParam:
      type: string
      description: >
        Supported CharacterSets:

        *
        [INTERNATIONAL](https://meta.cdq.com/Address/version/character_set/international)

        * [LATIN](https://meta.cdq.com/Address/version/character_set/latin)

        *
        [WESTERN_LATIN_STANDARD](https://meta.cdq.com/Address/version/character_set/western_latin_standard)

        * [ASCII](https://meta.cdq.com/Address/version/character_set/ascii)


        Deprecated CharacterSets:

        * LATIN_1. Now:
        [WESTERN_LATIN_STANDARD](https://meta.cdq.com/Address/version/character_set/western_latin_standard)

        * UTF8. Now:
        [INTERNATIONAL](https://meta.cdq.com/Address/version/character_set/international)
      enum:
        - INTERNATIONAL
        - LATIN
        - LATIN_1
        - UTF8
        - WESTERN_LATIN_STANDARD
        - ASCII
      example: INTERNATIONAL
    AddressDataSourcesParam:
      type: object
      description: >-
        Preferred data sources for curation. Default PrimaryAddressDataSource is
        HERE. Default SecondaryAddressDataSource is CDQ.
      properties:
        primaryAddressDataSource:
          $ref: '#/components/schemas/AddressDataSourceParam'
        secondaryAddressDataSources:
          type: array
          description: Ordered list of secondary preferred Data Sources.
          items:
            $ref: '#/components/schemas/AddressDataSourceParam'
    AddressDataSourceParam:
      type: object
      description: Preferred Data Source for curation.
      properties:
        technicalKey:
          $ref: '#/components/schemas/AddressDataSourceTechnicalKeyParam'
        threshold:
          $ref: '#/components/schemas/AddressDataSourceThreshold'
      required:
        - technicalKey
    CurationLevelParam:
      type: string
      description: >
        Indicator for curation quality. Defines how good curation was.


        Determines `curationDecision` based on `curationLevel` of the result. 

        Additional documentation can be found
        [here](https://meta.cdq.com/Quality_indicator/address_cleansing_curation_level#Curation_level).
      example: LEVEL_1
      enum:
        - UNKNOWN
        - LEVEL_1
        - LEVEL_2
        - LEVEL_3
        - LEVEL_4
        - LEVEL_5
        - LEVEL_6
      x-enumDescriptions:
        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 an alpha version)
    SingleCurationRequest:
      type: object
      description: Parameters for a Single Business Partner or address Curation.
      allOf:
        - $ref: '#/components/schemas/CurationRequest'
        - type: object
          description: Parameters for a Single Business Partner or address Curation.
          required:
            - businessPartner
          properties:
            businessPartner:
              $ref: '#/components/schemas/BusinessPartnerParam'
    CountryParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/country).
      type: object
      properties:
        shortName:
          description: Two-letter country code according to ISO 3166-1 alpha-2
          $ref: '#/components/schemas/CountryShortName'
    AdministrativeAreaParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/administrative_area).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
    LocalityParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/locality).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/LocalityValue'
    PostCodeParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/post_code).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeTypeParam'
    PostCodeTypeParam:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/post_code/type).
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/PostCodeTypeTechnicalKey'
    PostCodeTypeTechnicalKey:
      type: string
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/post_code/type) under Technical Key
        property.
      example: CEDEX
      enum:
        - CEDEX
        - REGULAR
      x-enumDescriptions:
        CEDEX: Cedex Post Code Type.
        REGULAR: Regular Post Code Type.
    ThoroughfareParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/thoroughfare).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
    PremiseParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/premise).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseTypeParam'
    PremiseTypeParam:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/premise/type).
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/PremiseTypeTechnicalKey'
    PostalDeliveryPointParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/postal_delivery_point).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        number:
          $ref: '#/components/schemas/PostalDeliveryPointNumber'
        type:
          $ref: '#/components/schemas/PostalDeliveryPointTypeParam'
    PostalDeliveryPointTypeParam:
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Address/postal_delivery_point/type).
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/PostalDeliveryPointTypeTechnicalKey'
    CareOfParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/care_of).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/CareOfValue'
    AddressContextParam:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/context).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/AddressContextValue'
    SingleGoldenRecordGenerationResult:
      type: object
      description: >-
        Outcome of a process that generates a single, unified and accurate
        record from multiple Data Sources.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        metadata:
          type: array
          description: List of Metadata.
          items:
            $ref: '#/components/schemas/Metadata'
        businessPartnerChanges:
          type: array
          description: List of Property Changes.
          items:
            $ref: '#/components/schemas/PropertyChange'
        goldenRecordUses:
          type: array
          description: >-
            Describes which entries were used to compose golden record and which
            one is the primary (base) entry
          items:
            $ref: '#/components/schemas/GoldenRecordUse'
    GoldenRecordUse:
      type: object
      description: >-
        Describes the use of Business Partners with given CdqId in golden record
        composition.
      properties:
        cdqId:
          type: string
          description: CDQ ID of the Golden Record.
          example: VIES:PL1132639219
        use:
          type: string
          description: |
            Marks how was business partner used:
             * `PRIMARY` - Base entry for golden record
             * `ENRICHMENT` - Entry used to add information to base entry
          example: PRIMARY
    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/schemas-ConceptTechnicalKey'
    MatchingScores2:
      type: object
      description: >
        Contains matching scores for the given property. The scores are
        calculated based on the input and the reference data. The scores are
        calculated for each instance of the property. The scores are calculated
        for each instance of the property. The scores are calculated for each
        instance of the property.
      properties:
        overall:
          type: number
          description: Overall matching score value for Business Partner and Address.
          example: '0.9'
        businessPartner:
          type: number
          description: Matching score value for Business Partner.
          example: '0.9'
        address:
          type: number
          description: Matching score value for Address.
          example: '0.9'
    GoldenRecordGenerationProfile:
      type: string
      description: >-
        Provide configurations with varying feature sets to cater to Golden
        Record Generation needs.
      example: QUICK
      enum:
        - STANDARD
        - QUICK
      x-enumDescriptions:
        STANDARD: >-
          Curation process with standard profile is turned on by default. This
          profile consist of most important API toggle features and because of
          that it's recommended for most data curation cases. More details
          [here](https://meta.cdq.com/API/Data_Curation_API/Profile/STANDARD).
        QUICK: >-
          Works exactly the same as the `STANDARD` profile but with features
          switched off like `ENRICH_IDENTIFIERS`, `ENRICH_CATEGORY`,
          `ENRICH_GEOGRAPHIC_COORDINATES`, `HARMONIZE_IDENTIFIERS` and
          `ENABLE_FUZZY_ENRICHMENTS`.
    SingleGoldenRecordGenerationRequest:
      type: object
      description: >-
        Generate a single, and accurate record by combining data from multiple
        Data Sources.
      allOf:
        - $ref: '#/components/schemas/GoldenRecordGenerationRequest'
        - type: object
          description: >-
            Generate a single, and accurate record by combining data from
            multiple Data Sources.
          required:
            - candidates
          properties:
            candidates:
              type: array
              description: List of Golden Records Candidates.
              minItems: 1
              items:
                $ref: '#/components/schemas/GoldenRecordCandidate'
    CurationJobResultPage:
      type: object
      description: Part of all curation results from job.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Curation Job Results.
          items:
            $ref: '#/components/schemas/CurationJobResult'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
    CurationJobResult:
      type: object
      description: Curation result of single Business Partner
      properties:
        id:
          type: string
          description: Unique identifier of a Job.
          example: 6be92567-4327-4463-813f-a8c990410d79
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        addressId:
          type: string
          description: Unique identifier of an Address.
          example: '1'
        curationResult:
          $ref: '#/components/schemas/SingleCurationResult'
        resultStatus:
          $ref: '#/components/schemas/ResultStatus'
    ResultStatus:
      type: object
      description: Status of the Curation Job Result for a single Business Partner.
      properties:
        status:
          type: string
          description: |
            Status of the Curation Job Result.
            Possible values: 
            * `OK` - Curation Job Result was successfully processed.
            * `FAILED` - Curation Job Result was failed.
          example: OK
        message:
          type: string
          description: Additional explanations for status - especially for the FAILED case.
          example: Storage with provided ID doesn’t exist.
    CurationProfileParam:
      type: string
      description: |
        Used to configure the curation process.
        Available wiki documentation for profiles:
           * [STANDARD](https://meta.cdq.com/API/Data_Curation_API/Profile/STANDARD)
           * [ADDRESS_ONLY](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_ONLY)
           * [STANDARD_ADDRESS_CURATION_AND_ENRICHMENT](https://meta.cdq.com/API/Data_Curation_API/Profile/STANDARD_ADDRESS_CURATION_AND_ENRICHMENT)
           * [ADDRESS_STANDARDIZATION](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_STANDARDIZATION)
           * [ADDRESS_TRANSLATION](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_TRANSLATION)
           * [BUSINESS_PARTNER_ONLY](https://meta.cdq.com/API/Data_Curation_API/Profile/BUSINESS_PARTNER_ONLY)
           * [FEATURES_OFF](https://meta.cdq.com/API/Data_Curation_API/Profile/FEATURES_OFF)
           * [NATURAL_PERSON_SCREENING](https://meta.cdq.com/API/Data_Curation_API/Profile/NATURAL_PERSON_SCREENING)
           * [PRECURATION](https://meta.cdq.com/API/Data_Curation_API/Profile/PRECURATION)
           * [GOLDEN_RECORD](https://meta.cdq.com/API/Data_Curation_API/Profile/GOLDEN_RECORD)
      example: STANDARD
      enum:
        - STANDARD
        - ADDRESS_ONLY
        - STANDARD_ADDRESS_CURATION_AND_ENRICHMENT
        - ADDRESS_STANDARDIZATION
        - ADDRESS_TRANSLATION
        - BUSINESS_PARTNER_ONLY
        - FEATURES_OFF
        - NATURAL_PERSON_SCREENING
        - PRECURATION
        - GOLDEN_RECORD
      x-enumDescription:
        STANDARD: >-
          Curation process with standard profile is turned on by default. This
          profile consist of most important API toggle features and because of
          that it's recommended for most data curation cases.
        ADDRESS_ONLY: >-
          This profile is recommended, when the goal is to perform the address
          curation of your business partner. Address only consists of the most
          important address API features from the precuration to harmonization
          phase.
        STANDARD_ADDRESS_CURATION_AND_ENRICHMENT: >-
          The Address Curation & Enrichment profile allows for cleansing
          addresses in terms of parsing the given content, identifying reference
          addresses in specifically configured or default address data sources,
          enriching the input based on the reference addresses and additional
          CDQ reference data, and harmonizing the different address components.
        ADDRESS_STANDARDIZATION: >-
          The Address Standardization profile standardizes a given input address
          according to the CDQ standards without considering any reference
          addresses from address data sources. It extracts different address
          components and places them in distinct fields (e.g. a PO Box
          maintained as street is put into a separate PO Box concept), enriches
          address components only based on already provided input (e.g. country
          name is enriched based on a given country code) and harmonizes given
          components (e.g. post code is formatted according to the reference
          standard in a country).
        ADDRESS_TRANSLATION: >-
          Translates only business partner address without any enrichment. There
          is also a possible to transliterate, by turned it on in the curation
          settings.
        BUSINESS_PARTNER_ONLY: >-
          This profile is recommended, when the goal is to perform the curation
          of the business partner name, legal form, identifiers etc. Business
          partner only consists of the most important API features from the
          precuration to harmonization phase.
        FEATURES_OFF: >-
          This profile turns off all API features enabled by default (standard
          profile). It may be used for a test purpose to check the results of
          the curation using single features.
        NATURAL_PERSON_SCREENING: >-
          Identifies Natural Person data based on identifiers, legal forms, and
          known legal entities.
        PRECURATION: >-
          Parses, preprocess and harmonize business partner data without
          additional enrichment.
        GOLDEN_RECORD: >-
          Golden Record curation profile consist of API toggle features used
          during golden record generation and is recommended to be used in Data
          Clinic monitoring.
    CurationFeatureParam:
      type: string
      description: >-
        Features to be used during curation process. For complete description of
        features see [here](https://meta.cdq.com/API/Data_Curation_API).
      example: ENRICH_ADDRESS
      enum:
        - ACTIVATE_DATASOURCE_BVD
        - ACTIVATE_DATASOURCE_DNB
        - ALL_ADDRESS_VERSIONS
        - CAPITALIZE_ADDRESS
        - CONFIRM_IDENTIFIERS
        - DETECT_INDUSTRIAL_ZONE
        - ENABLE_FUZZY_ENRICHMENTS
        - ENABLE_SETTINGS
        - ENABLE_UNALLOWED_NAME_VALUE_VALIDATION
        - ENRICH_ADDRESS
        - ENRICH_ADDRESS_TYPE
        - ENRICH_ADMINISTRATIVE_AREA_ISO
        - ENRICH_CATEGORY
        - ENRICH_CLASSIFICATIONS
        - ENRICH_COMPANY_STATUS
        - ENRICH_GEOGRAPHIC_COORDINATES
        - ENRICH_GOOGLE_PLACES_INFORMATION
        - ENRICH_IDENTIFIERS
        - ENRICH_LEGAL_ADDRESS
        - ENRICH_LOCAL_ADDRESS
        - ENRICH_LEGAL_FORM
        - ENRICH_MINORITY_INDICATOR
        - ENRICH_POST_CODE_TYPE
        - ENRICH_POST_CODE
        - ENRICH_REGISTERED_NAME
        - ENRICH_VAT_REGISTERED_INFORMATION
        - EXTRACT_ADDRESS_CONTEXT
        - EXTRACT_CARE_OF
        - EXTRACT_DOING_BUSINESS_AS
        - EXTRACT_NAME_DETAILS
        - HARMONIZE_IDENTIFIERS
        - HARMONIZE_NAME
        - JOIN_THOROUGHFARE_NUMBER_POSTFIX
        - JOIN_THOROUGHFARE_NUMBER_PREFIX
        - NORMALIZE_ADDRESS
        - NORMALIZE_BUSINESS_PARTNER
        - PARSE_ADDRESS
        - PARSE_LEGAL_FORM
        - PARSE_LEGAL_FORM_WORLDWIDE
        - PARSE_NAMES
        - PERSIST_LOOKUP_RESULTS
        - PREFER_COUNTY
        - PREFER_THOROUGHFARE_NAME
        - PREFER_THOROUGHFARE_SHORTNAME
        - PREPROCESS_ADDRESS
        - PREPROCESS_BUSINESS_PARTNER
        - REMOVE_CONTACT_INFORMATION
        - REMOVE_INVALID_IDENTIFIERS
        - SHARING_PRIMARY
        - SHOW_DEBUG_INFO
        - SHOW_FORMATTED_ADDRESS
        - SHOW_FORMATTED_SAP_RECORD
        - SHOW_SETTINGS
        - STANDARDIZE_REGISTERED_ADDRESS
        - STANDARDIZE_VAT_REGISTERED_ADDRESS
        - TRANSLATE_ADDRESS
        - TRANSLATE_NAMES
        - USE_ADDRESS_INDEX_KR
        - USE_LOCALITY_SHORTNAME_REFERENCE
      x-enumDescriptions:
        ACTIVATE_DATASOURCE_BVD: >-
          Allows to lookup in BVD datasource (e.g. during identifier
          enrichment).
        ACTIVATE_DATASOURCE_DNB: >-
          Allows to lookup in DNB datasource (e.g. during identifier
          enrichment).
        ALL_ADDRESS_VERSIONS: Description will be provided.
        CAPITALIZE_ADDRESS: Converts all values in the address data to upper case.
        CONFIRM_IDENTIFIERS: >-
          Checks if provided identifiers exist in external data sources and
          belong to provided business partner.
        DETECT_INDUSTRIAL_ZONE: >
          Detects and moves industrial zone from address fields to the last
          thoroughfare of type industrial zone. This data is also added to
          District for the SAP format record. The Zone is detected during the
          precuration process from the administrative area, locality,
          thoroughfare and premise. This feature works only for few countries
          with special terms.


          The cleansing process doesn’t perform industrial zone enrichment. If
          this information is not provided in input data, the outputs won’t
          contain it. Google or here curation can remove the information about
          the industrial zone, but there are implemented special rules, which
          keep that data and after the curation paste it to the last
          thoroughfare.
        ENABLE_FUZZY_ENRICHMENTS: >-
          Enriches identifiers with search using identifiers, name local or
          international address data.
        ENABLE_SETTINGS: >-
          Allows to use organization settings. Each organization can choose
          which profile should be turned on, default features, weather the
          transliteration is enabled, etc.
        ENABLE_UNALLOWED_NAME_VALUE_VALIDATION: >-
          Validates input business partner names against unallowed patterns and
          returns Bad Request in case of invalid name match.
        ENRICH_ADDRESS: >
          Enriches address information. Geocodes, administrative areas, country
          name and code.


          Cleanse address using external data sources.


          Remove thoroughfare value and sub thoroughfares when there are more
          than 3 locality levels.
        ENRICH_ADDRESS_TYPE: >-
          Identifies the address type of given address and enrich the legal
          address.
        ENRICH_ADMINISTRATIVE_AREA_ISO: >
          Enriches administrative area shortname with ISO value using managed
          administrative areas.


          Standardizes administrative area into target language.
        ENRICH_CATEGORY: >-
          Enrich a CDL community standardized business partner category for a
          given entity.
        ENRICH_CLASSIFICATIONS: >-
          Enriches classification field in businessPartner via lookup using
          identifiers.
        ENRICH_COMPANY_STATUS: Enriches status field in businessPartner via lookup using identifiers.
        ENRICH_GEOGRAPHIC_COORDINATES: >-
          Enriches only geographic coordinates. When turned on with
          `ENRICH_ADDRESS` then if geographic coordinates were enriched during
          cleansing, then this element is not executed.
        ENRICH_GOOGLE_PLACES_INFORMATION: >-
          Enriches name local and legal address from Google Places via
          ReferenceData lookup.
        ENRICH_IDENTIFIERS: >
          Enriches identifiers using ReferenceData lookup via strict and/or
          fuzzy (on-demand, when `ENABLE_FUZZY_ENRICHMENTS` used).


          Cross-links with external data sources and authorities, company as
          well as address identifiers.
        ENRICH_LEGAL_ADDRESS: >-
          Enriches `legalAddress` field in `businessPartner` via lookup using
          identifiers.
        ENRICH_LOCAL_ADDRESS: Enriches local address in curated Business Partner.
        ENRICH_LEGAL_FORM: >
          Identify and enriches the legal form of a company.


          Looks for legal form in name and sets it in the appropriate field.


          When `HARMONIZE_NAME` turned on Normalizes name local by harmonizing
          its legal form.
        ENRICH_MINORITY_INDICATOR: Enriches minority indicator value from supplier gateway.
        ENRICH_POST_CODE_TYPE: Sets type `REGULAR` to post code type if empty.
        ENRICH_POST_CODE: >
          Enriches the post code based on a selection from identified reference
          addresses.


          For some special cases such as France additional strategies are
          applied, e.g. to identify whether a post code is a `CEDEX` post code
          and use dedicated reference data for the city name and post office
          city.
        ENRICH_REGISTERED_NAME: Enriches name of type registered name via lookup using identifiers.
        ENRICH_VAT_REGISTERED_INFORMATION: >-
          Enriches the name and address of the business partner as it is
          provided in official data sources.
        EXTRACT_ADDRESS_CONTEXT: |
          Identifies and enriches address context.

          Moves name part after legal form to address context.
        EXTRACT_CARE_OF: |
          Extracts care of from name and sets it in address.

          Moves care of information from name local to careOf.

          Removes care of information from name international.
        EXTRACT_DOING_BUSINESS_AS: >
          Extracts doing business as from name local and international and adds
          to names list.


          Removes duplicates of DBAs.


          Trims spaces.
        EXTRACT_NAME_DETAILS: |
          Identifies and enriches name details.

          Moves name part after legal form to name details.
        HARMONIZE_IDENTIFIERS: Normalizes identifiers by applying formatting rules
        HARMONIZE_NAME: Normalizes name local by harmonizing its legal form
        JOIN_THOROUGHFARE_NUMBER_POSTFIX: >-
          Thoroughfare number in curation result is added to thoroughfare value
          as a postfix.
        JOIN_THOROUGHFARE_NUMBER_PREFIX: >-
          Thoroughfare number in curation result is added to thoroughfare value
          as a prefix.
        NORMALIZE_ADDRESS: |
          Capitalize locality, thoroughfare and premise.

          Normalize first level of the locality to CDQ standards.
        NORMALIZE_BUSINESS_PARTNER: >
          Normalizes hyphens to `-` in identifiers.


          Removes redundant identifies.


          Removes all identifiers from the given set that do not have a valid
          identifier value.
        PARSE_ADDRESS: >
          Harmonize address data by parsing thoroughfare numbers, etc.


          Tries to detect country if data invalid.


          Ensure that country shortname and value are set and existent.


          Extracts Postal Delivery Point value and number from PostCode.


          Removes or changes local elements in thoroughfare like esquina
          (Spanish), mieszkania (Polish), etc.


          Extracts building number from thoroughfare.


          Identify and extract premise information, see also Premise Enrichment
          and Harmonization for details


          Identify special patterns and extract accordingly such as:

           a) Ensure that kilometre patterns are identified and extracted,

           b) Detects and moves industrial zone from address fields to a premise of type industrial zone.
        PARSE_LEGAL_FORM: >-
          Tries to detect a valid legalform from a businesspartner's localName
          with respect to its countrycode and writes the detected legalform to
          the `legalForm` field in the businesspartner. If no valid `legalForm`
          is found, the legalform field is untouched.
        PARSE_LEGAL_FORM_WORLDWIDE: >-
          Tries to detect a valid legalform from a businesspartner's localName
          without respect to its countrycode and writes the detected legalform
          to the `legalForm` field in the businesspartner. If no valid
          `legalForm` is found, the legalform field is untouched.
        PARSE_NAMES: >
          Removes parts from a given entity's name that are not part of the
          name.


          Copies name international to local if local is empty.


          Normalizes name international to look like name local without accents
          and specific characters.


          Abbreviates names and sets calculated values to short names.


          Detects and sets categories.


          Removes or changes double spaces, special or local characters, etc.
        PERSIST_LOOKUP_RESULTS: Add all lookup requests to curation result.
        PREFER_COUNTY: County will be used as a Region in Administrative Area if found.
        PREFER_THOROUGHFARE_NAME: >-
          Thoroughfare value in curation result is replaced by thoroughfare
          name.
        PREFER_THOROUGHFARE_SHORTNAME: >-
          Thoroughfare value in curation result is replaced by thoroughfare
          shortname.
        PREPROCESS_ADDRESS: >
          Trims each field of the address.


          Removes prefix like (D, D-, DE, DE-) from post code.


          Removes hyphens which are between words and number in thoroughfare
          value.
        PREPROCESS_BUSINESS_PARTNER: >-
          Prepare provided business partner data for further processing (i.e.
          trimming values).
        REMOVE_CONTACT_INFORMATION: Removes contact information from names.
        REMOVE_INVALID_IDENTIFIERS: Validates Business partner identifier according to specific rules.
        SHARING_PRIMARY: >-
          Data from sharing pool (CDQ.POOL or CX.POOL if used api key belongs to
          CX workspace) will be taken first during enrichment, even if it is not
          set as primary data source. Egz. CDQ Pool(full match) > VIES(full
          match) > CDQ Pool(maybe match).
        SHOW_DEBUG_INFO: Returns a debug info.
        SHOW_FORMATTED_ADDRESS: Returns records in a unified way to a SAP standard format.
        SHOW_FORMATTED_SAP_RECORD: Format address in a unified way (without nested data).
        SHOW_SETTINGS: Returns a list of all turned on curation settings.
        TRANSLATE_ADDRESS: >-
          Translates locality and administrative area. Works only when country
          is selected.
        TRANSLATE_NAMES: >-
          Translates name international when contains any non-latin characters.
          Cyrillic is transliterated.
        USE_ADDRESS_INDEX_KR: Uses South Korean address index for enrichment. Valid only for KR.
        USE_LOCALITY_SHORTNAME_REFERENCE: Uses Locality Shortname Reference
    CurationChunkWorkerRequest:
      type: object
      description: Request for curation chunk.
      properties:
        requests:
          type: array
          description: List of curation requests.
          items:
            $ref: '#/components/schemas/SingleCurationWorkerRequest'
        processingLog:
          $ref: '#/components/schemas/ProcessingLog'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        storageOrganizationId:
          $ref: '#/components/schemas/OrganizationId'
    ProcessingLog:
      type: object
      description: ID of the processing log.
      properties:
        id:
          $ref: '#/components/schemas/ProcessingLogId'
        trigger:
          $ref: '#/components/schemas/ProcessingLogTrigger'
        replyQueue:
          $ref: '#/components/schemas/ReplyQueue'
    ProcessingLogTrigger:
      type: object
      description: Processing log trigger.
      properties:
        type:
          $ref: '#/components/schemas/ProcessingLogTriggerType'
        provenance:
          $ref: '#/components/schemas/ProcessingLogTriggerProvenance'
        details:
          $ref: '#/components/schemas/ProcessingLogTriggerDetails'
    ProcessingLogTriggerProvenance:
      type: object
      description: Processing log trigger provenance.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    ProcessingLogTriggerDetails:
      type: object
      description: Processing log trigger details.
      properties:
        value:
          $ref: '#/components/schemas/ProcessingLogTriggerDetailsValue'
    ProcessingLogTriggerDetailsValue:
      type: string
      description: Processing log trigger details value.
      example: '123'
    SingleCurationWorkerRequest:
      type: object
      description: Request for single curation.
      properties:
        request:
          $ref: '#/components/schemas/SingleCurationRequest'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        addressIds:
          type: array
          description: List of address IDs.
          items:
            type: string
            description: ID of the address in the Storage or Data Mirror.
            example: '1'
    WorkspaceConfigurationPage:
      type: object
      description: Page of Workspace Configurations with search results.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Workspace Configurations.
          items:
            $ref: '#/components/schemas/WorkspaceConfigurationSearchResult'
    WorkspaceConfigurationSearchResult:
      type: object
      description: Allows to search for and find specific configurations.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedBy'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    BusinessPartnerCurationUpdate:
      type: object
      description: Allows to update and curate Business Partner.
      properties:
        name:
          type: string
          description: The name of the configuration.
          example: My configuration
        configuration:
          $ref: '#/components/schemas/DataCurationConfiguration'
    BusinessPartnerCurationConfiguration:
      type: object
      description: >-
        Allows users to configure the parameters for curating Business Partner
        data.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/DataCurationConfiguration'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedBy'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        transactionId:
          $ref: '#/components/schemas/TransactionId'
    ConfigurationVersionNumber:
      type: integer
      description: Version number of the configuration.
      example: 1
    TransactionId:
      type: string
      description: >-
        ID of the transaction, pass it in subsequent requests to make them part
        of the transaction.
      example: 8e37da1e-ee9d-4ee0-b03d-24a1f89988f2
    TransactionFeatureParam:
      type: string
      description: Feature to be used in 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.
    DataCurationConfiguration:
      type: object
      description: Allows users to configure Data Curation settings.
      properties:
        contextConfigurations:
          type: array
          description: List of Context Configurations.
          items:
            $ref: '#/components/schemas/DataCurationContextConfiguration'
        goldenRecordSettings:
          $ref: '#/components/schemas/GoldenRecordSettings'
    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/Country'
        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.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    DataCurationContextConfiguration:
      type: object
      description: Data Curation Configuration which is applied in a certain context.
      properties:
        context:
          $ref: '#/components/schemas/DataCurationContext'
        addressCurationLevelThreshold:
          $ref: '#/components/schemas/DataCurationRuleAddressCurationLevelThreshold'
        outputLanguageTechnicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
        outputCharsets:
          type: array
          description: List of Output Charsets.
          items:
            $ref: '#/components/schemas/OutputCharset'
        profile:
          $ref: '#/components/schemas/CurationProfile'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/CurationFeature'
        featuresOff:
          type: array
          items:
            $ref: '#/components/schemas/CurationFeature'
        addressDataSources:
          $ref: '#/components/schemas/AddressDataSources'
        numberSeparator:
          $ref: '#/components/schemas/DataCurationRuleNumberSeparator'
        inputAddressConceptsIgnored:
          $ref: '#/components/schemas/InputAddressConceptsIgnored'
    DataCurationContext:
      type: object
      description: >-
        `country.shortName` is used for applying configuration for specific
        country. `country.value` is used only for presentation purposes.
      properties:
        country:
          $ref: '#/components/schemas/Country'
    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/BusinessPartnerRelationStartNode'
        endNode:
          $ref: '#/components/schemas/BusinessPartnerRelationEndNode'
        startNodeBusinessPartner:
          $ref: '#/components/schemas/RelationBusinessPartner'
        endNodeBusinessPartner:
          $ref: '#/components/schemas/RelationBusinessPartner'
    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'
    RelationBusinessPartner:
      type: object
      description: Relation of the Business Partner.
      properties:
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/Name'
        addresses:
          type: array
          description: List of addresses.
          items:
            $ref: '#/components/schemas/RelationBusinessPartnerAddress'
    RelationBusinessPartnerAddress:
      type: object
      description: Address of the related Business Partner.
      properties:
        country:
          $ref: '#/components/schemas/Country'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
    BusinessPartnerRelationTypeRequest:
      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'
    BusinessPartnerRelationClassRequest:
      type: object
      description: Provides information about the classification of the relation.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationClassName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
    RelationBusinessPartnerRequest:
      type: object
      description: Relation of the Business Partner.
      properties:
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/NameRequest'
        addresses:
          type: array
          description: List of addresses.
          items:
            $ref: '#/components/schemas/RelationBusinessPartnerAddressRequest'
    RelationBusinessPartnerAddressRequest:
      type: object
      description: Address of the related Business Partner.
      properties:
        country:
          $ref: '#/components/schemas/CountryRequest'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCodeRequest'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/LocalityRequest'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/ThoroughfareRequest'
    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'
    NameDetail:
      type: object
      description: >-
        Some additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      properties:
        value:
          $ref: '#/components/schemas/NameDetailValue'
        type:
          $ref: '#/components/schemas/NameDetailType'
    NameDetailType:
      type: object
      description: >-
        Type of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      properties:
        name:
          $ref: '#/components/schemas/NameDetailTypeName'
        url:
          $ref: '#/components/schemas/NameDetailTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/NameDetailTypeTechnicalKey'
    IssuingBody:
      type: object
      description: >-
        An Issuing Body is an organization or government institution that is
        responsible for assigning unique identifiers to individuals,
        organizations, or objects.
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
    Jurisdiction:
      type: object
      description: >-
        The authority of an official organization to make decisions and
        judgments in a particular administrative area.
      properties:
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
    IdentifierStatus:
      type: object
      description: >-
        Identifier Status refers to the current state of a unique identification
        number.
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    BusinessPartnerCategoryScore:
      type: string
      description: Score of business partner category
      example: '0.95'
    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'
    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:
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
        language:
          $ref: '#/components/schemas/Language'
    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'
    BusinessPartnerTypeRequest:
      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'
    NameRequest:
      type: object
      description: >-
        The name of a Business Partner. Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/name).
      properties:
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        shortName:
          $ref: '#/components/schemas/NameShortName'
        language:
          $ref: '#/components/schemas/Language'
        details:
          type: array
          items:
            $ref: '#/components/schemas/NameDetail'
    LegalFormRequest:
      type: object
      description: >-
        The legal form of a [Business Partner/type/legal
        entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the
        form it takes in the eyes of the law governing it. The legal form of a
        [company](https://meta.cdq.com/Business_partner) is the general type it
        may legally use to identify itself according to the local, regional,
        national, or international law governing it. This is normally reflected
        in the ending abbreviation after the
        [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc.,
        LLC, S.A.).
      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 Legal Form categories.
          items:
            $ref: '#/components/schemas/LegalFormCategory'
    IdentifierRequest:
      type: object
      description: >-
        Identifies a [Business Partner](https://meta.cdq.com/Business_partner)
        in a given context uniquely such as a VAT identification number.
        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/identifier).
      properties:
        type:
          $ref: '#/components/schemas/IdentifierType'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
        status:
          $ref: '#/components/schemas/IdentifierStatus'
    BusinessPartnerCategoryRequest:
      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'
        score:
          $ref: '#/components/schemas/BusinessPartnerCategoryScore'
    BusinessPartnerStatusRequest:
      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). Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/status).
      properties:
        type:
          $ref: '#/components/schemas/BusinessPartnerStatusType'
        officialDenotation:
          $ref: '#/components/schemas/BusinessPartnerStatusOfficialDenotation'
        validFrom:
          $ref: '#/components/schemas/BusinessPartnerStatusValidFrom'
        validUntil:
          $ref: '#/components/schemas/BusinessPartnerStatusValidUntil'
    ClassificationRequest:
      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'
    PhoneNumberRequest:
      type: object
      description: >-
        The main phone number of a Business Partner, usually some info-line of
        the headquarter.
      properties:
        countryPrefix:
          $ref: '#/components/schemas/PhoneNumberCountryPrefix'
        number:
          $ref: '#/components/schemas/PhoneNumberNumber'
        type:
          $ref: '#/components/schemas/PhoneNumberType'
        value:
          $ref: '#/components/schemas/PhoneNumberValue'
    WebsiteRequest:
      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'
    ContactEmailRequest:
      type: object
      description: Actual email address of the Business Partner.
      properties:
        value:
          $ref: '#/components/schemas/ContactEmailValue'
    AddressIdentifyingNameRequest:
      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'
    CareOfRequest:
      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'
    AddressContextRequest:
      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'
    CountryRequest:
      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'
    AdministrativeAreaRequest:
      type: object
      description: >-
        A top-level geographical or political area division in a country.
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/administrative_area).
      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'
    PostCodeRequest:
      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). Additional
        documentation can be found
        [here](https://meta.cdq.com/Address/post_code).
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    LocalityRequest:
      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. Additional documentation can
        be found [here](https://meta.cdq.com/Address/locality).
      properties:
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        value:
          $ref: '#/components/schemas/LocalityValue'
        language:
          $ref: '#/components/schemas/Language'
    ThoroughfareRequest:
      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. Additional documentation can be found
        [here](https://meta.cdq.com/Address/thoroughfare).
      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'
    PremiseRequest:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sublevels to precisely identify. Additional documentation can be
        found [here](https://meta.cdq.com/Address/premise).
      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'
    PostalDeliveryPointRequest:
      type: object
      description: >-
        A single mailbox or other place at which postal mail is delivered.
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/postal_delivery_point).
      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'
    GeographicCoordinatesRequest:
      type: object
      description: >-
        Decimal geographic coordinates (WGS 84 - reference coordinate system).
        Additional documentation can be found
        [here](https://meta.cdq.com/Address/geographic_coordinates).
      properties:
        latitude:
          $ref: '#/components/schemas/GeographicCoordinatesLatitude'
        longitude:
          $ref: '#/components/schemas/GeographicCoordinatesLongitude'
    AddressTypeRequest:
      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. Allowed types are documented
        [here](https://meta.cdq.com/Address/type).
      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-09-12T14:57:38Z'
    SingleCurationWorkerResultStatus:
      type: string
      description: |
        Status of the Curation Job Result.
        Possible values: 
        * `OK` - Curation Job Result was successfully processed.
        * `FAILED` - Curation Job Result was failed.
      example: OK
    SingleCurationWorkerResultMessage:
      type: string
      description: Additional explanations for status - especially for the FAILED case.
      example: Storage with provided ID doesn’t exist.
    SingleCurationWorkerResultAddressId:
      type: string
      description: ID of the address in the Storage or Data Mirror.
      example: '1'
    CurationChunkWorkerResultNumberOfProcessed:
      type: integer
      description: Number of processed business partners.
      example: '1'
    CurationChunkWorkerResultNumberOfFailed:
      type: integer
      description: Number of failed business partners.
      example: '1'
    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.
    NameValue:
      type: string
      description: The actual name.
      example: Corporate Data Quality AG
    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
    CountryShortName:
      type: string
      description: Country code (ISO 3166-1 alpha-2).
      example: CH
    AdministrativeAreaValue:
      type: string
      description: >-
        Name of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: Sankt Gallen
    LocalityValue:
      type: string
      description: Name of the [Locality](https://meta.cdq.com/Address/locality).
      example: Sankt Gallen
    PostCodeValue:
      type: string
      description: Effective [post code](https://meta.cdq.com/Address/post_code).
      example: '9000'
    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
    ThoroughfareNumber:
      type: string
      description: Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: '4'
    PremiseValue:
      type: string
      description: The actual value of a Premise in the language of the address.
      example: Lukasstraße 4
    PremiseNumber:
      type: string
      description: Number of the Premise.
      example: '4'
    PostalDeliveryPointValue:
      type: string
      description: >-
        Value of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: Postfach
    PostalDeliveryPointNumber:
      type: string
      description: >-
        Number of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: '460'
    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.
    LanguageTechnicalKey:
      type: string
      description: ISO 639-1 two-letter code of languages.
      example: DE
    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'
    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.
    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
    schemas-NameTypeTechnicalKey:
      type: string
      description: Technical Keys of the Name Type.
      example: LOCAL
    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
    NameDetailValue:
      type: string
      description: >-
        Value of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: Corporate Data Quality AG - Marketing Department
    NameDetailTypeName:
      type: string
      description: >-
        Name Detail Type Name of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: Legal Entity
    NameDetailTypeUrl:
      type: string
      description: >-
        Name Detail Type Url of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: https://meta.cdq.com/Business_partner/type
    NameDetailTypeTechnicalKey:
      type: string
      description: >-
        Name Detail Type Technical Key of additional information to a [Business
        Partner Name](https://meta.cdq.com/Business_partner/name).
      example: LEGAL_ENTITY
    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-09-12T14:57:38Z'
    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
    LegalFormCategoryShortName:
      type: string
      maxLength: 15
      description: Short display name of the Legal Form Category.
      example: LLC
    LegalFormCategoryTechnicalKey:
      type: string
      description: >-
        Technical Key of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: LIMITED
    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
    schemas-IdentifierTypeTechnicalKey:
      type: string
      description: Technical key of the type of the Identifier.
      example: CH_VAT_ID
    IssuingBodyUrl:
      description: >-
        URL to the documentation which summarizes all details of a [Issuing
        Body](https://meta.cdq.com/Business_partner/identifier/issuing_body).
      example: https://meta.cdq.com/Business_partner/identifier/issuing_body
      type: string
    CountryValue:
      type: string
      description: Country name (ISO 3166-1 alpha-2).
      example: Switzerland
    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
    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-09-12T14:57:38Z'
    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-09-12T14:57:38Z'
    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
    AddressExternalId:
      type: string
      description: >-
        ID the address has in the external system where the record originates
        from.
      example: '1'
    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
    schemas-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
    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
    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
    PremiseShortName:
      type: string
      description: Abbreviation of the Premise.
      example: Lukasstr. 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
    schemas-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
    schemas-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
    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
    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
    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
    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
    FormattedSapRecordName1:
      type: string
      description: A name1 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName2:
      type: string
      description: A name2 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName3:
      type: string
      description: A name3 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName4:
      type: string
      description: A name4 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordNameCo:
      type: string
      description: The legal form name of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalEntity:
      type: string
      description: The legal entity of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalForm:
      type: string
      description: The legal form of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordIndSector:
      type: string
      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.
      example: NAF
    FormattedSapRecordIndSectorCode:
      type: string
      description: >-
        A code of business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      example: NAF
    FormattedSapRecordEmailAddress:
      type: string
      description: Email address of the Business Partner.
      example: bp@gmail.com
    FormattedSapRecordNarp:
      type: string
      description: >-
        An individual person, i.e. not an organization. An individual has no
        identifiers and has no legal form in its name.
      example: Friedrich Nietzsche
    FormattedSapRecordStceg:
      type: string
      description: VAT registration number.
      example: CHE-218.608.88
    FormattedSapRecordStcd1:
      type: string
      description: Standard tax number field1.
      example: CHE-218.608.88
    FormattedSapRecordStcd2:
      type: string
      description: Standard tax number field2.
      example: CHE-218.608.88
    FormattedSapRecordStcd3:
      type: string
      description: Standard tax number field3.
      example: CHE-218.608.88
    FormattedSapRecordStcd4:
      type: string
      description: Standard tax number field4.
      example: CHE-218.608.88
    FormattedSapRecordStcd5:
      type: string
      description: Standard tax number field5.
      example: CHE-218.608.88
    FormattedSapRecordUrl:
      type: string
      description: >-
        Webpages related to the business partner, e.g. the main corporate
        website as also provided by some company registers.
      example: www.cdq.com
    FormattedSapRecordTelNumber:
      type: string
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarter.
      example: +41 71 571 10 40
    FormattedSapRecordCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedSapRecordCountryCode:
      type: string
      description: Country code (ISO 3166-1 alpha-2)
      example: CH
    FormattedSapRecordRegion:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordRegionCodeSap:
      type: string
      description: A Region specific code for a certain address.
      example: '9004'
    FormattedSapRecordRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCounty:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordCountyCode:
      type: string
      description: A county specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordTownship:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordTownshipCode:
      type: string
      description: A township specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCity:
      type: string
      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.
      example: Sankt Gallen
    FormattedSapRecordDistrict:
      type: string
      description: Area of a country or city.
      example: St. Georgen
    FormattedSapRecordPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordPostalCode3:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordStreet1:
      type: string
      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.
      example: Lukasstraße 4
    FormattedSapRecordStreet2:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordStreet5:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordHouseNum:
      type: string
      description: Number of the Thoroughfare.
      example: '4'
    FormattedSapRecordHouseNum2:
      type: string
      description: Additional number filed.
      example: '4'
    FormattedSapRecordBuilding:
      type: string
      description: >-
        A structure (such as a house, hospital, school, etc.) with a roof and
        walls that is used as a place for people to live, work, do activities,
        store things, etc.
      example: Office 2
    FormattedSapRecordFloor:
      type: string
      description: The floor/story of the building.
      example: '2'
    FormattedSapRecordRoomnumber:
      type: string
      description: A distinct room in a building.
      example: '123'
    FormattedSapRecordPoBoxCountry:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxCity:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxPostalCode:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBox:
      type: string
      description: Des
      example: '9000'
    FormattedSapRecordLatitude:
      type: string
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
    FormattedSapRecordLongitude:
      type: string
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
    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
    RuleContext:
      type: object
      description: Context for Data Curation. Contains the country.
      properties:
        country:
          $ref: '#/components/schemas/Country'
    DataCurationRuleAddressCurationLevelThreshold:
      type: string
      description: >-
        Defines threshold for address found in external source like HERE above
        which it is consider as good. Range 0..1.
      example: '0.5'
    OutputCharsetConcept:
      type: string
      description: Defines concept for output charset.
      example: ADDRESS
    OutputCharsetCharset:
      type: string
      description: Defines type for output charset.
      example: LATIN
    schemas-OutputCharset:
      type: object
      description: Defines the output character set configuration for transliteration.
      properties:
        concept:
          $ref: '#/components/schemas/OutputCharsetConcept'
        charset:
          $ref: '#/components/schemas/OutputCharsetCharset'
    DataCurationRuleProfile:
      type: string
      description: Profile for curation.
      example: BUSINESS_PARTNER_ONLY
    DataCurationRuleFeature:
      type: string
      description: Feature for curation.
      example: ENABLE_FUZZY_ENRICHMENTS
    AddressDataSourceTechnicalKey:
      type: string
      description: Technical key for Address Data Source.
      example: HERE
    schemas-AddressDataSource:
      type: object
      description: Data source for curation.
      properties:
        technicalKey:
          $ref: '#/components/schemas/AddressDataSourceTechnicalKey'
        threshold:
          $ref: '#/components/schemas/AddressDataSourceThreshold'
    schemas-AddressDataSources:
      type: object
      description: >-
        Preferred data sources for curation. Default PrimaryAddressDataSource is
        HERE. Default SecondaryAddressDataSource is CDQ.
      properties:
        primaryAddressDataSource:
          $ref: '#/components/schemas/schemas-AddressDataSource'
        secondaryAddressDataSources:
          type: array
          items:
            $ref: '#/components/schemas/schemas-AddressDataSource'
    DataCurationRule:
      type: object
      description: Configuration for Data Curation. Contains active features and profiles.
      deprecated: true
      properties:
        context:
          $ref: '#/components/schemas/RuleContext'
        addressCurationLevelThreshold:
          $ref: '#/components/schemas/DataCurationRuleAddressCurationLevelThreshold'
        outputLanguageTechnicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
        outputCharsets:
          type: array
          items:
            $ref: '#/components/schemas/schemas-OutputCharset'
        profile:
          $ref: '#/components/schemas/DataCurationRuleProfile'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/DataCurationRuleFeature'
        featuresOff:
          type: array
          items:
            $ref: '#/components/schemas/DataCurationRuleFeature'
        addressDataSources:
          $ref: '#/components/schemas/schemas-AddressDataSources'
    HttpStatus:
      type: integer
      description: RFC 7231 status code for this error.
      example: '400'
      deprecated: true
    HttpPath:
      type: string
      description: Requested path which caused this error.
      example: /v2/businesspartners/lookup
    ExternalServiceResponseStatus:
      type: string
      description: External service call status.
      example: OK
    AdditionalInformation:
      type: object
      description: >-
        Object provide additional information from the request to the external
        service like headers, requester id etc.
      properties:
        key:
          type: string
          description: Key of the generic key/value map.
          example: KEY
        value:
          type: string
          description: Key of the generic key/value map.
          example: '1'
    ExternalServiceResponse:
      type: object
      description: >-
        Additional information about any external services used during the
        original request.
      properties:
        timestamp:
          type: string
          description: ISO 8601 representation of the timestamp.
          example: '2025-09-12T14:57:38Z'
        httpStatus:
          $ref: '#/components/schemas/HttpStatus'
        httpPath:
          $ref: '#/components/schemas/HttpPath'
        status:
          $ref: '#/components/schemas/ExternalServiceResponseStatus'
        message:
          type: string
          description: Received message of the external service.
          example: VIES_NOT_AVAILABLE - Vies is currently not available
        source:
          type: string
          description: Source of the the response.
          example: CHUID
        additionalInformations:
          description: Any additional information received during the original request.
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInformation'
    PageSize:
      type: integer
      description: Number of items per page.
      example: '100'
      default: 10
      minimum: 1
      maximum: 1000
    StartAfter:
      type: string
      description: The ID which is used to read the page.
      example: '5712566172571652'
    PageTotal:
      description: Total number of items which can be paged.
      example: '67'
      type: integer
    Page:
      type: integer
      description: Current page number.
      example: '1'
      default: 0
      minimum: 0
    Limit:
      type: integer
      description: Number of items per page.
      example: '100'
    NextStartAfter:
      type: string
      description: Provides a value to be used as a startAfter in next page request.
      example: '5712566172571652'
    BusinessPartnerStorageDataSourceId:
      type: string
      description: Unique identifier for a Data Source of the Storage.
      example: 648824a691d8d2503d65103e
    BusinessPartnerStorageDataSourceName:
      type: string
      description: Name of a data source of a storage.
      example: Internal customers
    BusinessPartnerStorageId:
      type: string
      description: Unique identifier of the Storage.
      example: 72d6900fce6b326088f5d9d91049e3e6
    BusinessPartnerId:
      type: string
      description: >-
        A CDQ ID identifies a business partner uniquely in the context of the
        Corporate Data League.
      example: 63e635235c06b7396330fe40
    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
    ProcessingStatusTechnicalKey:
      type: string
      description: Possible technical states of processing.
      example: IN_PROGRESS
    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
    BusinessPartnerRelationStartedAt:
      type: string
      description: Describe when this relationship was first established.
      example: '2025-09-12T14:57:38Z'
    BusinessPartnerRelationEndedAt:
      type: string
      description: Describe when this relationship ended.
      example: '2025-09-12T14:57:38Z'
    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
    BusinessPartnerRelationStartNode:
      type: string
      description: >-
        It's a number of the business partner that plays a superior role over
        the other business partner. In means that, the company is parent of the
        second company (child) and has one of the relationship type like:\
        Domestic Ultimate Legal entity or Direct Legal entity.
      example: FR.RC:5664645
    BusinessPartnerRelationEndNode:
      type: string
      description: >-
        It's a number of the business partner that plays a subordinate role over
        the other business partner. In means that, the company is chile of the
        second company (parent) and has one of the special relationship types.
      example: FR.RC:5664645
    JobId:
      type: string
      description: Unique identifier of a job.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    BuildToggle:
      type: boolean
      description: Enable to generate this report.
      default: 'false'
      example: 'true'
    AddressCurationReportConfiguration:
      type: object
      description: Configures if and how Address Curation reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
    LegalEntityCurationReportConfiguration:
      type: object
      description: Configures if and how Legal Entity Curation reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
    NaturalPersonScreeningReportConfiguration:
      type: object
      description: Configures if and how Natural Person Screening reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
    VatRegistrationDataReportConfiguration:
      type: object
      description: Configures if and how Vat Registration Data reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
    DataCurationReportsConfiguration:
      type: object
      description: Configures if and how Data Curation reports are generated.
      properties:
        addressCuration:
          $ref: '#/components/schemas/AddressCurationReportConfiguration'
        legalEntityCuration:
          $ref: '#/components/schemas/LegalEntityCurationReportConfiguration'
        naturalPersonScreening:
          $ref: '#/components/schemas/NaturalPersonScreeningReportConfiguration'
        vatRegistrationData:
          $ref: '#/components/schemas/VatRegistrationDataReportConfiguration'
    JobStatusMessage:
      type: string
      description: Additional information to explain the status.
      example: The job failed because storage is empty.
    CreatedAt:
      type: string
      description: Date of creation (ISO 8601-compliant).
      example: '2025-09-12T14:57:38Z'
    JobUser:
      type: string
      description: ID of (human) user or API key.
      example: 742429-234242-4343-232323
    JobProgress:
      type: integer
      description: Progress (%) of the job.
      example: '77'
      maximum: 100
      minimum: 0
    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
    Tags:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    FileResource:
      description: File resource which can be uploaded or downloaded.
      type: object
      properties:
        url:
          $ref: '#/components/schemas/FileResourceUrl'
        tags:
          $ref: '#/components/schemas/Tags'
    BusinessPartnerCurationFeature:
      type: string
      description: Feature for curation.
      example: ENABLE_FUZZY_ENRICHMENTS
    BusinessPartnerCurationProfile:
      type: string
      description: Profile for curation.
      example: BUSINESS_PARTNER_ONLY
    ConceptName:
      type: string
      description: Display name of the Concept.
      example: Address
    FormattedAddressCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedAddressAdministrativeArea:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedAddressRegion:
      type: string
      description: Top level subdivision of a country.
      example: Sankt Gallen
    FormattedAddressRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedAddressLocality:
      type: string
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
      example: Sankt Gallen
    FormattedAddressDistrict:
      type: string
      description: >-
        Type of administrative division that, in some countries, is managed by
        local government. Across the world, areas known as "districts" vary
        greatly in size, spanning regions or counties, several municipalities,
        subdivisions of municipalities, school district, or political district.
      example: City center
    FormattedAddressPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedAddressThoroughfare:
      type: string
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue.
      example: Lukassstrasse
    FormattedAddressPremise:
      type: string
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      example: Lukasstraße 4, Building 2, Floor 3, Room 4
    FormattedAddressInterurbanDeliveryPoint:
      type: string
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
    FormattedAddressMailbox:
      type: string
      description: A location at an address where the post is delivered to.
      example: Postfach 460
    FormattedAddressPostOfficeBox:
      type: string
      description: >-
        A uniquely addressable lockable box located on the premises of a post
        office station.
      example: Postfach 460
    schemas-FormattedAddress:
      type: object
      description: A formatted address is a structured address of VIES data source.
      properties:
        country:
          $ref: '#/components/schemas/FormattedAddressCountry'
        administrativeArea:
          $ref: '#/components/schemas/FormattedAddressAdministrativeArea'
        region:
          $ref: '#/components/schemas/FormattedAddressRegion'
        regionCode:
          $ref: '#/components/schemas/FormattedAddressRegionCode'
        locality:
          $ref: '#/components/schemas/FormattedAddressLocality'
        district:
          $ref: '#/components/schemas/FormattedAddressDistrict'
        postalCode:
          $ref: '#/components/schemas/FormattedAddressPostalCode'
        thoroughfare:
          $ref: '#/components/schemas/FormattedAddressThoroughfare'
        premise:
          $ref: '#/components/schemas/FormattedAddressPremise'
        interurbanDeliveryPoint:
          $ref: '#/components/schemas/FormattedAddressInterurbanDeliveryPoint'
        mailbox:
          $ref: '#/components/schemas/FormattedAddressMailbox'
        postOfficeBox:
          $ref: '#/components/schemas/FormattedAddressPostOfficeBox'
    DataSourceTechnicalKeyEnum:
      type: string
      description: Technical key of the data source.
      example: BR_RF
      enum:
        - AR_NRC
        - AT_CR
        - AT_FON
        - AU_BR
        - BE_CCD
        - BR_RF
        - BZST
        - CA_CR
        - CZ_REE
        - CDL
        - CDQ_POOL
        - CDQ_CRAWLED
        - CH_CR
        - CH_UIDR
        - DATAMIRROR
        - DE_RC
        - DNB
        - DNB_LNKELI
        - DNB_MASTER_DATA_BASIC
        - DNB_MASTER_DATA_EXTENDED
        - EE_CR
        - FR_RC
        - GB_EAW_CR
        - GOOGLEPLACES
        - IE_CR
        - IL_CR
        - JP_CR
        - LEI
        - MX_SBI
        - NL_BR
        - PL_NOBR
        - US_SEC
        - US_AK_BER
        - US_FL_BER
        - US_LA_BER
        - US_SF_BER
        - US_NY_BER
        - US_IO_BER
        - US_OR_BER
        - US_WA_BER
        - US_WY_BER
        - US_CO_BER
        - SG_BR
        - VIES
        - DK_CR
        - NO_RBE
        - LV_CR
        - NZ_CR
        - SPOR_OMS
        - UK_VAT
      x-enumDescriptions:
        AR_NRC: Argentina National Registry of Companies
        AT_CR: Austria Company Register
        AT_FON: FinanzOnline Austria
        AU_BR: Australian Business Register
        BE_CCD: Central Belgium Company Database
        BR_RF: Receita Federal Brazil
        BZST: Bundeszentralamt für Steuern
        CA_CR: Corporations Register Canada
        CZ_REE: Register of Economic Entities
        CDL: CDQ Data Sharing Community Data Lake
        CDQ_POOL: CDQ Data Sharing Community Data Pool
        CDQ_CRAWLED: null
        CH_CR: Swiss commercial register
        CH_UIDR: UID-Register
        DATAMIRROR: CDQ Data Mirror
        DE_RC: German Commercial Register
        DNB: D&B CMPELK Records
        DNB_LNKELI: D&B Extended Linkages
        DNB_MASTER_DATA_BASIC: DNB Master Data Basic Records
        DNB_MASTER_DATA_EXTENDED: DNB Master Data Extended Records
        EE_CR: Estonian Commercial Register
        FR_RC: French Company Register
        GB_EAW_CR: Companies House England and Wales Company Register
        GOOGLEPLACES: Google Places
        IE_CR: Irish Company Register
        IL_CR: Israeli Company Register
        JP_CR: Japanese Company Register
        LEI: Legal Entity Identifier Records
        MX_SBI: Mexican Digital Business Information System
        NL_BR: Netherlands Company Register
        PL_NOBR: Polish National Official Business Register
        US_SEC: US Securities and Exchange Commission EDGAR Company Filings
        US_AK_BER: Alaska Business Entity Register
        US_FL_BER: Florida Business Entity Register
        US_LA_BER: Listing of Active Businesses - Los Angeles
        US_SF_BER: Registered Business Locations - San Francisco
        US_NY_BER: New York Business Entity Register
        US_IO_BER: Iowa Business Entity Register
        US_OR_BER: Oregon Business Entity Register
        US_WA_BER: Washington Business Entity Register
        US_WY_BER: Wyoming Business Entity Register
        US_CO_BER: Colorado Business Entity Register
        SG_BR: Unique Entity Number Register
        VIES: VIES VAT number validation
        DK_CR: Denmark Central Business Register
        NO_RBE: Norway, The Brønnøysund Register Centre
        LV_CR: Registered companies from Latvia
        NZ_CR: New Zealand Business Number Register
        SPOR_OMS: >-
          Data source that offers business partner and location information
          about healthcare organisations and manufacturers
        UK_VAT: HM Revenue and Customs VAT Check
    ModifiedBy:
      type: string
      description: User or Client UUID which modified the resource.
      example: '76248934691294444'
    ExternalIdValue:
      type: string
      description: Value of the ExternalId of the business partner.
      example: '123'
    schemas-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'
    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.
    CreatedBy:
      type: string
      description: Creator of a resource.
      example: '76248934691294444'
    WorkspaceId:
      type: string
      description: Uniquely identifying ID of the workspace.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    DataCurationRuleNumberSeparator:
      type: object
      description: >-
        Number separator for features `JOIN_THOROUGHFARE_NUMBER_PREFIX`,
        `JOIN_THOROUGHFARE_NUMBER_POSTFIX`.
      properties:
        value:
          type: string
          description: Number separator value for features.
          example: ','
    DataSourceTechnicalKey:
      type: string
      description: Technical key of the data source.
      example: BR_RF
    Worker:
      type: string
      description: Worker which generated the result.
      example: pod-647328648329632-34890742-3432
    CorrelationId:
      type: string
      description: ID which uniquely chains a set of request()s and or task(s).
      example: 123e4567-e89b-12d3-a456-426614174000
    TaskStatus:
      type: string
      description: Task status.
      example: OK
    TaskMessage:
      type: string
      description: Details task status.
      example: The validation was successful.
    TaskResult:
      type: object
      description: Result or outcome of a task.
      properties:
        worker:
          $ref: '#/components/schemas/Worker'
        correlationId:
          $ref: '#/components/schemas/CorrelationId'
        status:
          $ref: '#/components/schemas/TaskStatus'
        message:
          $ref: '#/components/schemas/TaskMessage'
    MinorityIndicatorValue:
      type: string
      description: >-
        The actual value of the minority indicator, representing the minority
        group.
      example: Social enterprise
    UserId:
      type: string
      description: Unique ID of a user.
      example: johndoe
    Task:
      type: object
      description: A task is a unit of work.
      properties:
        correlationId:
          $ref: '#/components/schemas/CorrelationId'
        userId:
          $ref: '#/components/schemas/UserId'
        jobId:
          $ref: '#/components/schemas/JobId'
    ReplyQueue:
      type: string
      description: >-
        Technical descriptor of reply queue where workers should put back the
        result.
      example: 647328648329632-34890742-3432
    OrganizationId:
      type: string
      description: Uniquely identifying ID of the organization.
      example: cdq_monitor
  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: true
      schema:
        type: string
        example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
    page:
      name: page
      in: query
      description: Current page number.
      required: false
      schema:
        type: integer
        format: int32
        example: '10'
    pageSize:
      name: pageSize
      in: query
      description: Number of items per page.
      required: false
      schema:
        type: integer
        format: int32
        example: '10'
    businessPartnerId:
      name: businessPartnerId
      in: query
      description: Business Partner IDs which should be filtered.
      required: false
      schema:
        type: array
        description: List of Business Partner IDs.
        items:
          $ref: '#/components/schemas/BusinessPartnerId'
    startAfter:
      name: startAfter
      in: query
      description: Used to retrieve the next page of results.
      required: false
      schema:
        $ref: '#/components/schemas/StartAfter'
    limit:
      name: limit
      in: query
      description: >-
        Number of results that should be fetched. Maximum 100 results can be
        returned in one page.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        format: int32
        default: 100
        example: '50'
    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
  responses:
    400_BadRequest:
      description: The sent request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
