openapi: 3.0.0
info:
  title: Data Validation API
  description: This API provides services used for business partner qualification
  version: '3'
servers:
  - description: Production
    url: https://api.cdq.com/data-validation/rest
    x-cdq-soap-url: https://api.corporate-data-league.ch/data-validation/soap/v3
security:
  - apiKey: []
tags:
  - name: Qualification
    description: >
      Provides funcionalities for qualification of Business Partners. Includes
      endpoints that allow users to submit Business 

      Partner data for qualification, retrieve qualification results, and handle
      various qualification scenarios.
  - name: Configuration
    description: >
      Provides funcionalities for managing configurations. Includes endpoints
      that allow users to create, update, and delete 

      configurations for the current user.
  - name: Public
    description: >
      Provides funcionalities to provide an RDF model of a record and validate a
      Business Partner.
  - name: Processing Logs
    description: >
      Provides funcionalities for managing processing logs. Includes endpoints
      that allow users to read processing log 

      results.
externalDocs:
  description: Data Validation API
  url: https://meta.cdq.com/API/Data_Validation_API
paths:
  /v3/businesspartners/qualify:
    post:
      x-wsdl: false
      x-cdq-beta: true
      tags:
        - Business Partners
        - Qualification
      summary: Qualify Business Partner
      description: >-
        <b style="color: white; background: #077fbb; border-radius: 5px;
        margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
        super;">BETA</b><br>Endpoint used for Business Partner qualification. It
        is in **BETA** version and may change without notice.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerQualificationRequest'
            examples:
              simpleQualification:
                summary: Standard qualification request example for a given identifier
                value:
                  profile: EU_TAX_QUALIFICATION
                  businessPartner:
                    names:
                      - value: ATOS SPAIN SA
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_ES
                        value: A28240752
                    addresses:
                      - country:
                          shortName: ES
              standardQualificationWithDebugInfo:
                summary: Qualification request for Eu_Tax_Qualification and debug info
                value:
                  profile: EU_TAX_QUALIFICATION
                  businessPartner:
                    names:
                      - value: ATOS SPAIN SA
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_ES
                        value: A28240752
                    addresses:
                      - country:
                          shortName: ES
                  featuresOn:
                    - SHOW_DEBUG_INFO
              qualificationExampleForDefaultWithMissingProfile:
                summary: >-
                  Qualification request for missing profile, where default
                  Eu_Tax_Qualification will be used instead
                value:
                  businessPartner:
                    names:
                      - value: ATOS SPAIN SA
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_ES
                        value: A28240752
                    addresses:
                      - country:
                          shortName: ES
              qualificationForIncorrectIdentifier:
                summary: Qualification request for incorrect identifier
                value:
                  profile: EU_TAX_QUALIFICATION
                  businessPartner:
                    names:
                      - value: ATOS SPAIN SA
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_ES
                        value: A28240752XX
                    addresses:
                      - country:
                          shortName: ES
              qualificationWithEmptyDatasourceResponse:
                summary: >-
                  Qualification request for a case where a datasource is not
                  processed and contains an empty response
                value:
                  profile: WORLDWIDE_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  dataSources:
                    - BZST
                    - VIES
                  businessPartner:
                    names:
                      - value: CDQ GmbH
                    identifiers:
                      - value: DE307699628
                        type:
                          technicalKey: EU_VAT_ID_DE
                    addresses:
                      - country:
                          shortName: DE
                        localities:
                          - value: Friedrichshafen
                        postCodes:
                          - value: '88045'
                        thoroughfares:
                          - value: Albrechtstraße
              qualificationWithIncorrectDatasource:
                summary: Qualification request containing a nonexistent datasource
                value:
                  profile: WORLDWIDE_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  dataSources:
                    - ABC
                  businessPartner:
                    names:
                      - value: CDQ GmbH
                    identifiers:
                      - value: DE307699628
                        type:
                          technicalKey: EU_VAT_ID_DE
                    addresses:
                      - country:
                          shortName: DE
                        localities:
                          - value: Friedrichshafen
                        postCodes:
                          - value: '88045'
                        thoroughfares:
                          - value: Albrechtstraße
              requestWithFrenchBusinessPartner:
                summary: Qualification of a French Business Partner
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: SAS DB COMPANY
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: FR
                        localities:
                          - value: Roubaix
                        postCodes:
                          - value: '59100'
                        thoroughfares:
                          - value: Rue De Tourcoing
              requestWithFrenchBusinessPartnerTypo:
                summary: Qualification of a French Business Partner with a typo
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: SAS DB COMPANY
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: FR
                        localities:
                          - value: Roubaixe
                        postCodes:
                          - value: '59100'
                        thoroughfares:
                          - value: Rue De Tourcoing
              requestWithFrenchBusinessPartnerSignTypo:
                summary: >-
                  Qualification of a French Business Partner with significant
                  typo
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: SAS DB COMPANY
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: FR
                        localities:
                          - value: Roubaixe
                        postCodes:
                          - value: '591000'
                        thoroughfares:
                          - value: Rue De Tourcoing
              requestWithFrenchBusinessPartnerMoreTypos:
                summary: Qualification of a French Business Partner with more typos
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: SAS DB COMPANY
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: FR
                        localities:
                          - value: Roubaixe
                        postCodes:
                          - value: '591000'
                        thoroughfares:
                          - value: Rue De Tourcoingesop
              requestWithCzechBusinessPartner:
                summary: Qualification of a Czech Business Partner
                value:
                  profile: WORLDWIDE_TAX_QUALIFICATION
                  dataSources:
                    - CZ.REE
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: Budweiser Gastro s.r.o.
                    addresses:
                      - country:
                          shortName: CZ
                        localities:
                          - value: České Budějovice
                        postCodes:
                          - value: '37001'
                        thoroughfares:
                          - value: Hroznová
                    identifiers:
                      - value: '28107152'
                        type:
                          technicalKey: CZ_ICO
              requestWithAustralianBusinessPartner:
                summary: Qualification of an Australian Business Partner
                value:
                  profile: WORLDWIDE_TAX_QUALIFICATION
                  dataSources:
                    - AU.BR
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: BAYER PTY LTD
                    identifiers:
                      - value: '64481100531'
                        type:
                          technicalKey: ABN_AU
                    addresses:
                      - country:
                          shortName: AU
                        localities:
                          - value: ''
                        postCodes:
                          - value: '5142'
                        thoroughfares:
                          - value: ''
              requestWithGermanBusinessPartner:
                summary: Qualification of a Polish Business Partner
                value:
                  profile: WORLDWIDE_TAX_QUALIFICATION
                  dataSources:
                    - PL.NOBR
                    - VIES
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: CDQ POLAND SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ
                    identifiers:
                      - value: PL8992790965
                        type:
                          technicalKey: EU_VAT_ID_PL
                      - value: '364493408'
                        type:
                          technicalKey: PL_REG
                    addresses:
                      - country:
                          shortName: PL
                        localities:
                          - value: Wrocław
                        postCodes:
                          - value: 50-078
                        thoroughfares:
                          - value: Stanisława Leszczyńskiego
              requestWithBusinessPartnerUpdateIdentifierFakeData:
                summary: Business Partner update based on identifier and fake data
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    names:
                      - value: X
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: X
                        localities:
                          - value: X
                        postCodes:
                          - value: X
                        thoroughfares:
                          - value: X
              requestWithBusinessPartnerUpdateIdentifier:
                summary: Business Partner update based on identifier only
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
              requestWithBusinessPartnerUpdateLookup:
                summary: Business Partner update based on Lookup results
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                    - SHOW_LOOKUP_RESULTS
                  businessPartner:
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
              requestWithFrenchBusinessPartnerIdentifierOnly:
                summary: Qualification of a French Business Partner identifier only
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    identifiers:
                      - value: FR35852293547
                        type:
                          technicalKey: EU_VAT_ID_FR
              requestWithGermanBusinessPartnerIdentifierOnlyATFON:
                summary: >-
                  Qualification of a German Business Partner identifier using
                  only AT.FON
                value:
                  profile: EU_TAX_QUALIFICATION
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    identifiers:
                      - value: DE307699628
                        type:
                          technicalKey: EU_VAT_ID_DE
              requestWithGermanBusinessPartnerIdentifierOnlyVIES:
                summary: >-
                  Qualification of a German Business Partner identifier using
                  only VIES
                value:
                  profile: EU_TAX_QUALIFICATION
                  dataSources:
                    - VIES
                  featuresOn:
                    - FORCE_EXTERNAL_CALL
                  businessPartner:
                    identifiers:
                      - value: DE307699628
                        type:
                          technicalKey: EU_VAT_ID_DE
        description: cmd
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerQualificationResult'
              examples:
                simpleQualification:
                  summary: >-
                    Standard qualification response example for a given
                    identifier
                  value:
                    qualificationResults:
                      - identifier:
                          value: A28240752
                          type:
                            technicalKey: EU_VAT_ID_ES
                        qualifiedAt: '2023-10-03T16:37:19.252354829'
                        qualificationDecisionSummary:
                          identifierQualificationDecision: VALID
                          nameQualificationDecision: VALID
                          addressQualificationDecision: NO_INPUT_PROVIDED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NO_INPUT_PROVIDED
                            postCodeQualificationDecision: NO_INPUT_PROVIDED
                            thoroughfareQualificationDecision: NO_INPUT_PROVIDED
                          overallQualificationDecision: VALID
                        qualificationDecisionDetails:
                          - businessRule:
                              name: >-
                                Name Qualification (European value added tax
                                identifier (Spain), Data source:VIES)
                              url: >-
                                https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)
                              ruleStatus: HYPERCARE
                              violationMessage: >-
                                Name deviates from the reference name registered
                                with the European value added tax identifier
                                (Spain)
                            executionContextProperties:
                              - type: qualificationTarget
                                value: NAME_LOCAL
                              - type: targetInputValue
                                value: ATOS SPAIN SA
                              - type: targetReferenceValue
                                value: ATOS SPAIN SA
                            dataSourceTechnicalKey: VIES
                            cdqId: VIES:ESA28240752
                            decision: VALID
                            error: {}
                    lookupResults:
                      - businessPartner:
                          addresses:
                            - version:
                                characterSet:
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: ES
                                value: Spain
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                                name: VAT Registered Name
                                technicalKey: VAT_REGISTERED
                              value: ATOS SPAIN SA
                              language: {}
                          identifiers:
                            - value: ESA28240752
                              type:
                                url: >-
                                  https://meta.cdq.com/European_value_added_tax_identifier_(Spain)
                                name: Value added tax identification number
                                technicalKey: EU_VAT_ID_ES
                              issuingBody: {}
                          legalForm:
                            name: Sociedad Anónima
                            mainAbbreviation: S.A.
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035
                            technicalKey: ES_1035
                          status: {}
                          profile: {}
                        address: {}
                        dataSource: VIES
                        cdqId: VIES:ESA28240752
                    debugInfo:
                      externalServiceResponses:
                        - status: 200
                          timestamp: '2023-10-03T14:37:19.125086Z'
                          additionalInformation:
                            - key: requestorId
                              value: DE307699628
                            - key: requestId
                              value: WAPIAAAAYr1-NB3H
                            - key: rawJson
                              value: >-
                                [{"vatValue":{"value":"A28240752"},"requestDate":{"value":"2023-10-02T22:00:00.000+00:00"},"countryCode":{"value":"ES"},"valid":{"value":true},"traderAddress":{},"traderName":{"value":"ATOS
                                SPAIN
                                SA"},"traderCompanyType":{},"traderStreet":{},"traderPostcode":{},"traderCity":{},"traderNameMatch":{"value":"1"},"traderCompanyTypeMatch":{"value":"3"},"traderStreetMatch":{"value":"3"},"traderPostcodeMatch":{"value":"3"},"traderCityMatch":{"value":"3"},"requestIdentifier":{"value":"WAPIAAAAYr1-NB3H"},"requesterVatNumber":"307699628","requesterCountryCode":"DE"}]
                      businessRulesExecutionSummary:
                        numberOfRules: 0
                        numberOfExecutions: 0
                        numberOfFails: 0
                standardQualificationWithDebugInfo:
                  summary: >-
                    Qualification response for Eu_Tax_Qualification and debug
                    info
                  value:
                    qualificationResults:
                      - identifier:
                          value: A28240752
                          type:
                            technicalKey: EU_VAT_ID_ES
                        qualifiedAt: '2023-10-03T08:59:45.976135816'
                        qualificationDecisionSummary:
                          identifierQualificationDecision: VALID
                          nameQualificationDecision: VALID
                          addressQualificationDecision: NO_INPUT_PROVIDED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NO_INPUT_PROVIDED
                            postCodeQualificationDecision: NO_INPUT_PROVIDED
                            thoroughfareQualificationDecision: NO_INPUT_PROVIDED
                          overallQualificationDecision: VALID
                        qualificationDecisionDetails:
                          - businessRule:
                              name: >-
                                Name Qualification (European value added tax
                                identifier (Spain), Data source:VIES)
                              url: >-
                                https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)
                              ruleStatus: HYPERCARE
                              violationMessage: >-
                                Name deviates from the reference name registered
                                with the European value added tax identifier
                                (Spain)
                            executionContextProperties:
                              - type: qualificationTarget
                                value: NAME_LOCAL
                              - type: targetInputValue
                                value: ATOS SPAIN SA
                              - type: targetReferenceValue
                                value: ATOS SPAIN SA
                            dataSourceTechnicalKey: VIES
                            cdqId: VIES:ESA28240752
                            decision: VALID
                            error: {}
                    lookupResults:
                      - businessPartner:
                          addresses:
                            - version:
                                characterSet:
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: ES
                                value: Spain
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                                name: VAT Registered Name
                                technicalKey: VAT_REGISTERED
                              value: ATOS SPAIN SA
                              language: {}
                          identifiers:
                            - value: ESA28240752
                              type:
                                url: >-
                                  https://meta.cdq.com/European_value_added_tax_identifier_(Spain)
                                name: Value added tax identification number
                                technicalKey: EU_VAT_ID_ES
                              issuingBody:
                                name: Spanish Tax Administration Agency
                                url: >-
                                  https://meta.cdq.com/Business_partner/identifier/issuing_body/CDQ00046
                                technicalKey: ES_CDQ00046
                          legalForm:
                            name: Sociedad Anónima
                            mainAbbreviation: S.A.
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035
                            technicalKey: ES_1035
                          status: {}
                          profile: {}
                        address: {}
                        dataSource: VIES
                        cdqId: VIES:ESA28240752
                    debugInfo:
                      externalServiceResponses:
                        - status: 200
                          timestamp: '2023-10-03T06:59:45.825291Z'
                          additionalInformation:
                            - key: requestorId
                              value: DE307699628
                            - key: requestId
                              value: WAPIAAAAYr0Vej6Q
                            - key: rawJson
                              value: >-
                                [{"vatValue":{"value":"A28240752"},"requestDate":{"value":"2023-10-02T22:00:00.000+00:00"},"countryCode":{"value":"ES"},"valid":{"value":true},"traderAddress":{},"traderName":{"value":"ATOS
                                SPAIN
                                SA"},"traderCompanyType":{},"traderStreet":{},"traderPostcode":{},"traderCity":{},"traderNameMatch":{"value":"1"},"traderCompanyTypeMatch":{"value":"3"},"traderStreetMatch":{"value":"3"},"traderPostcodeMatch":{"value":"3"},"traderCityMatch":{"value":"3"},"requestIdentifier":{"value":"WAPIAAAAYr0Vej6Q"},"requesterVatNumber":"307699628","requesterCountryCode":"DE"}]
                      businessRulesExecutionSummary:
                        numberOfRules: 0
                        numberOfExecutions: 0
                        numberOfFails: 0
                qualificationExampleForDefaultWithMissingProfile:
                  summary: >-
                    Qualification response for missing profile, where default
                    Eu_Tax_Qualification will be used instead
                  value:
                    qualificationResults:
                      - identifier:
                          value: A28240752
                          type:
                            technicalKey: EU_VAT_ID_ES
                        qualifiedAt: '2023-10-03T16:48:54.053488628'
                        qualificationDecisionSummary:
                          identifierQualificationDecision: VALID
                          nameQualificationDecision: VALID
                          addressQualificationDecision: NO_INPUT_PROVIDED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NO_INPUT_PROVIDED
                            postCodeQualificationDecision: NO_INPUT_PROVIDED
                            thoroughfareQualificationDecision: NO_INPUT_PROVIDED
                          overallQualificationDecision: VALID
                        qualificationDecisionDetails:
                          - businessRule:
                              name: >-
                                Name Qualification (European value added tax
                                identifier (Spain), Data source:VIES)
                              url: >-
                                https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)
                              ruleStatus: HYPERCARE
                              violationMessage: >-
                                Name deviates from the reference name registered
                                with the European value added tax identifier
                                (Spain)
                            executionContextProperties:
                              - type: qualificationTarget
                                value: NAME_LOCAL
                              - type: targetInputValue
                                value: ATOS SPAIN SA
                              - type: targetReferenceValue
                                value: ATOS SPAIN SA
                            dataSourceTechnicalKey: VIES
                            cdqId: VIES:ESA28240752
                            decision: VALID
                            error: {}
                    lookupResults:
                      - businessPartner:
                          addresses:
                            - version:
                                characterSet:
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: ES
                                value: Spain
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                                name: VAT Registered Name
                                technicalKey: VAT_REGISTERED
                              value: ATOS SPAIN SA
                              language: {}
                          identifiers:
                            - value: ESA28240752
                              type:
                                url: >-
                                  https://meta.cdq.com/European_value_added_tax_identifier_(Spain)
                                name: Value added tax identification number
                                technicalKey: EU_VAT_ID_ES
                              issuingBody: {}
                          legalForm:
                            name: Sociedad Anónima
                            mainAbbreviation: S.A.
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035
                            technicalKey: ES_1035
                          status: {}
                          profile: {}
                        address: {}
                        dataSource: VIES
                        cdqId: VIES:ESA28240752
                    debugInfo:
                      externalServiceResponses:
                        - status: 200
                          timestamp: '2023-10-03T14:48:53.807096Z'
                          additionalInformation:
                            - key: requestorId
                              value: DE307699628
                            - key: requestId
                              value: WAPIAAAAYr2A2pYc
                            - key: rawJson
                              value: >-
                                [{"vatValue":{"value":"A28240752"},"requestDate":{"value":"2023-10-02T22:00:00.000+00:00"},"countryCode":{"value":"ES"},"valid":{"value":true},"traderAddress":{},"traderName":{"value":"ATOS
                                SPAIN
                                SA"},"traderCompanyType":{},"traderStreet":{},"traderPostcode":{},"traderCity":{},"traderNameMatch":{"value":"1"},"traderCompanyTypeMatch":{"value":"3"},"traderStreetMatch":{"value":"3"},"traderPostcodeMatch":{"value":"3"},"traderCityMatch":{"value":"3"},"requestIdentifier":{"value":"WAPIAAAAYr2A2pYc"},"requesterVatNumber":"307699628","requesterCountryCode":"DE"}]
                      businessRulesExecutionSummary:
                        numberOfRules: 0
                        numberOfExecutions: 0
                        numberOfFails: 0
                qualificationForIncorrectIdentifier:
                  summary: Qualification response for incorrect identifier
                  value:
                    qualificationResults:
                      - identifier:
                          value: A28240752XX
                          type:
                            technicalKey: EU_VAT_ID_ES
                        qualifiedAt: '2023-10-03T16:56:31.224350822'
                        qualificationDecisionSummary:
                          identifierQualificationDecision: VALID
                          nameQualificationDecision: VALID
                          addressQualificationDecision: NO_INPUT_PROVIDED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NO_INPUT_PROVIDED
                            postCodeQualificationDecision: NO_INPUT_PROVIDED
                            thoroughfareQualificationDecision: NO_INPUT_PROVIDED
                          overallQualificationDecision: VALID
                        qualificationDecisionDetails:
                          - businessRule:
                              name: >-
                                Name Qualification (European value added tax
                                identifier (Spain), Data source:VIES)
                              url: >-
                                https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)
                              ruleStatus: HYPERCARE
                              violationMessage: >-
                                Name deviates from the reference name registered
                                with the European value added tax identifier
                                (Spain)
                            executionContextProperties:
                              - type: qualificationTarget
                                value: NAME_LOCAL
                              - type: targetInputValue
                                value: ATOS SPAIN SA
                              - type: targetReferenceValue
                                value: ATOS SPAIN SA
                            dataSourceTechnicalKey: VIES
                            cdqId: VIES:ESA28240752
                            decision: VALID
                            error:
                              message: 'Error from VIES: The input is invalid.'
                              status: 201
                              id: REF_VIES_INVALID_INPUT_201
                    lookupResults:
                      - businessPartner:
                          addresses:
                            - version:
                                characterSet:
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: ES
                                value: Spain
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                                name: VAT Registered Name
                                technicalKey: VAT_REGISTERED
                              value: ATOS SPAIN SA
                              language: {}
                          identifiers:
                            - value: ESA28240752
                              type:
                                url: >-
                                  https://meta.cdq.com/European_value_added_tax_identifier_(Spain)
                                name: Value added tax identification number
                                technicalKey: EU_VAT_ID_ES
                              issuingBody: {}
                          legalForm:
                            name: Sociedad Anónima
                            mainAbbreviation: S.A.
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035
                            technicalKey: ES_1035
                          status: {}
                          profile: {}
                        address: {}
                        dataSource: VIES
                        cdqId: VIES:ESA28240752
                    debugInfo:
                      externalServiceResponses:
                        - status: 0
                          message: 'Error from VIES: The input is invalid.'
                          timestamp: '2023-10-03T14:56:31.252719Z'
                          additionalInformation:
                            - key: rawJson
                              value: '[]'
                      businessRulesExecutionSummary:
                        numberOfRules: 0
                        numberOfExecutions: 0
                        numberOfFails: 0
                qualificationWithEmptyDatasourceResponse:
                  summary: >-
                    Qualification response for a case where a datasource is not
                    processed and contains an empty response
                  value:
                    qualificationResults:
                      - identifier:
                          value: DE307699628
                          type:
                            technicalKey: EU_VAT_ID_DE
                        qualifiedAt: '2024-07-05T13:16:40.305822769'
                        dataSourceTechnicalKey: BZST
                        qualificationDecisionSummary:
                          identifierQualificationDecision: NOT_PROCESSED
                          nameQualificationDecision: NOT_PROCESSED
                          addressQualificationDecision: NOT_PROCESSED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NOT_PROCESSED
                            postCodeQualificationDecision: NOT_PROCESSED
                            thoroughfareQualificationDecision: NOT_PROCESSED
                          overallQualificationDecision: NOT_PROCESSED
                        qualificationDecisionDetails:
                          - error:
                              error: >-
                                This identifier is not supported or
                                configuration does not trigger any qualification
                                rules.
                              status: 200
                      - identifier:
                          value: DE307699628
                          type:
                            technicalKey: EU_VAT_ID_DE
                        qualifiedAt: '2024-07-05T13:16:40.306808907'
                        dataSourceTechnicalKey: VIES
                        dataSourceRequestIdentifiers:
                          - dataSourceTechnicalKey: VIES
                            value: WAPIAAAAZCCnEvSl
                        qualificationDecisionSummary:
                          identifierQualificationDecision: VALID
                          nameQualificationDecision: NOT_PROCESSED
                          addressQualificationDecision: NOT_PROCESSED
                          addressQualificationDecisionDetails:
                            localityQualificationDecision: NOT_PROCESSED
                            postCodeQualificationDecision: NOT_PROCESSED
                            thoroughfareQualificationDecision: NOT_PROCESSED
                          overallQualificationDecision: VALID
                        qualificationDecisionDetails:
                          - businessRule:
                              name: >-
                                Identifier Qualification (European value added
                                tax identifier (Germany), Data source:VIES)
                              url: >-
                                https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:VIES)
                              ruleStatus: RELEASED
                              violationMessage: >-
                                Identifier deviates from the reference
                                identifier registered with the European value
                                added tax identifier (Germany)
                            executionContextProperties:
                              - name: qualificationTarget
                                value: IDENTIFIER
                              - name: targetInputValue
                                value: DE307699628
                              - name: targetReferenceValue
                                value: DE307699628
                              - name: dataSourceTechnicalKey
                                value: VIES
                              - name: dataSourceRequestIdentifier
                                value: WAPIAAAAZCCnEvSl
                            cdqId: VIES:DE307699628
                            decision: VALID
                    debugInfo:
                      externalServiceResponses:
                        - status: 200
                          timestamp: '2024-07-05T11:16:39.782984282Z'
                          additionalInformation:
                            - key: requestorId
                              value: DE307699628
                            - key: requestId
                              value: WAPIAAAAZCCnEvSl
                            - key: rawJson
                              value: >-
                                [{"vatValue":{"value":"307699628"},"requestDate":{"value":"2024-07-04T22:00:00.000+00:00"},"countryCode":{"value":"DE"},"valid":{"value":true},"traderAddress":{},"traderName":{},"traderCompanyType":{},"traderStreet":{},"traderPostcode":{},"traderCity":{},"traderNameMatch":{},"traderCompanyTypeMatch":{},"traderStreetMatch":{},"traderPostcodeMatch":{},"traderCityMatch":{},"requestIdentifier":{"value":"WAPIAAAAZCCnEvSl"},"requesterVatNumber":"307699628","requesterCountryCode":"DE","refreshReason":"FORCED_BY_CUSTOMER"}]
                      businessRulesExecutionSummary:
                        numberOfRules: 1
                        numberOfExecutions: 1
                        numberOfFails: 0
                        dataSourcesOn:
                          - prefix: VIES
                          - prefix: BZST
                        ruleCategoriesOn:
                          - url: https://meta.cdq.com/Qualification
                          - url: https://meta.cdq.com/EU_TAX_Qualification
                          - url: https://meta.cdq.com/Worldwide_TAX_Qualification
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                qualificationWithIncorrectDatasource:
                  summary: >-
                    Qualification response for a request containing a
                    nonexistent datasource
                  value:
                    timestamp: '2024-07-04T15:52:35.084475194Z'
                    message: 'Requested datasource is not supported: ABC'
                    error: Bad Request
                    path: '%2Fv3%2Fbusinesspartners%2Fqualify'
                    status: 400
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /configurations/businesspartnervalidation:
    get:
      tags:
        - Configuration
      summary: List Users Configuration
      description: >-
        Fetches the current users' configuration. If no configuration exists, a
        default configuration is returned.
      parameters:
        - in: query
          name: startAfter
          description: >-
            Start after the given index. Use this to paginate through the
            results. The first page is returned if this parameter is not
            provided.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - in: query
          name: limit
          description: Maximum number of results to return. The default is 100.
          required: false
          schema:
            $ref: '#/components/schemas/Limit'
        - in: query
          name: defaultConfiguration
          required: false
          description: Is default workspace configuration of given type.
          schema:
            type: boolean
            example: true
        - in: query
          name: clientId
          required: false
          description: >-
            API Key ID or Client ID. When present returns only configurations
            assigned to the given API key.
          schema:
            type: string
            description: >-
              API Key ID or Client ID. When present returns only configurations
              assigned to the given API key.
            example: 12345678-1234-5678-1234-567812345678
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponsePage'
              examples:
                fetchConfigurations:
                  summary: Page of fetched configurations
                  value:
                    startAfter: '0'
                    nextStartAfter: '1'
                    total: 2
                    values:
                      - name: demo config
                        id: 63a1d4a07c855600fa769329
                        createdAt: '2022-12-20T15:28:32.684Z'
                        modifiedAt: '2022-12-20T15:28:32.684Z'
                        createdBy: demo
                      - name: demo config
                        id: 63a1d5a13b5faf2f613164c0
                        createdAt: '2022-12-20T15:32:49.579Z'
                        modifiedAt: '2022-12-20T15:32:49.579Z'
                        createdBy: demo
    post:
      tags:
        - Configuration
      summary: Create Configuration
      description: >
        Creates a new configuration for the current user. 

        The configuration is stored in the users workspace and can be used for
        validation of business partners and identifiers.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceConfigurationCreate'
            examples:
              createComplexConfiguration:
                summary: Showcase of creating configuration
                value:
                  name: demo config
                  configuration:
                    ignoredRules:
                      - >-
                        https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)
                      - >-
                        https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))
                    activatedRules:
                      - >-
                        https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)
                    featuresOff:
                      - ENRICH_LEGAL_FORM
                      - SHOW_DECISIONS
                    featuresOn:
                      - SHOW_LOOKUP_RESULTS
                      - SHOW_BUSINESSPARTNER
                      - SHOW_DATA_DEFECTS
                    ruleCategoriesOn:
                      - url: https://meta.cdq.ch/Missing_legal_form
                    criticalities:
                      - businessRuleUrl: https://meta.cdq.com/Dummy_post_code_detected_(AF)
                        violationLevel: WARNING
                      - businessRuleUrl: >-
                          https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)
                        violationLevel: INFO
                    ruleStatuses:
                      - RELEASED
                    dataSourcesOn:
                      - aleiPrefix: VIES
                    validationProfile: EU_VAT_QUALIFICATION
      responses:
        '200':
          description: Configuration created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponse'
              examples:
                createComplexConfiguration:
                  summary: Showcase response of creating configuration
                  value:
                    name: demo config
                    configuration:
                      ignoredRules:
                        - >-
                          https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)
                        - >-
                          https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))
                      activatedRules:
                        - >-
                          https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)
                      dataSourcesOn:
                        - aleiPrefix: VIES
                      featuresOff:
                        - ENRICH_LEGAL_FORM
                        - SHOW_DECISIONS
                      featuresOn:
                        - SHOW_LOOKUP_RESULTS
                        - SHOW_BUSINESSPARTNER
                        - SHOW_DATA_DEFECTS
                      criticalities:
                        - businessRuleUrl: https://meta.cdq.com/Dummy_post_code_detected_(AF)
                          violationLevel: WARNING
                        - businessRuleUrl: >-
                            https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)
                          violationLevel: INFO
                      ruleStatuses:
                        - RELEASED
                      validationProfile: EU_VAT_QUALIFICATION
                      ruleCategoriesOn:
                        - url: https://cdlplus-bayer.cdq.ch/CH.MEDREG_Monitoring
                    id: 63a1d5a1335faf2f613164c0
                    createdAt: '2022-12-20T15:32:49.579921335Z'
                    modifiedAt: '2022-12-20T15:32:49.579949313Z'
                    createdBy: demo
        '400':
          description: Bad Request.
  /configurations/businesspartnervalidation/{configurationId}:
    get:
      tags:
        - Configuration
      summary: Fetch Configuration
      description: Fetches an existing configuration for the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: Configuration updated successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponse'
              examples:
                getConfiguration:
                  summary: Showcase response of fetching configuration
                  value:
                    name: demo config
                    configuration:
                      ignoredRules:
                        - >-
                          https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)
                        - >-
                          https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))
                      activatedRules:
                        - >-
                          https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)
                      dataSourcesOn:
                        - aleiPrefix: VIES
                      featuresOff:
                        - ENRICH_LEGAL_FORM
                        - SHOW_DECISIONS
                      featuresOn:
                        - SHOW_LOOKUP_RESULTS
                        - SHOW_BUSINESSPARTNER
                        - SHOW_DATA_DEFECTS
                      criticalities:
                        - businessRuleUrl: https://meta.cdq.com/Dummy_post_code_detected_(AF)
                          violationLevel: WARNING
                        - businessRuleUrl: >-
                            https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)
                          violationLevel: INFO
                      ruleStatuses:
                        - RELEASED
                      validationProfile: EU_VAT_QUALIFICATION
                      ruleCategoriesOn:
                        - url: https://cdlplus-bayer.cdq.ch/CH.MEDREG_Monitoring
                    id: 63a1d5a13b5faf2f613164c0
                    createdAt: '2022-12-20T15:32:49.579Z'
                    modifiedAt: '2022-12-20T15:32:49.579Z'
                    createdBy: demo
    put:
      tags:
        - Configuration
      summary: Update Configuration
      description: Updates an existing configuration for the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceConfigurationUpdate'
            examples:
              clearConfigurationToDefaults:
                summary: Clear configuration
                value:
                  name: demo config
                  configuration: {}
      responses:
        '200':
          description: Configuration updated successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponse'
              examples:
                clearConfigurationToDefaults:
                  summary: Response of cleared configuration
                  value:
                    name: demo config
                    id: 63a1d5a13b5faf2f613164c0
                    createdAt: '2022-12-20T15:32:49.579Z'
                    modifiedAt: '2022-12-20T15:43:43.158949713Z'
                    createdBy: demo
        '400':
          description: Bad Request.
    delete:
      tags:
        - Configuration
      summary: Delete Configuration
      description: Deletes a configuration for the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponse'
        '400':
          description: Bad Request.
  /configurations/businesspartnervalidation/{configurationId}/versions/{version}:
    get:
      tags:
        - Configuration
      summary: Read Business Partner Validation Configuration Version
      description: >-
        Read a specific version of a business partner validation configuration
        by id and version number.
      parameters:
        - $ref: '#/components/parameters/configurationId'
        - $ref: '#/components/parameters/configurationVersion'
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationVersionResponse'
  /configurations/qualification:
    get:
      x-wsdl: false
      x-cdq-beta: true
      tags:
        - Configuration
      summary: List Tax Guard Identifier Qualification Configurations.
      description: >-
        <b style="color: white; background: #077fbb; border-radius: 5px;
        margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
        super;">BETA</b><br>List all Tax Guard Identifier Qualification
        configurations of the current user.
      parameters:
        - name: limit
          description: Maximum number of configurations to return. Used for pagination.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Limit'
        - name: startAfter
          description: >-
            ID of the last configuration returned in the previous request. Used
            for pagination.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - 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
        - in: query
          name: clientId
          required: false
          description: >-
            API Key ID or Client ID. When present returns only configurations
            assigned to the given API key.
          schema:
            type: string
            description: >-
              API Key ID or Client ID. When present returns only configurations
              assigned to the given API key.
            example: 12345678-1234-5678-1234-567812345678
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponsePage'
              examples:
                taxGuardConfigurations:
                  summary: Page of Tax Guard Identifier Qualification configurations
                  value:
                    startAfter: '0'
                    nextStartAfter: '1'
                    total: 2
                    values:
                      - name: demo config
                        id: 63a1d4a07c855600fa769329
                        createdAt: '2022-12-20T15:28:32.684Z'
                        modifiedAt: '2022-12-20T15:28:32.684Z'
                        createdBy: demo
                      - name: demo config
                        id: 63a1d5a13b5faf2f613164c0
                        createdAt: '2022-12-20T15:32:49.579Z'
                        modifiedAt: '2022-12-20T15:32:49.579Z'
                        createdBy: demo
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
  /configurations/qualification/{configurationId}:
    get:
      x-wsdl: false
      x-cdq-beta: true
      tags:
        - Configuration
      summary: Read Tax Guard Identifier Qualification Configuration
      description: >-
        <b style="color: white; background: #077fbb; border-radius: 5px;
        margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
        super;">BETA</b><br>Read an Tax Guard Identifier Qualification
        configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationResponse'
              examples:
                getConfiguration:
                  summary: >-
                    Showcase response of Tax Guard Identifier Qualification
                    configuration
                  value:
                    name: demo config
                    configuration:
                      ignoredRules:
                        - >-
                          https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)
                        - >-
                          https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))
                      activatedRules:
                        - >-
                          https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)
                      dataSourcesOn:
                        - aleiPrefix: VIES
                      featuresOff:
                        - SHOW_DEBUG_INFO
                      featuresOn:
                        - SHOW_LOOKUP_RESULTS
                        - SHOW_BUSINESS_PARTNER
                      criticalities:
                        - businessRuleUrl: https://meta.cdq.com/Dummy_post_code_detected_(AF)
                          violationLevel: WARNING
                        - businessRuleUrl: >-
                            https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)
                          violationLevel: INFO
                      ruleStatuses:
                        - RELEASED
                      validationProfile: EU_VAT_QUALIFICATION
                      ruleCategoriesOn:
                        - url: https://cdlplus-bayer.cdq.ch/CH.MEDREG_Monitoring
                    id: 63a1d5a13b5faf2f613164c0
                    createdAt: '2022-12-20T15:32:49.579Z'
                    modifiedAt: '2022-12-20T15:32:49.579Z'
                    createdBy: demo
        '400':
          description: Bad request, for example, missing organization ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithStatus'
  /configurations/qualification/{configurationId}/versions/{version}:
    get:
      x-wsdl: false
      x-cdq-beta: true
      tags:
        - Configuration
      summary: Read Tax Guard Identifier Qualification Configuration Version
      description: >-
        <b style="color: white; background: #077fbb; border-radius: 5px;
        margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
        super;">BETA</b><br>Read a specific version of an Tax Guard Identifier
        Qualification configuration by id and version number.
      parameters:
        - $ref: '#/components/parameters/configurationId'
        - $ref: '#/components/parameters/configurationVersion'
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationVersionResponse'
  /v2/recordvalidationjobs/{id}:
    get:
      x-wsdl: false
      tags:
        - Batch Validation
      summary: Poll Record Validation Job
      description: >
        Polls the status of a record validation job. The job is finished when
        the status is either `FINISHED` or `FAILED`. If the job is finished, the
        result can be fetched using the `/v2/recordvalidationjobs/{id}/results`
        endpoint.
      parameters:
        - $ref: '#/components/parameters/validationJobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordValidationJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/recordvalidationjobs:
    post:
      x-wsdl: false
      tags:
        - Batch Validation
      summary: Start Record Validation Job
      description: Starts a new validation job on a provided storage ID.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordValidationJob'
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/400_BadRequest'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordValidationJobRequest'
        description: cmd
        required: true
  /v2/recordvalidationjobs/{id}/results:
    get:
      x-wsdl: false
      tags:
        - Batch Validation
      summary: List Record Validation Batch Results
      description: Retrieve the results of a record validation job.
      parameters:
        - name: id
          in: path
          description: ID of the Record Validation Job.
          required: true
          schema:
            type: string
            example: 6be92567-4327-4463-813f-a8c990410d79
        - name: recordId
          in: query
          description: Record IDs which should be filtered.
          required: false
          schema:
            type: array
            description: List of Record IDs.
            items:
              type: string
              description: Record ID.
              example: 6be92567-4327-4463-813f-a8c990410d79
        - 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:
            $ref: '#/components/schemas/Limit'
            minimum: 1
            maximum: 100
            default: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordValidationJobResultPage'
  /v2/businesspartners/validate:
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Validate Business Partner
      description: >
        Validate business partners (i.e. identifiers, legal forms) and addresses
        (i.e. post codes) and receive a list of data defects in case of found
        data quality issues.


        #### Examples

        Check out our examples in the *Try it console* to better understand this
        endpoint.


        | Example   | Description     |

        | ---       |  ---            |

        | Identifier exists and is valid | No `dataDefects` related to the
        identifier and `identifierReliability.level` equals `4`. Note that there
        might be data defects if you provide more details than the identifier
        (i.e. address data).       |

        | Identifier does not exist in external data source | Entry in
        `dataDefects` related to the identifier and
        `identifierReliability.level` < 4 |

        | Unknown status for an identifier existence (only response example)|
        `identifierReliability.level` < `4`  and the respective `message` equals
        to `external service error`. You may try again as this is typical a
        temporary issue.|
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleBusinessPartnerValidationRequest'
            examples:
              wrongUid:
                summary: Recognize wrong UID from CDQ AG
                value:
                  businessPartner:
                    names:
                      - value: CDQ AG
                    identifiers:
                      - value: 218.608.886
                        type:
                          technicalKey: CH_UID
                    legalForm:
                      name: Aktiengesellschaft
                    addresses:
                      - country:
                          shortName: CH
                        thoroughfares:
                          - value: Lukasstrassse 4
                        localities:
                          - value: St.Gallen
                        postCodes:
                          - value: '9008'
              wrongCNPJ:
                summary: Recognize wrong  CNPJ from BASF SA
                value:
                  businessPartner:
                    names:
                      - value: BASF SA
                    identifiers:
                      - type:
                          technicalKey: BR_CNPJ
                        value: 48.539.407/00718-01
                    legalForm:
                      name: Anonymous Society
                    addresses:
                      - country:
                          shortname: BR
                        postCodes:
                          - value: 42810-020
                        localities:
                          - value: Camaçari
              activateSelectedRules:
                summary: >
                  Activate selected rules by providing list of rule URLs.
                  Expected result: Only results from selected rules are present.
                value:
                  profile: STANDARD
                  featuresOn:
                    - SHOW_DEBUG_INFO
                    - SHOW_BUSINESSPARTNER
                  activatedRules:
                    - >-
                      https://meta.cdq.com/Identifier_format_invalid_(NIP_number_(Poland))
                    - >-
                      https://meta.cdq.com/Mandatory_administrative_area_missing_(Poland)
                  businessPartner:
                    identifiers:
                      - value: '89927909651'
                        type:
                          technicalKey: PL_NIP
                    addresses:
                      - country:
                          shortName: PL
              activateNewQualificationMode:
                summary: >
                  Activate qualification for German business partners via
                  EU_VAT_QUALIFICATION profile and EU_VAT_QUALIFICATION_AT
                  feature. Expected result: Qualification in identifierResults
                  section.
                value:
                  profile: EU_VAT_QUALIFICATION
                  businessPartner:
                    names:
                      - value: CDQ GmbH
                    addresses:
                      - country:
                          shortName: DE
                        localities:
                          - value: Friedrichshafen
                        postCodes:
                          - value: '88045'
                        thoroughfares:
                          - value: Albrechtstraße  8
                    identifiers:
                      - value: DE307699628
                        type:
                          technicalKey: EU_VAT_ID_DE
                        issuingBody:
                          name: Federal Ministry of Finance, Bundesfinanzministerium
                  featuresOn:
                    - EU_VAT_QUALIFICATION_AT
                    - SHOW_DEBUG_INFO
                    - SHOW_BUSINESSPARTNER
                    - SHOW_LOOKUP_RESULTS
              oldQualification:
                summary: >
                  Activate qualification via EU_VAT_QUALIFICATION profile.
                  Expected result: Qualification in identifierResults section.
                value:
                  profile: EU_VAT_QUALIFICATION
                  businessPartner:
                    identifiers:
                      - value: FR09572067684
                        type:
                          technicalKey: EU_VAT_ID_FR
                    addresses:
                      - country:
                          shortName: FR
                        thoroughfares:
                          - value: Hardtstr. 12
                        postCodes:
                          - value: '70839'
                        localities:
                          - value: Gerlingen
              identifierExistsAndIsValid:
                summary: Identifier exists and is valid
                value:
                  profile: IDENTIFIER_QUALITY
                  businessPartner:
                    addresses:
                      - country:
                          shortName: DE
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_DE
                        value: DE307699628
              identifierDoesNotExistInExternalDataSource:
                summary: Identifier does not exist in external data source
                value:
                  profile: IDENTIFIER_QUALITY
                  businessPartner:
                    addresses:
                      - country:
                          shortName: DE
                    identifiers:
                      - type:
                          technicalKey: EU_VAT_ID_DE
                        value: DE119267630
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerValidationResult'
              examples:
                identifierExistsAndIsValid:
                  summary: Identifier exists and is valid
                  value:
                    summary:
                      validationLevel: OK
                      action: AUTO_APPROVE
                      statistics:
                        numberOfInfoDataDefects: 0
                        numberOfErrorDataDefects: 0
                        numberOfWarningDataDefects: 0
                    debugInfo:
                      businessRulesExecutionSummary:
                        numberOfRules: 398
                        numberOfExecutions: 398
                        numberOfFails: 0
                        ruleCategoriesOn:
                          - url: https://meta.cdq.com/Identifier_checkdigit
                          - url: https://meta.cdq.com/Country_invalid
                          - url: https://meta.cdq.com/Identifier_consistency
                          - url: https://meta.cdq.com/Identifier_missing
                          - url: https://meta.cdq.com/Identifier_format
                          - url: https://meta.cdq.com/Identifier_deprecation
                          - url: https://meta.cdq.com/Identifier_existence
                          - url: https://meta.cdq.com/Identifier_schema
                        violationLevels:
                          - INFO
                          - WARNING
                          - ERROR
                    identifierResults:
                      - property:
                          value: DE307699628
                          type: EU_VAT_ID_DE
                        reliabilityLevel:
                          name: Identifier existence
                          url: https://meta.cdq.com/Identifier_existence
                          value: 4
                          checks:
                            - name: Identifier checkdigit
                              url: https://meta.cdq.com/Identifier_checkdigit
                              value: 3
                              status: OK
                            - name: Identifier existence
                              url: https://meta.cdq.com/Identifier_existence
                              value: 4
                              status: OK
                            - name: Identifier format
                              url: https://meta.cdq.com/Identifier_format
                              value: 2
                              status: OK
                    businessPartner:
                      legalForm: {}
                      identifiers:
                        - value: DE307699628
                          type:
                            technicalKey: EU_VAT_ID_DE
                          issuingBody: {}
                      addresses:
                        - version:
                            characterSet: {}
                            language: {}
                          country:
                            shortName: DE
                            value: Germany
                      profile: {}
                identifierDoesNotExistInExternalDataSource:
                  summary: Identifier does not exist in external data source
                  value:
                    dataDefects:
                      - violationLevel": ERROR
                    identifierReliability:
                      level: 3
                unknownValidityForAnIdentifier:
                  summary: Unknown validity for an identifier existence
                  value:
                    summary:
                      validationLevel: OK
                      action: AUTO_APPROVE
                      statistics:
                        numberOfInfoDataDefects: 0
                        numberOfErrorDataDefects: 0
                        numberOfWarningDataDefects: 0
                    debugInfo:
                      businessRulesExecutionSummary:
                        numberOfRules: 398
                        numberOfExecutions: 397
                        numberOfFails: 1
                        ruleCategoriesOn:
                          - url: https://meta.cdq.com/Identifier_checkdigit
                          - url: https://meta.cdq.com/Country_invalid
                          - url: https://meta.cdq.com/Identifier_consistency
                          - url: https://meta.cdq.com/Identifier_missing
                          - url: https://meta.cdq.com/Identifier_format
                          - url: https://meta.cdq.com/Identifier_deprecation
                          - url: https://meta.cdq.com/Identifier_existence
                          - url: https://meta.cdq.com/Identifier_schema
                        violationLevels:
                          - INFO
                          - WARNING
                          - ERROR
                    identifierResults:
                      - property:
                          value: DE119267630
                          type: EU_VAT_ID_DE
                        reliabilityLevel:
                          name: Identifier checkdigit
                          url: https://meta.cdq.com/Identifier_checkdigit
                          value: 3
                          checks:
                            - name: Identifier checkdigit
                              url: https://meta.cdq.com/Identifier_checkdigit
                              value: 3
                              status: OK
                            - name: Identifier existence
                              url: https://meta.cdq.com/Identifier_existence
                              value: 4
                              status: FAILED
                              message: external service error
                            - name: Identifier format
                              url: https://meta.cdq.com/Identifier_format
                              value: 2
                              status: OK
                    businessPartner:
                      legalForm: {}
                      identifiers:
                        - value: DE119267630
                          type:
                            technicalKey: EU_VAT_ID_DE
                          issuingBody: {}
                      addresses:
                        - version:
                            characterSet: {}
                            language: {}
                          country:
                            shortName: DE
                            value: Germany
                      profile: {}
            application/xml:
              schema:
                $ref: '#/components/schemas/BusinessPartnerValidationResult'
  /v2/businesspartnervalidationjobs:
    post:
      x-wsdl: false
      tags:
        - Batch Validation
      summary: Start Business Partner Validation Job
      description: Start a new validation job on a provided storage ID.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerValidationJob'
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/400_BadRequest'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerValidationJobRequest'
            examples:
              example:
                summary: Full example
                value:
                  storageId: YOUR_STORAGE_ID
                  profile: EU_VAT_QUALIFICATION
                  featuresOn:
                    - SHOW_LOOKUP_RESULTS
                  featuresOff:
                    - SHOW_LOOKUP_RESULTS
                  ruleStatuses:
                    - RELEASED
                  vatAtRequestor: AT123456789
                  vatDeRequestor: DE123456789
                  bzstPrint: true
                  validationSource: BZST
                  reportsRequest:
                    reportsConfiguration:
                      address:
                        build: false
                      businesspartner:
                        build: false
                      identifier:
                        build: false
                      overall:
                        build: false
                      qualification:
                        build: true
                      qualityImprovement:
                        build: false
                        dataValidationJobIds:
                          - 6be92567-4327-4463-813f-a8c990410d79
                          - f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb
                      countryShortNames: '[''PL'', ''DE'', ''CZ'', ''SK'']'
                  dataSourcesOn:
                    - prefix: string
                  dataSourcesOff:
                    - prefix: string
                  ruleCategoriesOn:
                    - url: string
                      name: string
                  ignoredRules:
                    - string
                  activatedRules:
                    - string
                  updatedFrom: '2020-07-06T12:14:03.204Z'
                  dataSourceIds:
                    - string
                  countryShortNames:
                    - string
                  configurationId: string
                  criticalities:
                    - businessRuleUrl: string
                      violationLevel: NO_DEFECT
              tutorial:
                summary: Run UE VAT Qualification Job
                value:
                  storageId: YOUR_STORAGE_ID
                  profile: EU_VAT_QUALIFICATION
                  featuresOn:
                    - SHOW_LOOKUP_RESULTS
        description: cmd
        required: true
  /v2/businesspartnervalidationjobs/{id}/results:
    get:
      x-wsdl: false
      tags:
        - Batch Validation
      summary: List Business Partner Validation Batch Results
      description: Retrieve the results of a Business Partner validation job.
      parameters:
        - name: id
          in: path
          description: ID of the Lookup Job.
          required: true
          schema:
            $ref: '#/components/schemas/LookupJobId'
        - $ref: '#/components/parameters/BusinessPartnerId'
        - name: startAfter
          in: query
          description: Only records with an ID greater than this ID will be fetched.
          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:
            $ref: '#/components/schemas/Limit'
            minimum: 1
            maximum: 100
            default: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerValidationJobResultPage'
  /v2/validationlogs/{storageId}/results:
    get:
      x-wsdl: true
      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:
        - $ref: '#/components/parameters/StorageId'
        - $ref: '#/components/parameters/ProcessingLogId'
        - name: businessPartnerId
          in: query
          description: Business Partner IDs which should be filtered.
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: dataSourceId
          in: query
          description: 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: Only records with an ID greater than this ID will be fetched.
          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:
            $ref: '#/components/schemas/Limit'
            minimum: 1
            maximum: 100
            default: 100
            example: '100'
        - name: from
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result data was
            created.
          required: false
          schema:
            type: string
            example: '2025-10-07T05:40:33Z'
        - name: to
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result data was
            created.
          required: false
          schema:
            type: string
            example: '2025-10-07T05:40:33Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProcessingLogResultPage'
  /v2/records/validate:
    post:
      x-wsdl: true
      tags:
        - Records
      summary: Validate Record
      description: >-
        Validates a custom record. If the custom knowledge graph also contains a
        mapping, the mapping is applied ad-hoc and CDL validation rules are
        applied as well.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleRecordValidationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordValidationResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RecordValidationResult'
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
  schemas:
    ConfigurationId:
      type: string
      description: >
        Configuration ID used to set up data validation request. If provided,
        those parameters will be overridden:

        * `profile`

        * `featuresOn`

        * `featuresOff`
      example: 6513d25b63cf07787018790a
    KnowledgeGraphRequest:
      type: object
      description: Knowledge graph with optional mapping.
      properties:
        knowledgeGraphName:
          type: string
          description: Knowledge graph's name.
          example: kg_1_m_1
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
    DataValidationRequestFeatures:
      type: string
      description: Features on and off - used in the data validation process.
      example: V3_DATA_VALIDATION_FEATURE_1
      enum:
        - V3_DATA_VALIDATION_FEATURE_1
        - V3_DATA_VALIDATION_FEATURE_2
      x-enumDescriptions:
        V3_DATA_VALIDATION_PROFILE_1: Triggers specific behaviours for FEATURE_1.
        V3_DATA_VALIDATION_PROFILE_2: Triggers specific behaviours for FEATURE_2.
    DataValidationRequestProfile:
      type: string
      description: Profile used in the data validation process.
      example: V3_DATA_VALIDATION_PROFILE_1
      enum:
        - V3_DATA_VALIDATION_PROFILE_1
        - V3_DATA_VALIDATION_PROFILE_2
      x-enumDescriptions:
        V3_DATA_VALIDATION_PROFILE_1: Triggers specific behaviours for PROFILE_1.
        V3_DATA_VALIDATION_PROFILE_2: Triggers specific behaviours for PROFILE_2.
    DataMapperDefinitionId:
      type: string
      description: >-
        Mapping ID that should be used for the mapping. Overrules a mapping of
        the knowledge graph (if exists). To run validation against CDL Rules,
        data mapping definition by given ID must exist and user executing
        validation needs to have permission to access it.
      example: ef48bc9f-7fa1-4c4e-8c0d-d1cc3301cc20
    BusinessPartnerQualificationRequest:
      type: object
      description: Represents a request to qualify a Business Partner.
      properties:
        dataSources:
          type: array
          description: List of data sources should be used.
          items:
            $ref: '#/components/schemas/DataSourcesEnum'
        profile:
          $ref: '#/components/schemas/BusinessPartnerQualificationRequestProfileEnum'
        featuresOn:
          type: array
          description: Request features that should be turned on.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerQualificationRequestFeaturesEnum
        featuresOff:
          type: array
          description: Request features that should be turned off.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerQualificationRequestFeaturesEnum
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    BusinessPartnerQualificationResult:
      type: object
      description: Represents the result of a Business Partner qualification.
      properties:
        qualificationResults:
          type: array
          description: List of Qualifications Results.
          items:
            $ref: '#/components/schemas/BusinessPartnerQualificationResultItem'
        rulesInError:
          $ref: '#/components/schemas/RulesInError'
        lookupResults:
          type: array
          description: List of Lookup Results.
          items:
            $ref: '#/components/schemas/LookupResult'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    BusinessPartnerQualificationResultItem:
      type: object
      description: Represents an item in the result of a Business Partner qualification.
      properties:
        identifier:
          $ref: '#/components/schemas/IdentifierParam'
        businessPartnerStatus:
          $ref: '#/components/schemas/BusinessPartnerOperationalStatus'
        qualifiedAt:
          type: string
          description: Date and time of qualification.
          example: '2025-10-07T05:40:33Z'
        dataSourceTechnicalKey:
          type: string
          description: Data source used for qualification
          example: VIES
        dataSourceRequestIdentifiers:
          type: array
          description: List of Request Identifiers.
          items:
            $ref: '#/components/schemas/QualificationRequestIdentifier'
        qualificationDecisionSummary:
          $ref: '#/components/schemas/QualificationDecisionSummary'
        qualificationDecisionDetails:
          type: array
          description: List of Qualification Decision Details.
          items:
            $ref: '#/components/schemas/QualificationDecisionDetails'
    QualificationDecisionSummary:
      type: object
      description: Provides a concise summary of a qualification decision.
      properties:
        identifierQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        nameQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        addressQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        addressQualificationDecisionDetails:
          $ref: '#/components/schemas/AddressQualificationDecisionDetails'
        overallQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
    AddressQualificationDecisionDetails:
      type: object
      description: Represents the details of a qualification decision for an address.
      properties:
        localityQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        postCodeQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        thoroughfareQualificationDecision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
    BusinessPartnerOperationalStatus:
      type: object
      description: Represents the operational status of the business partner.
      properties:
        type:
          type: object
          description: Describes the type of business partner status.
          properties:
            name:
              type: string
              description: Name of the business partner status.
              example: Active
            url:
              type: string
              description: >-
                URL linking to more information about the business partner
                status.
              example: >-
                https://meta.cdq.com/Business_partner/status/type/technical_key/active
            technicalKey:
              type: string
              description: Technical key associated with the business partner status.
              example: ACTIVE
    QualificationDecisionDetails:
      type: object
      description: Represents the details of a qualification decision.
      properties:
        businessRule:
          $ref: '#/components/schemas/DetailsBusinessRule'
        executionContextProperties:
          type: array
          description: List of Execution Context Properties.
          items:
            $ref: '#/components/schemas/ExecutionContextProperty'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
        decision:
          $ref: '#/components/schemas/QualificationDecisionEnum'
        error:
          $ref: '#/components/schemas/ApiError'
    DetailsBusinessRule:
      type: object
      description: Represents a Business Rule.
      allOf:
        - $ref: '#/components/schemas/BusinessRule'
        - type: object
          description: Business rule that was executed.
          properties:
            violationMessage:
              type: string
              description: Violation message that is returned with detected data defect.
              example: Business Partner identifier is mandatory.
    ExecutionContextProperty:
      type: object
      description: Represents an execution context property.
      properties:
        name:
          type: string
          description: Descriptive name of the context’s attribute
          example: qualificationTarget
        value:
          type: string
          description: Value of the context execution attribute
          example: STREET
    LookupResult:
      type: object
      description: Contains data that was received from external data source.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        address:
          $ref: '#/components/schemas/Address'
        matchingScore:
          type: number
          description: Matching score of the lookup result.
          example: '0.9'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        cdqId:
          type: string
          description: CDQ ID of the business partner.
          example: VIES:DE119267630
    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.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/Address'
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/Name'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/Identifier'
        legalForm:
          $ref: '#/components/schemas/LegalForm'
        bankAccounts:
          type: array
          description: List of bank accounts of the Business Partner.
          items:
            $ref: '#/components/schemas/BankAccount'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
    DataSourcesEnum:
      type: string
      description: Data sources enum.
      example: AR.NRC
      enum:
        - AR.NRC
        - AT.CR
        - AT.FON
        - AU.BR
        - BR.RF
        - BZST
        - CA.CR
        - CH.UIDR
        - CZ.REE
        - DK.CR
        - EU.EORI
        - FR.RC
        - NO.RBE
        - PL.NOBR
        - SG.BR
        - UK.EORI
        - UK.VAT
        - VIES
      x-enumDescriptions:
        AR.NRC: Value indicating AR.NRC data source.
        AT.CR: Value indicating AT.CR data source.
        AT.FON: Value indicating AT.FON data source.
        AU.BR: Value indicating AU.BR data source.
        BR.RF: Value indicating BR.RF data source.
        BZST: Value indicating BZST data source.
        CA.CR: Value indicating CA.CR data source.
        CH.UIDR: Value indicating CH.UIDR data source.
        CZ.REE: Value indicating CZ.REE data source.
        DK.CR: Value indicating DK.CR data source.
        EU.EORI: Value indicating EU.EORI data source.
        FR.RC: Value indicating FR.RC data source.
        NO.RBE: Value indicating NO.RBE data source.
        PL.NOBR: Value indicating PL.NOBR data source.
        SG.BR: Value indicating SG.BR data source.
        UK.EORI: Value indicating UK.EORI data source.
        UK.VAT: Value indicating UK.VAT data source.
        VIES: Value indicating VIES data source.
    Name:
      type: object
      description: The name of a Business Partner.
      example: Corporate Data Quality AG
      properties:
        shortName:
          $ref: '#/components/schemas/NameShortName'
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        language:
          $ref: '#/components/schemas/Language'
    NameType:
      type: object
      description: >-
        The type of the name, e.g. a locally used name or an international
        version.
      example: Local Name
      properties:
        url:
          $ref: '#/components/schemas/NameTypeUrl'
        name:
          $ref: '#/components/schemas/NameTypeName'
        technicalKey:
          $ref: '#/components/schemas/NameTypeTechnicalKey'
    LegalForm:
      type: object
      description: >-
        The legal form of a [business partner/type/legal
        entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the
        form it takes in the eyes of the law governing it. The legal form of a
        [company](https://meta.cdq.com/Business_partner) is the general type it
        may legally use to identify itself according to the local, regional,
        national, or international law governing it. This is normally reflected
        in the ending abbreviation after the
        [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc.,
        LLC, S.A.).
      example: Aktiengesellschaft
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        mainAbbreviation:
          $ref: '#/components/schemas/LegalFormMainAbbreviation'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormTechnicalKey'
    Language:
      type: object
      description: Naming of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    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.
      example: VAT identification number
      properties:
        value:
          $ref: '#/components/schemas/schemas-IdentifierValue'
        type:
          $ref: '#/components/schemas/IdentifierType'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
    IdentifierType:
      type: object
      description: Type of the identifier.
      example: CH_VAT_ID
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    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.
      example: Amtsgericht Aachen
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
    Country:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      example: Switzerland CH
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
        value:
          $ref: '#/components/schemas/CountryValue'
    AdministrativeArea:
      type: object
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        shortName:
          $ref: '#/components/schemas/AdministrativeAreaShortName'
        type:
          $ref: '#/components/schemas/AdministrativeAreaType'
        language:
          $ref: '#/components/schemas/Language'
    AdministrativeAreaType:
      type: object
      description: Type of the Administrative Area.
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    BusinessPartnerStatus:
      type: object
      description: >-
        Describes the status of a business partner with respect to its level of
        activity (e.g. out of business) or legally relevant conditions (e.g. in
        liquidation).
      properties:
        officialDenotation:
          $ref: '#/components/schemas/BusinessPartnerStatusOfficialDenotation'
        validFrom:
          $ref: '#/components/schemas/BusinessPartnerStatusValidFrom'
        validUntil:
          $ref: '#/components/schemas/BusinessPartnerStatusValidUntil'
        type:
          $ref: '#/components/schemas/BusinessPartnerStatusType'
    BusinessPartnerStatusType:
      type: object
      description: The standardized status which the business partner currently has.
      example: In Liquidation
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    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).
      example: Lukasstraße 4, 9008 St. Gallen
      properties:
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        version:
          $ref: '#/components/schemas/AddressVersion'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
        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'
        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'
    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.
      example: International DE
      properties:
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
        language:
          $ref: '#/components/schemas/Language'
    PostCode:
      type: object
      description: >-
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or an combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      example: '9000'
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    PostCodeType:
      type: object
      description: Type of the Post Code.
      properties:
        name:
          $ref: '#/components/schemas/PostCodeTypeName'
        url:
          $ref: '#/components/schemas/PostCodeTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostCodeTypeTechnicalKey'
    Locality:
      type: object
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an [administrative
        area](https://meta.cdq.com/Address/administrative_area). A locality can
        also have several levels of sub localities.
      example: Sankt Gallen
      properties:
        value:
          $ref: '#/components/schemas/LocalityValue'
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        language:
          $ref: '#/components/schemas/Language'
    LocalityType:
      type: object
      description: Type of the Locality.
      example: City
      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.
      example: Lukasstraße 4
      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.
      example: Industrial zone
      properties:
        name:
          $ref: '#/components/schemas/ThoroughfareTypeName'
        url:
          $ref: '#/components/schemas/ThoroughfareTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    Premise:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      example: Lukasstraße 4, Building 2, Floor 3, Room 4
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        shortName:
          $ref: '#/components/schemas/PremiseShortName'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseType'
    PremiseType:
      type: object
      description: Type of the Premise.
      example: Building
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PremiseTypeTechnicalKey'
    PostalDeliveryPoint:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
      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.
      example: Sankt Gallen, Postfach 460
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostalDeliveryPointTypeTechnicalKey'
    PartnerProfile:
      description: >-
        A business partner profile contains important information about a
        company, such as its classification, tags, contact details, or minority
        indicator.
      type: object
      properties:
        contactEmails:
          type: array
          description: List of contact emails of the Business Partner.
          items:
            $ref: '#/components/schemas/ContactEmail'
    ContactEmail:
      type: object
      description: Actual email address of the Business Partner.
      example: developer-portal@cdq.com
      properties:
        value:
          $ref: '#/components/schemas/ContactEmailValue'
    BankAccount:
      type: object
      description: >-
        A bank account record holds information that universally describes a
        registered bank account.
      properties:
        internationalBankAccountIdentifier:
          $ref: '#/components/schemas/InternationalBankAccountIdentifier'
        internationalBankIdentifier:
          $ref: '#/components/schemas/InternationalBankIdentifier'
        nationalBankAccountIdentifier:
          $ref: '#/components/schemas/NationalBankAccountIdentifier'
        nationalBankIdentifier:
          $ref: '#/components/schemas/NationalBankIdentifier'
        bank:
          $ref: '#/components/schemas/Bank'
    Bank:
      type: object
      description: >-
        Financial institution that accepts deposits, facilitates withdrawals and
        transfers, and provides various financial services such as loans,
        investments, and currency exchange.
      properties:
        name:
          $ref: '#/components/schemas/BankName'
        branch:
          $ref: '#/components/schemas/BankBranch'
        address:
          $ref: '#/components/schemas/BankAddress'
    BankAddress:
      type: object
      description: The address where a bank resides.
      properties:
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
    Status:
      type: object
      description: Details about status or error of a service
      required:
        - code
        - technicalKey
        - description
      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'
    StatusDetails:
      type: object
      description: Details about this status or error
      properties:
        id:
          $ref: '#/components/schemas/StatusDetailsMessageId'
        message:
          $ref: '#/components/schemas/StatusDetailsMessage'
        technicalKey:
          $ref: '#/components/schemas/StatusTechnicalKey'
    DataDefect:
      type: object
      description: >-
        A data defect is a data quality issue that was found in a record.  It
        contains information about the defect and the rule that found it.
      properties:
        validationSource:
          $ref: '#/components/schemas/ValidationSource'
        businessRule:
          $ref: '#/components/schemas/DataValidationBusinessRule'
        executionContextProperties:
          type: array
          description: List of Execution Context Properties.
          items:
            $ref: '#/components/schemas/DataValidationExecutionContextProperty'
        categories:
          type: array
          description: List of categories the rule belongs to.
          items:
            $ref: '#/components/schemas/RuleCategory'
    ValidationSource:
      type: object
      description: Source of the validation.
      properties:
        type:
          $ref: '#/components/schemas/ValidationSourceType'
        value:
          type: string
          description: Value of the validation source.
          example: CDL
    ValidationSourceType:
      type: object
      description: Type of the validation source.
      properties:
        technicalKey:
          type: string
          description: Technical key of the validation source type.
          example: VALIDATION_GRAPH
        description:
          type: string
          description: Description of the validation source type.
          example: Default CDL Model
    DataValidationBusinessRule:
      type: object
      description: Represents a Business Rule.
      allOf:
        - $ref: '#/components/schemas/BusinessRule'
        - type: object
          description: Business rule that was executed.
          properties:
            violationMessage:
              type: string
              description: Violation message that is returned with detected data defect.
              example: Business Partner identifier is mandatory.
            violationLevel:
              $ref: '#/components/schemas/ViolationLevelEnum'
    DataValidationExecutionContextProperty:
      type: object
      description: Represents an execution context property.
      properties:
        type:
          type: string
          description: Type of the context’s attribute
          example: businessPartner.identifiers.value
        value:
          type: string
          description: Value of the context execution attribute
          example: STREET
    DataValidationRulesInError:
      type: array
      description: List of rules executed with error.
      items:
        $ref: '#/components/schemas/DataValidationRuleExecutionResult'
    DataValidationRuleExecutionResult:
      type: object
      description: >-
        Represents Data Quality Rules that executed with failure e.g. external
        service was not responding.
      properties:
        validationSource:
          $ref: '#/components/schemas/ValidationSource'
        businessRule:
          $ref: '#/components/schemas/DataValidationBusinessRule'
        executionStatus:
          $ref: '#/components/schemas/BusinessRuleExecutionStatus'
        error:
          $ref: '#/components/schemas/ApiError'
    CustomResult:
      type: object
      description: JSON that represents the result of a custom rule.
      additionalProperties: true
      example:
        type: myVariable
        value: someBoundedOrReturnedValue
    WorkspaceConfigurationResponsePage:
      type: object
      description: Response page of workspaces configurations.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of configurations.
          items:
            $ref: '#/components/schemas/WorkspaceConfiguration'
    WorkspaceConfigurationResponse:
      type: object
      description: Contains the configuration and metadata.
      properties:
        id:
          type: string
          description: >-
            Unique identifier of the business partner validation configuration
            version. Not to be confused with the configuration ID.
          example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
        configurationId:
          $ref: '#/components/schemas/schemas-ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/BusinessPartnerValidationConfiguration'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    WorkspaceConfigurationVersionResponse:
      type: object
      description: Specific version of a business partner validation configuration.
      properties:
        id:
          type: string
          description: >-
            Unique identifier of the business partner validation configuration
            version. Not to be confused with the configuration ID.
          example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
        name:
          type: string
          description: The name of the configuration
          example: Configuration Name
        configurationId:
          $ref: '#/components/schemas/schemas-ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/BusinessPartnerValidationConfiguration'
        createdAt:
          type: string
          description: >-
            Date and time when the first version of the configuration was
            created (ISO 8601-compliant).
          example: '2025-10-07T05:40:33Z'
        modifiedAt:
          type: string
          description: >-
            Date and time when this version of the configuration was created
            (ISO 8601-compliant).
          example: '2025-10-07T05:40:33Z'
        createdBy:
          type: string
          description: User who created the first version of the configuration.
          example: '69129435489347624'
        modifiedBy:
          type: string
          description: User who created this version of the configuration.
          example: '76248934691294444'
    ConfigurationVersionNumber:
      type: integer
      description: Version number of the configuration.
      example: 1
    WorkspaceConfiguration:
      type: object
      description: Configures behavior for Data Validation API.
      properties:
        name:
          $ref: '#/components/schemas/ConfigurationName'
        id:
          $ref: '#/components/schemas/schemas-ConfigurationId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    WorkspaceConfigurationCreate:
      type: object
      description: Configuration to be created in the workspace of the current user.
      properties:
        workspaceId:
          $ref: '#/components/schemas/WorkspaceId'
        name:
          type: string
          description: The name of the configuration.
          example: Custom configuration name
        configuration:
          $ref: '#/components/schemas/BusinessPartnerValidationConfiguration'
    WorkspaceConfigurationUpdate:
      type: object
      description: Configuration to be updated in the workspace of the current user.
      properties:
        featuresOn:
          $ref: '#/components/schemas/WorkspaceConfigurationUpdateFeaturesOn'
        name:
          type: string
          description: The name of the configuration.
          example: Custom configuration name
        defaultConfiguration:
          type: boolean
          description: >-
            Is default workspace configuration. Only one configuration of the
            same type can be a default configuration in a given workspace.
          default: false
          example: true
        configuration:
          $ref: '#/components/schemas/BusinessPartnerValidationConfiguration'
    TransactionFeatureParam:
      type: string
      description: Feature used to control transaction process.
      example: CREATE_TRANSACTION
      enum:
        - CREATE_TRANSACTION
        - COMMIT_TRANSACTION
      x-enumDescriptions:
        CREATE_TRANSACTION: >-
          Creates a new transaction and makes the current request a part of it.
          By default, turned off.
        COMMIT_TRANSACTION: Commit transaction. By default, turned off.
    WorkspaceConfigurationUpdateFeaturesOn:
      type: array
      description: Features to be enabled.
      items:
        $ref: '#/components/schemas/WorkspaceConfigurationUpdateFeatureParam'
    WorkspaceConfigurationUpdateFeatureParam:
      type: string
      description: Feature used during configuration update.
      example: REEVALUATION_ON_CHANGES
      enum:
        - REEVALUATION_ON_CHANGES
      x-enumDescriptions:
        REEVALUATION_ON_CHANGES: Re-evaluates business partners based on changes in the configuration.
    AddressQualificationDetails:
      type: object
      description: Qualification result for address.
      properties:
        localityQualification:
          $ref: '#/components/schemas/QualificationStatus'
        postCodeQualification:
          $ref: '#/components/schemas/QualificationStatus'
        thoroughfareNumberQualification:
          $ref: '#/components/schemas/QualificationStatus'
        thoroughfareQualification:
          $ref: '#/components/schemas/QualificationStatus'
    QualificationStatus:
      type: string
      description: >-
        Qualification results - verifies if the provided element and identifier
        matches.
      example: QUALIFIED
      enum:
        - FAILED
        - QUALIFIED
        - NOT_PROVIDED
        - UNKNOWN
      x-enumDescriptions:
        FAILED: Provided element and identifier do not match.
        QUALIFIED: Provided element and identifier match.
        NOT_PROVIDED: Element is not provided.
        UNKNOWN: Unknown qualification status.
    BusinessRule:
      type: object
      description: Set of information about the Business Rule.
      properties:
        name:
          $ref: '#/components/schemas/BusinessRuleName'
        url:
          $ref: '#/components/schemas/BusinessRuleUrl'
        ruleStatus:
          type: string
          description: Status of the business rule.
          example: RELEASED
    ApiError:
      type: object
      description: Detailed information about API errors.
      properties:
        timestamp:
          $ref: '#/components/schemas/ApiErrorTimestamp'
        message:
          $ref: '#/components/schemas/ApiErrorMessage'
        error:
          $ref: '#/components/schemas/HttpError'
        path:
          $ref: '#/components/schemas/HttpPath'
        status:
          $ref: '#/components/schemas/HttpStatus'
        id:
          type: string
          description: >-
            Unique identifier of an error, usually in a format of
            `domain_service_errorType_errorCode`.
          example: REF_VIES_SERVICE_UNAVAILABLE_300
    ExternalServiceResponse:
      type: object
      description: >-
        Carries information from response of external data sources. In case of
        using `VIES` it will additionally contain information with requestId
        returned from the `VIES`.
      properties:
        status:
          type: integer
          description: HTTP status code returned from external Data Source.
          example: '200'
        message:
          type: string
          description: >-
            Typically, contains an error message received from external data
            source, only if returned. Can show CDQ-related messages.
          example: There is no more quota left for this Data Source.
        path:
          type: string
          description: >-
            When legacy qualification is done with BZST Data Source, then full
            request path is returned
          example: /data-validation/businesspartners/validate
        details:
          type: string
          description: Additional details about External Service.
          example: Detailed message
        timestamp:
          type: string
          description: The timestamp of execution the request to external Data Source.
          example: '2025-10-07T05:40:33Z'
        additionalInformation:
          type: array
          description: Any additional information received during the original request.
          items:
            $ref: '#/components/schemas/AdditionalInformation'
    AdditionalInformation:
      type: object
      description: >-
        Contains Data Source related information (headers, requestor, id, etc.).
        Currently only supported for `VIES` Data Source.
      properties:
        key:
          type: string
          description: Property name.
          example: requestId
        value:
          type: string
          description: Value of given property.
          example: WAPIAAAAYse8yTdE
    KeyValue:
      type: object
      description: Key value pair.
      properties:
        key:
          type: string
          description: Key of the source data.
          example: addrz1
        value:
          type: string
          description: Value of the source data.
          example: CH-9000
    QualificationResult:
      type: object
      description: >-
        QualificationResult is created when validation process takes into
        consideration [rules of category](https://meta.cdq.com/Qualification)
        and the feature `SHOW_QUALIFICATION_DECISIONS` is enabled. Enabling
        qualification can be done by the profile related to the qualification.
        QualificationResult contains information about qualification decisions,
        the data that have been qualified and overall qualification decisions.
      properties:
        sourceData:
          type: array
          description: List of source data used for qualification.
          items:
            $ref: '#/components/schemas/KeyValue'
        formattedSourceData:
          $ref: '#/components/schemas/FormattedSourcedata'
        validatorStatus:
          type: string
          description: >-
            Shows if validator source has been `OFFLINE` or `ONLINE` during
            request.
          example: ONLINE
        validatorMessage:
          type: string
          description: Additional message to describe validatorStatus.
          example: VAT ID is valid.
        qualifiedBy:
          $ref: '#/components/schemas/ValidationSource'
        qualifiedAt:
          type: string
          description: Date and time of qualification.
          example: '2025-10-07T05:40:33Z'
        addressQualification:
          $ref: '#/components/schemas/QualificationStatus'
        addressQualificationDetails:
          $ref: '#/components/schemas/AddressQualificationDetails'
        identifierValidity:
          type: string
          description: Validity of identifier (syntax, format and not inactive).
          example: VALID
          enum:
            - VALID
            - INVALID
            - UNKNOWN
          x-enumDescriptions:
            VALID: >-
              Identifier provided by user is an existing identifier and matches
              the input data.
            INVALID: >-
              Qualification decision that means the identifier is not a `VALID`
              business partner or the business partner is inactive.
            UNKNOWN: >-
              Error occurred in execution of qualification, the validation
              engine is not able to tell if the value is `VALID` or `INVALID`.
        businessPartnerNameQualification:
          $ref: '#/components/schemas/QualificationStatus'
        overallQualification:
          $ref: '#/components/schemas/QualificationStatus'
    FormattedSourcedata:
      type: object
      description: >-
        Contains data that was received from external source (VIES, AT.FON,
        BZST) in a unified format.
      properties:
        code:
          type: string
          description: >-
            Code of Business Partner that was received from external data
            source.
          example: ATU12345678
        message:
          type: string
          description: Additional message to describe code.
          example: Message to be filled in.
        businessPartnerName:
          type: string
          description: >-
            Name of Business Partner that was received from external data
            source.
          example: Muster AG
        postCodeValue:
          type: string
          description: >-
            Post Code of Business Partner that was received from external data
            source.
          example: '9000'
        thoroughfareValue:
          type: string
          description: >-
            Thoroughfare of Business Partner that was received from external
            data source.
          example: Hauptstrasse
        localityValue:
          type: string
          description: >-
            Locality of Business Partner that was received from external data
            source.
          example: München
    DebugInfo:
      type: object
      description: >-
        Reference implementation how to structure external service responses.
        Can be activated by a feature `SHOW_DEBUG_INFO`.
      properties:
        externalServiceResponses:
          type: array
          description: List of external service responses.
          items:
            $ref: '#/components/schemas/ExternalServiceResponse'
        businessRulesExecutionSummary:
          $ref: '#/components/schemas/BusinessRulesExecutionSummary'
    BusinessRulesExecutionSummary:
      type: object
      description: Summary of Business Rules execution.
      properties:
        numberOfRules:
          type: integer
          description: Number of rules executed.
          example: '274'
        numberOfExecutions:
          type: integer
          description: Number of rule executions.
          example: '273'
        numberOfFails:
          type: integer
          description: Number of failed rule executions.
          example: '1'
        failures:
          type: array
          description: List of failed rules.
          items:
            $ref: '#/components/schemas/ValidationFailureLog'
        warnings:
          type: array
          description: List of data sources used in validation.
          items:
            $ref: '#/components/schemas/ValidationWarningLog'
        dataSourcesOn:
          type: array
          description: List of data sources used in validation.
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: List of data sources not used in validation.
          items:
            $ref: '#/components/schemas/DataSource'
        activatedRules:
          type: array
          description: List of activated rules.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        ignoredRules:
          type: array
          description: List of ignored rules.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        ruleCategoriesOn:
          type: array
          description: List of activated rule categories.
          items:
            $ref: '#/components/schemas/RuleCategoryOn'
        ruleStatuses:
          type: array
          description: Filter for rule status.
          items:
            $ref: '#/components/schemas/ValidationRuleStatus'
        violationLevels:
          type: array
          description: Filter for rule violation level (criticality).
          items:
            $ref: '#/components/schemas/schemas-ViolationLevel'
    ValidationWarningLog:
      type: object
      description: Contains information about warnings regarding the rules.
      properties:
        message:
          type: string
          description: Descriptive message, usually a warning.
          example: Message to be filled in.
    ValidationFailureLog:
      type: object
      description: >-
        Contains information whenever the rule cannot be executed e.g. SPARQL
        parsing errors.
      properties:
        externalId:
          deprecated: true
          type: string
          description: External ID of the Business Partner or Record being validated.
          example: '955775'
        message:
          type: string
          description: >-
            Descriptive message, usually an error, with the reason why execution
            of the rule didn’t succeed.
          example: Message to be filled in.
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
    ValidationJobResult:
      type: object
      description: >-
        Created when validation process takes into consideration [rules of
        category](https://meta.cdq.com/Validation) and the feature
        `SHOW_DECISIONS` is enabled. Enabling validation can be done by the
        profile related to the validation. ValidationJobResult contains
        information about validation decisions, the data that have been
        validated and overall validation decisions.
      properties:
        statistics:
          type: object
          description: Statistics of the validation process.
          properties:
            numberOfRecords:
              type: number
              description: Number of records.
              example: '1'
            numberOfCountries:
              type: number
              description: Number of countries.
              example: '1'
            defectRateOverall:
              type: number
              description: Overall defect rate.
              example: '0.0'
            defectRateIdentifier:
              type: number
              description: Over defect rate for identifier only.
              example: '0.0'
        images:
          type: object
          description: Images of the validation process.
          properties:
            dataQualityUrl:
              type: string
              description: URL of the data quality image.
              example: >-
                https://files.cdq.com/rdoms/rdom-data-quality-v1.yaml#/components/schemas/DataQualityImage
            mapCountryRecordsUrl:
              type: string
              description: URL of the map country records image.
              example: >-
                https://files.cdq.com/rdoms/rdom-data-quality-v1.yaml#/components/schemas/MapCountryRecordsImage
    ValidationJobRequest:
      type: object
      description: ValidationJobRequest is used to create a new validation job.
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        profile:
          $ref: '#/components/schemas/ValidationProfile'
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            type: string
            description: Features are used to activate or deactivate.
            example: SHOW_LOOKUP_RESULTS
            enum:
              - ADDRESS_CHECKS
              - BANKING_DATA_CHECKS
              - BUSINESS_PARTNER_CHECKS
              - ENRICH_CATEGORIES
              - ENRICH_LEGAL_FORM
              - EU_VAT_QUALIFICATION_AT
              - EU_VAT_QUALIFICATION_DE
              - EU_VAT_QUALIFICATION_STANDARD
              - EXTERNAL_SOURCES_OFF
              - IDENTIFIER_CHECKS
              - IDENTIFIER_QUALIFICATION
              - LAB_BETA
              - LAB_USE_QUEUES
              - QUALIFICATION_SILENT_MODE
              - SHOW_BUSINESSPARTNER
              - SHOW_DATA_DEFECTS
              - SHOW_DEBUG_INFO
              - SHOW_DECISIONS
              - SHOW_LOOKUP_RESULTS
              - SHOW_QUALIFICATION_DECISIONS
              - USE_SPARQL_VALIDATOR
              - FORCE_EXTERNAL_CALL
            x-enumDescriptions:
              ADDRESS_CHECKS: >-
                CDQ data quality profiling services enable the validation of
                addresses with respect to different data quality criteria.
              BANKING_DATA_CHECKS: >-
                CDQ data quality profiling services enable the validation of
                bank master data with respect to different data quality
                criteria.
              BUSINESS_PARTNER_CHECKS: >-
                Validate concepts that basically establish a business partner
                (e.g. name and legal form).
              ENRICH_CATEGORIES: >-
                Enrich a CDL community standardized business partner category
                for a given entity.
              ENRICH_LEGAL_FORM: Identify and enriches the legal form of a company.
              EU_VAT_QUALIFICATION_AT: Enforces to use AT.FON data source to qualify EU VATs.
              EU_VAT_QUALIFICATION_DE: >-
                Enforces to use BZST data source for non-German business
                partners.
              EU_VAT_QUALIFICATION_STANDARD: >-
                For a given EU VAT, it is checked whether the name and address
                are really associated with this identifier (same information
                maintained in the VAT register as provided by the user).
              EXTERNAL_SOURCES_OFF: Turns off external data sources.
              IDENTIFIER_CHECKS: >-
                Validate business (VAT, tax, business register IDs) and location
                identifiers against different data quality rules categories.
              IDENTIFIER_QUALIFICATION: >-
                Turns on identifier qualification (standard) which enables to
                qualify EU VAT identifiers.
              LAB_BETA: Deprecated feature.
              LAB_USE_QUEUES: Perform uploading processing log with queue. Enable as default.
              QUALIFICATION_SILENT_MODE: >-
                If enabled all exceptions occurring within execution of business
                rules are ignored. If not enabled then execution error will
                result in creating data defect. By default, part of profile
                QUALIFICATION.
              SHOW_BUSINESSPARTNER: Shows business partner that was used in the request.
              SHOW_DATA_DEFECTS: Shows found data defects - usually it is turned on.
              SHOW_DEBUG_INFO: >-
                Shows additional information about validation process (number of
                applied rules, used categories, failed executions etc.).
              SHOW_DECISIONS: Deprecated feature.
              SHOW_LOOKUP_RESULTS: >-
                Displays results from the lookup endpoint (usually enriched data
                in comparison to the original business partner requested).
              SHOW_QUALIFICATION_DECISIONS: >-
                Shows qualification decisions - used only in qualification
                endpoint in API v3. In APIv1 and APIv2 it is used in validation
                endpoint.
              USE_SPARQL_VALIDATOR: Deprecated feature.
              FORCE_EXTERNAL_CALL: Force external call.
        featuresOff:
          type: array
          description: List to be deactivated.
          items:
            type: string
            description: Features are used to activate or deactivate.
            example: SHOW_LOOKUP_RESULTS
            enum:
              - ADDRESS_CHECKS
              - BANKING_DATA_CHECKS
              - BUSINESS_PARTNER_CHECKS
              - ENRICH_CATEGORIES
              - ENRICH_LEGAL_FORM
              - EU_VAT_QUALIFICATION_AT
              - EU_VAT_QUALIFICATION_DE
              - EU_VAT_QUALIFICATION_STANDARD
              - EXTERNAL_SOURCES_OFF
              - IDENTIFIER_CHECKS
              - IDENTIFIER_QUALIFICATION
              - LAB_BETA
              - LAB_USE_QUEUES
              - QUALIFICATION_SILENT_MODE
              - SHOW_BUSINESSPARTNER
              - SHOW_DATA_DEFECTS
              - SHOW_DEBUG_INFO
              - SHOW_DECISIONS
              - SHOW_LOOKUP_RESULTS
              - SHOW_QUALIFICATION_DECISIONS
              - USE_SPARQL_VALIDATOR
              - FORCE_EXTERNAL_CALL
            x-enumDescriptions:
              ADDRESS_CHECKS: >-
                CDQ data quality profiling services enable the validation of
                addresses with respect to different data quality criteria.
              BANKING_DATA_CHECKS: >-
                CDQ data quality profiling services enable the validation of
                bank master data with respect to different data quality
                criteria.
              BUSINESS_PARTNER_CHECKS: >-
                Validate concepts that basically establish a business partner
                (e.g. name and legal form).
              ENRICH_CATEGORIES: >-
                Enrich a CDL community standardized business partner category
                for a given entity.
              ENRICH_LEGAL_FORM: Identify and enriches the legal form of a company.
              EU_VAT_QUALIFICATION_AT: Enforces to use AT.FON data source to qualify EU VATs.
              EU_VAT_QUALIFICATION_DE: >-
                Enforces to use BZST data source for non-German business
                partners.
              EU_VAT_QUALIFICATION_STANDARD: >-
                For a given EU VAT, it is checked whether the name and address
                are really associated with this identifier (same information
                maintained in the VAT register as provided by the user).
              EXTERNAL_SOURCES_OFF: Turns off external data sources.
              IDENTIFIER_CHECKS: >-
                Validate business (VAT, tax, business register IDs) and location
                identifiers against different data quality rules categories.
              IDENTIFIER_QUALIFICATION: >-
                Turns on identifier qualification (standard) which enables to
                qualify EU VAT identifiers.
              LAB_BETA: Deprecated feature.
              LAB_USE_QUEUES: Perform uploading processing log with queue. Enable as default.
              QUALIFICATION_SILENT_MODE: >-
                If enabled all exceptions occurring within execution of business
                rules are ignored. If not enabled then execution error will
                result in creating data defect. By default, part of profile
                QUALIFICATION.
              SHOW_BUSINESSPARTNER: Shows business partner that was used in the request.
              SHOW_DATA_DEFECTS: Shows found data defects - usually it is turned on.
              SHOW_DEBUG_INFO: >-
                Shows additional information about validation process (number of
                applied rules, used categories, failed executions etc.).
              SHOW_DECISIONS: Deprecated feature.
              SHOW_LOOKUP_RESULTS: >-
                Displays results from the lookup endpoint (usually enriched data
                in comparison to the original business partner requested).
              SHOW_QUALIFICATION_DECISIONS: >-
                Shows qualification decisions - used only in qualification
                endpoint in API v3. In APIv1 and APIv2 it is used in validation
                endpoint.
              USE_SPARQL_VALIDATOR: Deprecated feature.
              FORCE_EXTERNAL_CALL: Force external call.
        ruleStatuses:
          type: array
          description: Enable rules with provided statuses
          items:
            $ref: '#/components/schemas/RuleStatus'
        vatAtRequestor:
          type: string
          deprecated: true
          description: >
            DEPRECATED, use organizational settings to configure.


            The requestor’s VAT identifier, required for execution of requests
            against external data sources.
          example: AT123456789
        vatDeRequestor:
          type: string
          deprecated: true
          description: >
            DEPRECATED, use organizational settings to configure.


            The requestor’s VAT identifier, required for execution of requests
            against external data sources.
          example: DE123456789
        bzstPrint:
          type: string
          example: true
          description: Request printed confirmation by German BZSt authority
        validationSource:
          $ref: '#/components/schemas/ValidationSource'
        dataSourcesOn:
          type: array
          description: >-
            If data sources are disabled by feature toogle you can enable some
            of them passing their prefixes here
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: >-
            Rules with data sources passed here are not used in validation
            process
          items:
            $ref: '#/components/schemas/DataSource'
    BusinessPartnerValidationRequest:
      type: object
      description: Request for Business Partner Validation.
      properties:
        profile:
          $ref: '#/components/schemas/ValidationProfile'
        ruleStatuses:
          type: array
          description: Enable rules with provided statuses.
          items:
            $ref: '#/components/schemas/RuleStatus'
        featuresOn:
          type: array
          description: List of activated features.
          items:
            $ref: '#/components/schemas/ValidationFeature'
        featuresOff:
          type: array
          description: List of deactivated features.
          items:
            $ref: '#/components/schemas/ValidationFeature'
        ruleCategoriesOn:
          type: array
          description: Categories use for selecting active business rules.
          items:
            $ref: '#/components/schemas/RuleCategoryOn'
        dataSourcesOn:
          type: array
          description: >-
            If data sources are disabled by feature toggle you can enable some
            of them passing their prefixes here.
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: >-
            Rules with data sources passed here are not used in validation
            process.
          items:
            $ref: '#/components/schemas/DataSource'
        vatAtRequestor:
          type: string
          deprecated: true
          description: >
            DEPRECATED, use organizational settings to configure.


            The requestor’s VAT identifier, required for execution of requests
            against external data sources.
          example: AT123456789
        vatDeRequestor:
          type: string
          deprecated: true
          description: >
            DEPRECATED, use organizational settings to configure.


            The requestor’s VAT identifier, required for execution of requests
            against external data sources.
          example: DE123456789
        bzstPrint:
          type: string
          description: Request printed confirmation by German BZSt authority.
          example: 'true'
        validationSource:
          $ref: '#/components/schemas/ValidationSource'
        ignoredRules:
          type: array
          description: Urls of cdl rules ignored during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        activatedRules:
          type: array
          description: Urls of cdl rules that are active during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        criticalities:
          type: array
          items:
            $ref: '#/components/schemas/Criticality'
        configurationId:
          $ref: '#/components/schemas/ConfigurationId'
    BusinessPartnerValidationResult:
      type: object
      description: Validation result for a single Business Partner.
      properties:
        dataDefects:
          type: array
          description: List of Data Defects.
          items:
            $ref: '#/components/schemas/DataDefect'
        qualificationResult:
          $ref: '#/components/schemas/QualificationResult'
        lookupResults:
          type: array
          description: List of Lookup Results.
          items:
            $ref: '#/components/schemas/LookupResult'
        summary:
          $ref: '#/components/schemas/ValidationSummary'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
        identifierResults:
          $ref: '#/components/schemas/IdentifierResults'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner3'
        rulesInError:
          $ref: '#/components/schemas/RulesInError'
        executedAt:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result data was
            created.
          example: '2025-10-07T05:40:33Z'
    RuleCategoryUrl:
      type: string
      description: URL of the rule category.
      example: https://meta.cdq.com/Identifier_checkdigit
    PostCodeParam:
      type: object
      description: >-
        A country specific code for a certain address component or a combination
        of address components, e.g. locality.
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
    NameParam:
      type: object
      description: Name of a business partner.
      properties:
        value:
          $ref: '#/components/schemas/NameValue'
    LocalityParam:
      type: object
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an [administrative
        area](https://meta.cdq.com/Address/administrative_area). A locality can
        also have several levels of sub localities.
      properties:
        value:
          $ref: '#/components/schemas/LocalityValue'
    ThoroughfareParam:
      type: object
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      properties:
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
    CountryParam:
      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'
    PremiseParam:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
    AdministrativeAreaParam:
      type: object
      description: A top-level geographical or political area division in a country.
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
    DataSource:
      type: object
      description: >-
        A sub-container of Data Storage/Data Mirror. Few data sources can have
        different data, mappings, and data monitors within the same data mirror.
      properties:
        prefix:
          $ref: '#/components/schemas/DataSourcePrefix'
    PostalDeliveryPointParam:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        type:
          type: object
          description: A single mailbox or other place at which postal mail is delivered.
          properties:
            technicalKey:
              type: string
              description: Technical key of the Postal Delivery Point.
              example: POST_OFFICE_BOX
              enum:
                - POST_OFFICE_BOX
              x-enumDescriptions:
                POST_OFFICE_BOX: >-
                  A uniquely addressable lockable box located on the premises of
                  a post office station.
    LegalFormParam:
      type: object
      description: >-
        The legal form of a Business Partner is the form it takes in the eyes of
        the law governing it. The legal form of a
        [company](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'
    IdentifierParam:
      type: object
      description: >-
        Identifies a Business Partner in a given context uniquely such as a VAT
        identification number.
      properties:
        value:
          $ref: '#/components/schemas/schemas-IdentifierValue'
        type:
          type: object
          description: Type of the identifier.
          properties:
            technicalKey:
              $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    RecordValidationRequest:
      type: object
      description: Request for validation of a single record.
      properties:
        jsonRecord:
          type: object
          description: Stringified JSON of the custom record.
          additionalProperties: true
        customKnowledgeGraph:
          type: string
          description: >-
            Identifier for the custom knowledge graph that should be used for
            validation.
          example: customer_name
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        profile:
          $ref: '#/components/schemas/ValidationProfile'
        ruleStatuses:
          type: array
          description: Filter for rule status.
          items:
            $ref: '#/components/schemas/RuleStatus'
        featuresOn:
          type: array
          description: Activate features.
          items:
            type: string
            description: Activate features.
            example: SHOW_LOOKUP_RESULTS
            enum:
              - ENRICH_DATA_MIRROR_CHANGES
              - EXTERNAL_SOURCES_OFF
              - SHOW_BUSINESSPARTNER
              - SHOW_DEBUG_INFO
              - USE_AUTOMATION_RULES
            x-enumDescriptions:
              ENRICH_DATA_MIRROR_CHANGES: Enriches the data with changes from the data mirror.
              EXTERNAL_SOURCES_OFF: >-
                Disables any rule that utilizes Data Sources in validation
                process (rule’s Primary/Secondary datasources).
              SHOW_BUSINESSPARTNER: >-
                Returns the Business Partner as a part of the validation
                response.
              SHOW_DEBUG_INFO: >-
                Return additional information that can be used for debugging
                purposes.
              USE_AUTOMATION_RULES: Executes business rules of category Automation_rule.
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            type: string
            description: Features to be deactivated.
            example: SHOW_LOOKUP_RESULTS
            enum:
              - ENRICH_DATA_MIRROR_CHANGES
              - EXTERNAL_SOURCES_OFF
              - SHOW_BUSINESSPARTNER
              - SHOW_DEBUG_INFO
              - USE_AUTOMATION_RULES
            x-enumDescriptions:
              ENRICH_DATA_MIRROR_CHANGES: Enriches the data with changes from the data mirror.
              EXTERNAL_SOURCES_OFF: >-
                Disables any rule that utilizes Data Sources in validation
                process (rule’s Primary/Secondary datasources).
              SHOW_BUSINESSPARTNER: >-
                Returns the Business Partner as a part of the validation
                response.
              SHOW_DEBUG_INFO: >-
                Return additional information that can be used for debugging
                purposes.
              USE_AUTOMATION_RULES: Executes business rules of category Automation_rule.
        ruleCategoriesOn:
          type: array
          description: Categories use for selecting active business rules.
          items:
            $ref: '#/components/schemas/RuleCategoryOn'
        ignoredRules:
          type: array
          description: Urls of cdl rules ignored during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        activatedRules:
          type: array
          description: Urls of cdl rules that are active during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        criticalities:
          type: array
          description: >-
            Criticalities of cdl rules that are active during validation
            process.
          items:
            $ref: '#/components/schemas/Criticality'
        dataSourcesOn:
          type: array
          description: >-
            If data sources are disabled by feature toggle you can enable some
            of them passing their prefixes here.
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: >-
            Rules with data sources passed here are not used in validation
            process.
          items:
            $ref: '#/components/schemas/DataSource'
        dataMirrorStorageId:
          type: string
          description: Storage used for data mirror enrichment.
          example: 6ecd44476b95347e8a0d215589afj420
    RecordValidationResult:
      type: object
      description: Contains information about created record during Validation Process.
      properties:
        dataDefects:
          type: array
          description: List of Data Defects found in the record.
          items:
            $ref: '#/components/schemas/DataDefect'
        decisions:
          type: array
          description: List of Decisions made by the automation rules.
          items:
            $ref: '#/components/schemas/Decision'
        qualificationResult:
          $ref: '#/components/schemas/QualificationResult'
        summary:
          $ref: '#/components/schemas/ValidationSummary'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
        diff:
          type: string
          description: >-
            Applicable only for Record Validation when feature
            `ENRICH_DATA_MIRROR_CHANGES` is enabled. Contains differences
            between value stored in CDQ storage and the value that was sent with
            the request.
          example: >-
            {"Identified_changes":[{"op":"add","path":"/partner/header/objectTask","value":"C"}]}
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner3'
    Property:
      type: object
      description: Instantiated property of a data model.
      properties:
        content:
          $ref: '#/components/schemas/PropertyContent'
        contentSelector:
          $ref: '#/components/schemas/PropertyContentSelector'
        name:
          $ref: '#/components/schemas/PropertyName'
        url:
          $ref: '#/components/schemas/PropertyUrl'
        rootConcept:
          $ref: '#/components/schemas/Concept'
        parentConcept:
          $ref: '#/components/schemas/Concept'
    Concept:
      type: object
      description: The Concept is a part of the CDQ data model.
      properties:
        id:
          type: string
          description: ID which uniquely identifies the content in the (nested) object.
          example: EU_VAT_ID_DE
        idSelector:
          type: string
          description: JSON path which points to the id.
          example: >-
            businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey
        name:
          $ref: '#/components/schemas/ConceptName'
        url:
          $ref: '#/components/schemas/ConceptUrl'
    ValidationSummary:
      type: object
      description: Summary of the validation result.
      properties:
        validationLevel:
          type: string
          description: >
            Represents the highest violationLevel available from the available
            data defects. 

            It can take multiple data defect violation levels and calculate the
            validationLevel based on those. 

            The priority is: `ERROR` > `UNKNOWN` > `WARNING` > `INFO` > `OK`
            where `UNKNOWN` means there was a failure in rule execution and
            validation engine was not able to give the decision based on
            existing results. `OK` is set only when no rules failed and no data
            defects are present.
          example: ERROR
        dataQualityRecordStatus:
          $ref: '#/components/schemas/DataQualityRecordStatus'
        action:
          type: string
          description: Consolidated action over all decisions
          example: FULL_CHECK
        statistics:
          $ref: '#/components/schemas/Statistics'
    DataQualityRecordStatus:
      type: object
      description: >-
        Information about the quality of the record, containing more descriptive
        content as message, technicalKey and description.
      properties:
        name:
          type: string
          description: Name of the data quality record status.
          example: No issues found
        description:
          type: string
          description: Description of the data quality record status.
          example: >-
            All rules have been executed, and we have found no data quality
            issues.
        technicalKey:
          type: string
          description: >
            Overall data quality status for validation checks against single
            business partner.

            This status is calculated based on validationLevel and rulesInError.
          example: NO_ISSUES_FOUND
    Statistics:
      type: object
      description: Statistics of the validation result.
      properties:
        numberOfInfoDataDefects:
          type: integer
          description: Number of data defects with severity INFO.
          example: '10'
        numberOfErrorDataDefects:
          type: integer
          description: Number of data defects with severity ERROR.
          example: '10'
        numberOfWarningDataDefects:
          type: integer
          description: Number of data defects with severity WARNING.
          example: '10'
    Decision:
      type: object
      description: >-
        Used in record validation for special type of business rules called
        automation rules. It’s an output from validation engine on what to do
        with the validated record.
      properties:
        properties:
          type: array
          description: Properties which have been involved in the decision-making process.
          items:
            $ref: '#/components/schemas/Property'
        action:
          type: string
          description: >-
            Describes what action, if needed, to take with validated record.
            Possible values - `INFO`, `FULL_CHECK`.
          example: FULL_CHECK
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
    ValidationProfile:
      type: string
      description: Profile which is used during validation. Default value is STANDARD.
      example: QUICK
      enum:
        - QUICK
        - STANDARD
        - QUALIFICATION
        - AUTOMATION
        - EU_VAT_QUALIFICATION
        - DATA_SHARING_QUALITY_GATE
        - IDENTIFIER_QUALITY
        - ADDRESS_QUALITY
        - WORLDWIDE_IDENTIFIER_QUALIFICATION
        - FEATURES_OFF
      x-enumDescriptions:
        QUICK: >-
          This profile checks data quality of records in a quick way, i.e. data
          quality rules that have a negative impact on performance.
        STANDARD: This profile checks data quality using CDQ's standard configuration.
        QUALIFICATION: Deprecated.
        AUTOMATION: Deprecated.
        EU_VAT_QUALIFICATION: >-
          This profile qualifies EU VATs using CDQ's default configuration of
          data quality rules for qualified checks of EU VATs
        DATA_SHARING_QUALITY_GATE: >-
          Quality checks ensure that only valid data enters the CDQ Community
          Data Pool
        IDENTIFIER_QUALITY: >-
          This profile checks identifiers with a standard configuration of data
          quality rules. It does not comprise qualified checks of identifiers
          regarding e.g. name or address.
        ADDRESS_QUALITY: >-
          This profile checks addresses with a standard configuration of data
          quality rules.
        WORLDWIDE_IDENTIFIER_QUALIFICATION: >-
          This profile qualifies any supported business identifier (e.g. tax
          numbers) worldwide using CDQ's default configuration of data quality
          rules for qualified checks of a particular identifier
        FEATURES_OFF: >-
          This profile turns off any qualification rules and is designed for
          custom rules selection.
    ValidationFeature:
      type: string
      description: Features to be used on during validation.
      example: SHOW_LOOKUP_RESULTS
      enum:
        - ADDRESS_CHECKS
        - BANKING_DATA_CHECKS
        - BUSINESS_PARTNER_CHECKS
        - COUNTRY_CHECKS
        - ENRICH_CATEGORIES
        - ENRICH_DATA_MIRROR_CHANGES
        - ENRICH_LEGAL_FORM
        - EU_VAT_QUALIFICATION_AT
        - EU_VAT_QUALIFICATION_DE
        - EU_VAT_QUALIFICATION_STANDARD
        - EXTERNAL_SOURCES_OFF
        - FORCE_EXTERNAL_CALL
        - IDENTIFIER_CHECKS
        - IDENTIFIER_QUALIFICATION
        - LAB_BETA
        - QUALIFICATION_SILENT_MODE
        - SHOW_BUSINESSPARTNER
        - SHOW_DATA_DEFECTS
        - SHOW_DEBUG_INFO
        - SHOW_DECISIONS
        - SHOW_LOOKUP_RESULTS
        - SHOW_QUALIFICATION
        - SHOW_QUALIFICATION_DECISIONS
        - USE_SPARQL_VALIDATOR
      x-enumDescriptions:
        ADDRESS_CHECKS: >-
          CDQ data quality profiling services enable the validation of addresses
          with respect to different data quality criteria.
        BANKING_DATA_CHECKS: >-
          CDQ data quality profiling services enable the validation of bank
          master data with respect to different data quality criteria.
        BUSINESS_PARTNER_CHECKS: >-
          Validate concepts that basically establish a business partner (e.g.
          name and legal form).
        COUNTRY_CHECKS: Validate country information.
        ENRICH_CATEGORIES: >-
          Enrich a CDL community standardized business partner category for a
          given entity.
        ENRICH_DATA_MIRROR_CHANGES: Enriches the data with changes from the data mirror.
        ENRICH_LEGAL_FORM: Identify and enriches the legal form of a company.
        EU_VAT_QUALIFICATION_AT: Enforces to use AT.FON data source to qualify EU VATs.
        EU_VAT_QUALIFICATION_DE: Enforces to use BZST data source for non-German business partners.
        EU_VAT_QUALIFICATION_STANDARD: >-
          For a given EU VAT, it is checked whether the name and address are
          really associated with this identifier (same information maintained in
          the VAT register as provided by the user).
        EXTERNAL_SOURCES_OFF: Turns off external data sources.
        FORCE_EXTERNAL_CALL: Force external call.
        IDENTIFIER_CHECKS: >-
          Validate business (VAT, tax, business register IDs) and location
          identifiers against different data quality rules categories.
        IDENTIFIER_QUALIFICATION: >-
          Turns on identifier qualification (standard) which enables to qualify
          EU VAT identifiers.
        LAB_BETA: Deprecated feature.
        QUALIFICATION_SILENT_MODE: >-
          If enabled all exceptions occurring within execution of business rules
          are ignored. If not enabled then execution error will result in
          creating data defect. By default, part of profile QUALIFICATION.
        SHOW_BUSINESSPARTNER: Shows business partner that was used in the request.
        SHOW_DATA_DEFECTS: Shows found data defects - usually it is turned on.
        SHOW_DEBUG_INFO: >-
          Shows additional information about validation process (number of
          applied rules, used categories, failed executions etc.).
        SHOW_DECISIONS: Deprecated feature.
        SHOW_LOOKUP_RESULTS: >-
          Displays results from the lookup endpoint (usually enriched data in
          comparison to the original business partner requested).
        SHOW_QUALIFICATION_DECISIONS: >-
          Shows qualification decisions - used only in qualification endpoint in
          API v3. In APIv1 and APIv2 it is used in validation endpoint.
        USE_SPARQL_VALIDATOR: Deprecated feature.
    TestCustomRuleTestCase:
      type: object
      description: Test case for a custom rule.
      properties:
        name:
          type: string
          description: Name of the test case.
          example: Test case 1
        data:
          type: string
          description: >-
            JSON object with test case data. If data and jsonRecord are present,
            exception will be thrown.
          example: '{\"name\":\"demo\"}'
        jsonRecord:
          type: object
          description: >-
            Stringified test case data. If data and jsonRecord are present,
            exception will be thrown.
          additionalProperties: true
          example: '{\"name\":\"demo\"}'
    TestCustomRuleResult:
      type: object
      description: Result of testing a custom rule.
      properties:
        testCaseName:
          type: string
          description: Name of the test case.
          example: Test case 1
        status:
          type: string
          description: >
            Indicates if the data defect was found, no data defect found or an
            error occurred during the execution.

            Possible values: 

            * `NO_RESULT`, 

            * `RESULT_FOUND`, 

            * `ERROR`.
          example: RESULT_FOUND
        result:
          type: string
          description: Contains data that was returned by the SPARQL Query.
          example: >-
            "( ?identifierValue = \"ESB54751110\" ) ( ?content = \"XXX\" ) (
            ?dataSource = \"AT.FON\" ) ( ?decision = \"INVALID\" ) (
            ?identifierKey = \"EU_VAT_ID_ES\" ) ( ?parentConceptUrl =
            \"https://meta.cdq.com/Address/locality\\" ) ( ?contentSelector =
            \"businessPartner.addresses[0].localities[type=CITY].value\" ) (
            ?contentSelectorUrl =
            \"https://meta.cdq.com/Address/locality/value\\" ) ( ?recordId =
            \"658ba67d-8003-45f0-ad46-536504fb88cf\" ) ( ?parentConceptId =
            \"CITY\" ) ( ?cdqId = \"AT.FON:ESB54751110\" ) ( ?errorCode =
            \"200\" ) ( ?parentConceptIdSelector =
            \"businessPartner.addresses[0].localities[type=CITY].type.technicalKey\"
            )"
        errorMessage:
          type: string
          description: >-
            Contains information in case of execution error, can describe
            lexical errors within Query or execution errors.
          example: There is a misspelled word s at line 43, column 37
        resultCount:
          type: integer
          description: Number of results.
          example: '1'
    RuleStatus:
      type: string
      description: The status of a validation rule.
      example: RELEASED
      default: RELEASED
      enum:
        - RELEASED
        - DRAFT
        - HYPERCARE
      x-enumDescriptions:
        RELEASED: >-
          Rule was moved from status PLANNED automatically during daily testing
          or by manual maintenance.
        DRAFT: Rule was created as a draft and it will be not executed.
        HYPERCARE: >-
          Rule was moved from status DEACTIVATED automatically during daily
          testing.
    JobTag:
      type: string
      description: Tags job with the string value.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
      maxLength: 100
    IdentifierResults:
      type: array
      items:
        $ref: '#/components/schemas/IdentifierResult'
    IdentifierResult:
      type: object
      description: Result of a identifier check for a single Business Partner.
      properties:
        property:
          $ref: '#/components/schemas/IdentifierProperty'
        reliabilityLevel:
          $ref: '#/components/schemas/ReliabilityLevel'
        qualificationDecisions:
          type: array
          description: List of Qualification Decisions for a single identifier.
          items:
            $ref: '#/components/schemas/QualificationDecision'
    IdentifierProperty:
      type: object
      description: >-
        Information about identifier that the identifier checks were executed
        against.
      properties:
        value:
          type: string
          description: Value of identifier that was processed to obtain identifier result.
          example: DE119267630
        type:
          type: string
          description: Type of identifier that was processed to obtain identifier result.
          example: EU_VAT_ID_DE
    ReliabilityLevel:
      type: object
      description: >-
        Summarized information made up from executed identifier checks and
        contains detailed identifier check information.
      properties:
        name:
          $ref: '#/components/schemas/IdentifierName'
        url:
          $ref: '#/components/schemas/IdentifierUrl'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        checks:
          $ref: '#/components/schemas/IdentifierChecks'
    IdentifierChecks:
      type: array
      description: List of Identifier Checks.
      items:
        $ref: '#/components/schemas/IdentifierCheck'
    IdentifierCheck:
      type: object
      description: >
        Confirms correctness of identifier, depending on executed check it will
        have different value. 


        The highest value the more trusted the identifier is. There’s 4
        categories of identifier checks:


        * [value 2](https://meta.cdq.com/Identifier_format)

        * [value 3](https://meta.cdq.com/Identifier_checkdigit)

        * [value 4](https://meta.cdq.com/Identifier_existence)

        * [value 5](https://meta.cdq.com/Identifier_qualification)
      properties:
        name:
          $ref: '#/components/schemas/IdentifierName'
        url:
          $ref: '#/components/schemas/IdentifierUrl'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        status:
          type: string
          deprecated: true
          description: Identifiers Check's status.
          example: OK
          enum:
            - OK
            - FAILED
          x-enumDescriptions:
            OK: Task has been processed successful.
            FAILED: Task has been failed.
        validity:
          type: object
          description: Replacement of status field to describe status of `IdentifierCheck`.
          properties:
            name:
              type: string
              description: Name of the status.
              example: Valid
            description:
              type: string
              description: Description of the status.
              example: >-
                Identifier check was executed with success, confirms that
                identifier is meeting requirement for check to pass.
            technicalKey:
              type: string
              description: Technical key of the status.
              example: VALID
              enum:
                - VALID
                - INVALID
                - UNKNOWN
              x-enumDescriptions:
                VALID: >-
                  Identifier check was executed with success, confirms that
                  identifier is meeting requirement for check to pass.
                INVALID: >-
                  Identifier check was executed with success, confirms that
                  identifier is not meeting the requirements for check to pass.
                UNKNOWN: >-
                  Identifier check was executed with failure, confirmation of
                  the status cannot be provided, this usually happens because of
                  external service failure.
        message:
          type: string
          description: Provides an information in case of identifier check failure.
          example: External service error.
    IdentifierName:
      type: string
      description: Name of executed identifier check.
      example: Identifier existence
    IdentifierUrl:
      type: string
      description: URL to the type of identifier check.
      example: https://meta.cdq.com/Identifier_existence
    IdentifierValue:
      type: integer
      description: Number from 2 to 5, describes how trusted the identifier is.
      example: '4'
    RuleCategoryOn:
      type: object
      description: >-
        Used to filter rules by its category. If any value is present then only
        rules of given category will be promoted to execution.
      properties:
        url:
          $ref: '#/components/schemas/RuleCategoryUrl'
    QualificationDecision:
      type: object
      description: >
        Decision made by qualification process for a single identifier. 

        It contains information about the decision, properties that were
        involved in the decision-making process and information about the
        identifier that was qualified.
      properties:
        properties:
          type: array
          description: Properties which have been involved in the decision-making process.
          items:
            $ref: '#/components/schemas/Property'
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
        qualificationTarget:
          type: string
          example: STREET
          description: Indicates the concept being qualified.
        decision:
          type: string
          description: Decision as returned by the qualification process.
          example: VALID
        cdqId:
          type: string
          description: >-
            CDQ ID of a Business Partner record used in a given qualification
            process.
          example: VIES:DE119267630
        dataSource:
          type: string
          description: Data source used in a given qualification process.
          example: VIES
        identifierValue:
          type: string
          description: Value of the identifier used in a given qualification process.
          example: DE119267630
        identifierType:
          type: string
          description: Type of the identifier used in a given qualification process.
          example: EU_VAT_ID_DE
        errorMessage:
          type: string
          description: Optional error message in case qualification rule fails.
          example: Example.
        externalServiceResponse:
          $ref: '#/components/schemas/ExternalServiceResponse'
    BusinessPartnerValidationConfiguration:
      type: object
      description: >-
        Configuration of the validation process for a single Business Partner
        record.
      properties:
        validationProfile:
          $ref: '#/components/schemas/schemas-ValidationProfile'
        ruleStatuses:
          type: array
          description: Enable rules with provided statuses.
          items:
            $ref: '#/components/schemas/ValidationRuleStatus'
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/schemas-ValidationFeature'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/schemas-ValidationFeature'
        ruleCategoriesOn:
          type: array
          description: List of rule categories to be activated.
          items:
            $ref: '#/components/schemas/ValidationRuleCategoryParam'
        ignoredRules:
          type: array
          description: List of rules to be ignored.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        activatedRules:
          type: array
          description: List of rules to be activated.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        criticalities:
          type: array
          description: List of criticalities.
          items:
            $ref: '#/components/schemas/ValidationCriticality'
        dataSourcesOn:
          type: array
          description: List of Data Sources to be activated.
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: List of Data Sources to be deactivated.
          items:
            $ref: '#/components/schemas/DataSource'
        violationMessages:
          $ref: '#/components/schemas/ViolationMessages'
    ValidationRuleCategoryParam:
      type: object
      description: >-
        Category of rules - usually goal oriented, like Identifier missing,
        Dummy Postal Code or Country Invalid.
      properties:
        url:
          $ref: '#/components/schemas/ValidationRuleCategoryUrl'
    ValidationCriticality:
      type: object
      description: Represents violation level.
      properties:
        businessRuleUrl:
          $ref: '#/components/schemas/BusinessRuleUrl'
        violationLevel:
          $ref: '#/components/schemas/schemas-ViolationLevel'
    ViolationMessages:
      type: array
      description: List of violation messages.
      items:
        $ref: '#/components/schemas/ViolationMessage'
    ViolationMessage:
      type: object
      description: >-
        Represents the information what was the problem (it shows only when a
        data defect was found).
      properties:
        businessRuleUrl:
          $ref: '#/components/schemas/BusinessRuleUrl'
        violationMessage:
          type: string
          description: Violation message that is returned with detected data defect.
          example: Business Partner identifier is mandatory.
    RulesInError:
      type: array
      description: List of rules executed with error.
      items:
        $ref: '#/components/schemas/RuleExecutionResult'
    RuleExecutionResult:
      type: object
      description: >-
        Represents Data Quality Rules that executed with failure ex. external
        service was not responding.
      properties:
        businessRule:
          $ref: '#/components/schemas/BusinessRule'
        executionStatus:
          $ref: '#/components/schemas/BusinessRuleExecutionStatus'
        error:
          $ref: '#/components/schemas/ApiError'
        ruleResult:
          $ref: '#/components/schemas/BusinessRuleResult'
        violationLevel:
          $ref: '#/components/schemas/schemas-ViolationLevel'
        validationSource:
          $ref: '#/components/schemas/schemas-ValidationSource'
    BusinessRuleExecutionStatus:
      type: string
      description: >-
        Information about the execution process of the rule. For rules executed
        correctly `0` or `200`, whenever rule execution is failing by external
        data sources the status is `500`.
      example: '500'
    ApiErrorWithStatus:
      type: object
      description: Detailed information about API errors.
      properties:
        status:
          $ref: '#/components/schemas/Status'
    SingleRecordValidationRequest:
      type: object
      description: Request for validation of a single record.
      allOf:
        - $ref: '#/components/schemas/RecordValidationRequest'
        - type: object
          description: |
            Request for validation of a single record.

            For single request you can provide only one of the following:
              - `jsonRecord`
              - `record`

            Only one can be supported at a time,
          properties:
            jsonRecord:
              type: object
              description: Stringified JSON of the custom record.
              additionalProperties: true
              example: '{}'
            record:
              type: string
              description: Stringified JSON of the custom record
              example: '{}'
            externalId:
              type: string
              description: Unique ID from the client system.
              example: A12345
    BusinessPartnerChunkItemResult:
      type: object
      description: Contains information about created record during Validation Process.
      properties:
        externalId:
          type: string
          description: Refers to the externalId of the provided Business Partner.
          example: A12345
        businessPartnerId:
          type: string
          description: Refers to the id of the provided Business Partner.
          example: 12312dc000572b1594f3f000
        validationResult:
          $ref: '#/components/schemas/BusinessPartnerValidationResult'
    BusinessPartnerChunkValidationWithQualificationResult:
      type: object
      description: Contains information about created record during Validation Process.
      properties:
        results:
          type: array
          description: List of results for each Business Partner in the chunk.
          items:
            $ref: '#/components/schemas/BusinessPartnerChunkItemWithQualification'
    BusinessPartnerChunkItemWithQualification:
      type: object
      description: Item result with qualification information.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerChunkItemResult'
        - type: object
          description: Temporary object for qualificationV3.
          properties:
            qualificationV3:
              $ref: '#/components/schemas/BusinessPartnerQualificationSummary'
    BusinessPartnerQualificationSummary:
      type: object
      description: >-
        Summary of the Business Partner qualification result without the full
        Business Partner object.
      properties:
        qualificationResults:
          type: array
          description: List of Qualifications Results.
          items:
            $ref: '#/components/schemas/BusinessPartnerQualificationResultItem'
        rulesInError:
          $ref: '#/components/schemas/RulesInError'
        debugInfo:
          $ref: '#/components/schemas/DebugInfo'
    BusinessPartner3:
      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.
      properties:
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/Name2'
        legalForm:
          $ref: '#/components/schemas/LegalForm2'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/Identifier2'
        categories:
          type: array
          description: List of categories of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategory2'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus2'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/Address3'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        formattedSapRecord:
          $ref: '#/components/schemas/FormattedSapRecord'
        relations:
          type: array
          description: List of relations of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
        bankAccounts:
          type: array
          description: List of bank accounts of the Business Partner.
          items:
            $ref: '#/components/schemas/BankAccount2'
        types:
          type: array
          description: List of types of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
        externalContext:
          $ref: '#/components/schemas/ExternalContext'
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
        lastModifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    Name2:
      type: object
      description: The name of a Business Partner.
      example: Corporate Data Quality AG
      properties:
        shortName:
          $ref: '#/components/schemas/NameShortName'
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        language:
          $ref: '#/components/schemas/Language'
    LegalForm2:
      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.).
      example: Aktiengesellschaft
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        language:
          $ref: '#/components/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'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormTechnicalKey'
    LegalFormCategory:
      type: object
      description: The categorization of a Legal Form.
      properties:
        name:
          $ref: '#/components/schemas/LegalFormCategoryName'
        shortName:
          $ref: '#/components/schemas/LegalFormCategoryShortName'
        url:
          $ref: '#/components/schemas/LegalFormCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormCategoryTechnicalKey'
    Identifier2:
      type: object
      description: >-
        Identifies a Business Partner in a given context uniquely such as a VAT
        identification number.
      example: VAT identification number
      properties:
        value:
          $ref: '#/components/schemas/schemas-IdentifierValue'
        type:
          $ref: '#/components/schemas/IdentifierType2'
        status:
          $ref: '#/components/schemas/IdentifierStatus'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody2'
    IdentifierType2:
      type: object
      description: Type of the identifier.
      example: CH_VAT_ID
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    IdentifierStatus:
      type: object
      description: >-
        Identifier Status refers to the current state of a unique identification
        number.
      example: ACTIVE
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        url:
          $ref: '#/components/schemas/IdentifierStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    IssuingBody2:
      type: object
      description: >-
        An Issuing Body is an organization or government institution that is
        responsible for assigning unique identifiers to individuals,
        organizations, or objects.
      example: Amtsgericht Aachen
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        description:
          $ref: '#/components/schemas/IssuingBodyDescription'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction2'
        gleifCode:
          $ref: '#/components/schemas/IssuingBodyGleifCode'
        localAuthorityCode:
          $ref: '#/components/schemas/IssuingBodyLocalAuthorityCode'
        externalUrl:
          $ref: '#/components/schemas/IssuingBodyExternalUrl'
    Jurisdiction2:
      type: object
      description: >-
        The authority of an official organization to make decisions and
        judgments in a particular administrative area.
      example: Switzerland
      properties:
        country:
          $ref: '#/components/schemas/Country2'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/AdministrativeArea2'
    Country2:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      example: Switzerland CH
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
        value:
          $ref: '#/components/schemas/CountryValue'
    AdministrativeArea2:
      type: object
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        shortName:
          $ref: '#/components/schemas/AdministrativeAreaShortName'
        fipsCode:
          $ref: '#/components/schemas/AdministrativeAreaFipsCode'
        isoCode:
          $ref: '#/components/schemas/AdministrativeAreaIsoCode'
        type:
          $ref: '#/components/schemas/AdministrativeAreaType2'
        language:
          $ref: '#/components/schemas/Language'
    AdministrativeAreaType2:
      type: object
      description: Type of the Administrative Area.
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    BusinessPartnerCategory2:
      type: object
      description: >-
        A business partner category of a business partner groups similar
        business partners.
      example: Hotel
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        url:
          $ref: '#/components/schemas/BusinessPartnerCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    BusinessPartnerStatus2:
      type: object
      description: >-
        Describes the status of a business partner with respect to its level of
        activity (e.g. out of business) or legally relevant conditions (e.g. in
        liquidation).
      properties:
        officialDenotation:
          $ref: '#/components/schemas/BusinessPartnerStatusOfficialDenotation'
        validFrom:
          $ref: '#/components/schemas/BusinessPartnerStatusValidFrom'
        validUntil:
          $ref: '#/components/schemas/BusinessPartnerStatusValidUntil'
        type:
          $ref: '#/components/schemas/BusinessPartnerStatusType2'
    BusinessPartnerStatusType2:
      type: object
      description: The standardized status which the business partner currently has.
      example: In Liquidation
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    Address3:
      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).
      example: Lukasstraße 4, 9008 St. Gallen
      properties:
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        metadata:
          $ref: '#/components/schemas/AddressMetadata'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          description: List of Address contexts.
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/Country2'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea2'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode2'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality2'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare2'
        premises:
          type: array
          description: List of Premises.
          items:
            $ref: '#/components/schemas/Premise2'
        postalDeliveryPoints:
          type: array
          description: List of Postal Delivery Points.
          items:
            $ref: '#/components/schemas/PostalDeliveryPoint2'
        openingHours:
          type: array
          description: List of Opening Hours.
          items:
            $ref: '#/components/schemas/OpeningHour'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates2'
        types:
          type: array
          description: List of types of the Address.
          items:
            $ref: '#/components/schemas/AddressType2'
        formattedAddress:
          $ref: '#/components/schemas/FormattedAddress'
    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.
      example: John Doe
      properties:
        value:
          $ref: '#/components/schemas/AddressIdentifyingNameValue'
    AddressMetadata:
      type: object
      description: Specifies the language and primary data provenance.
      example: DE, Google
      properties:
        primaryProvenance:
          $ref: '#/components/schemas/Provenance'
        language:
          $ref: '#/components/schemas/Language'
    Provenance:
      type: object
      description: >-
        The source of the change/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'
    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.
      example: CDQ GmbH c/o Product Department
      properties:
        value:
          $ref: '#/components/schemas/CareOfValue'
    AddressContext:
      type: object
      description: >-
        The address context provides us with some additional information about
        the usage or specific recipient information of the addresses. It may
        hold multiple information organized as "tags".
      example: Production hall 7, Storage field 8.
      properties:
        value:
          $ref: '#/components/schemas/AddressContextValue'
    PostCode2:
      type: object
      description: >-
        A country specific code for a certain address component or an
        combination of address components, e.g. locality.
      example: '9000'
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    Locality2:
      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.
      example: Sankt Gallen
      properties:
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        value:
          $ref: '#/components/schemas/LocalityValue'
        language:
          $ref: '#/components/schemas/Language'
    Thoroughfare2:
      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.
      example: Lukasstraße 4
      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'
    Premise2:
      type: object
      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
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        shortName:
          $ref: '#/components/schemas/PremiseShortName'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseType2'
        language:
          $ref: '#/components/schemas/Language'
    PremiseType2:
      type: object
      description: Type of the Premise.
      example: Building
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PremiseTypeTechnicalKey'
    PostalDeliveryPoint2:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
      properties:
        type:
          $ref: '#/components/schemas/PostalDeliveryPointType2'
        shortName:
          $ref: '#/components/schemas/PostalDeliveryPointShortName'
        number:
          $ref: '#/components/schemas/PostalDeliveryPointNumber'
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        language:
          $ref: '#/components/schemas/Language'
    PostalDeliveryPointType2:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostalDeliveryPointTypeTechnicalKey'
    GeographicCoordinates2:
      type: object
      description: Decimal geographic coordinates (WGS 84 - reference coordinate system).
      example: 47.439549, 9.395275
      properties:
        latitude:
          $ref: '#/components/schemas/GeographicCoordinatesLatitude'
        longitude:
          $ref: '#/components/schemas/GeographicCoordinatesLongitude'
    AddressType2:
      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.
      example: Legal Address
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    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'
    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'
        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'
    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.
      example: Commercial ultimate
      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'
    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'
        url:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeTechnicalKey'
    BusinessPartnerRelationClass:
      type: object
      description: Provides information about the classification of the relation.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationClassName'
        url:
          $ref: '#/components/schemas/BusinessPartnerRelationClassUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
    BankAccount2:
      type: object
      description: >-
        A bank account record holds information that universally describes a
        registered bank account.
      properties:
        internationalBankAccountIdentifier:
          $ref: '#/components/schemas/InternationalBankAccountIdentifier'
        internationalBankIdentifier:
          $ref: '#/components/schemas/InternationalBankIdentifier'
        nationalBankAccountIdentifier:
          $ref: '#/components/schemas/NationalBankAccountIdentifier'
        nationalBankIdentifier:
          $ref: '#/components/schemas/NationalBankIdentifier'
        bank:
          $ref: '#/components/schemas/Bank2'
        countryCode:
          $ref: '#/components/schemas/BankAccountCountryCode'
    Bank2:
      type: object
      description: >-
        Financial institution that accepts deposits, facilitates withdrawals and
        transfers, and provides various financial services such as loans,
        investments, and currency exchange.
      properties:
        name:
          $ref: '#/components/schemas/BankName'
        branch:
          $ref: '#/components/schemas/BankBranch'
        address:
          $ref: '#/components/schemas/BankAddress2'
    BankAddress2:
      type: object
      description: The address where a bank resides.
      properties:
        localities:
          type: array
          items:
            $ref: '#/components/schemas/Locality2'
        country:
          $ref: '#/components/schemas/Country2'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/AdministrativeArea2'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/PostCode2'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/Thoroughfare2'
    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'
    ExternalContext:
      type: object
      description: Describe own identifiers of a record (others than just the external Id).
      example: LIFNR
      properties:
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/ExternalContextIdentifier'
    ExternalContextIdentifier:
      type: object
      description: Describe own identifiers of a record (others than just the external Id).
      example: LIFNR
      properties:
        value:
          $ref: '#/components/schemas/ExternalContextIdentifierValue'
        type:
          $ref: '#/components/schemas/ExternalContextIdentifierType'
    RuleCategory:
      type: object
      description: >-
        A rule category is a group of rules that are related to each other. Rule
        categories are used to filter rules by its category. If any value is
        present then only rules of given category will be promoted to execution.
      properties:
        url:
          $ref: '#/components/schemas/RuleCategoryUrl'
        name:
          $ref: '#/components/schemas/RuleCategoryName'
    RuleCategoryName:
      type: string
      description: Name of the rule category.
      example: Identifier checkdigit
    BusinessPartnerParam:
      type: object
      description: >-
        Refers to an organizational entity engaged in various facets of another
        organization's business interactions. This collaborative connection
        often manifests as a customer, supplier, vendor, or service provider. In
        the CDQ (Corporate Data Quality) framework, the Business Partner assumes
        a pivotal role as a core managed entity. Each Business Partner is
        distinctly and globally identifiable through a unique CDQ ID. All
        pertinent information, including addresses, identifiers, and
        hierarchical data, is intricately associated with and linked to the
        specific Business Partner, ensuring comprehensive management and
        traceability within the system.
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/NameParam'
        legalForm:
          $ref: '#/components/schemas/LegalFormParam'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/IdentifierParam'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/Address2'
    Address2:
      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:
        country:
          $ref: '#/components/schemas/CountryParam'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/ThoroughfareParam'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCodeParam'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/LocalityParam'
        premises:
          type: array
          description: List of Premises.
          items:
            $ref: '#/components/schemas/PremiseParam'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeAreaParam'
        postalDeliveryPoints:
          type: array
          description: List of Postal Delivery Points.
          items:
            $ref: '#/components/schemas/PostalDeliveryPointParam'
    RecordChunkValidationRequest:
      type: object
      description: Request for validation of a chunk of records.
      allOf:
        - $ref: '#/components/schemas/RecordValidationRequest'
        - type: object
          description: Request for validation of a chunk of records.
          required:
            - records
          properties:
            records:
              type: array
              description: >-
                Stringified test case data. If data and jsonRecord are present,
                exception will be thrown.
              items:
                $ref: '#/components/schemas/RecordParam'
    RecordParam:
      type: object
      description: A single record to be validated.
      properties:
        jsonRecord:
          type: object
          description: Stringified JSON of the custom record.
          additionalProperties: true
        record:
          type: string
          description: >-
            Stringified test case data. If data and jsonRecord are present,
            exception will be thrown.
          example: '{\"name\":\"demo\"}'
        externalId:
          type: string
          description: Unique id from the client system.
          example: A12345
    RecordChunkItemResult:
      type: object
      description: Validation result of a single record.
      properties:
        externalId:
          type: string
          description: >-
            Binds record chunk item result to the record from data or jsonRecord
            of RecordParam.
          example: A12345
        validationResult:
          $ref: '#/components/schemas/RecordValidationResult'
    RecordChunkValidationResult:
      type: object
      description: Validation result of a single record.
      properties:
        results:
          type: array
          description: List of Validation Results.
          items:
            $ref: '#/components/schemas/RecordChunkItemResult'
    SingleBusinessPartnerValidationRequest:
      type: object
      description: Request for validation of a single business partner.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerValidationRequest'
        - type: object
          description: Request for validation of a single business partner.
          required:
            - businessPartner
          properties:
            businessPartner:
              $ref: '#/components/schemas/BusinessPartnerParam'
    BusinessPartnerValidationJobResultPage:
      type: object
      description: >-
        Single page of results fetched from Job Result Storage that was
        populated with validation results made by Business Partner Validation
        Job.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of validation results.
          items:
            $ref: '#/components/schemas/BusinessPartnerValidationResult'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
    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: VALIDATION_LOG
    ProcessingLogTriggerType:
      type: string
      description: >-
        Processing log trigger type determining way how the validation item has
        been triggered.
      example: API
    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: '12345'
    BusinessPartnerValidationJob:
      type: object
      description: Represents a job for validating a Business Partner.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerValidationJobRequest'
        - type: object
          description: Represents a job for validating a Business Partner.
          properties:
            id:
              $ref: '#/components/schemas/JobId'
            status:
              $ref: '#/components/schemas/JobStatus'
            createdAt:
              $ref: '#/components/schemas/CreatedAt'
            finishedAt:
              $ref: '#/components/schemas/FinishedAt'
            user:
              $ref: '#/components/schemas/UserId'
            progress:
              $ref: '#/components/schemas/JobProgress'
    BusinessPartnerValidationJobRequest:
      type: object
      description: Job request for validation of a single Business Partner.
      allOf:
        - $ref: '#/components/schemas/ValidationJobRequest'
        - type: object
          description: Job request for validation of a single Business Partner.
          properties:
            ruleCategoriesOn:
              type: array
              description: >-
                List of rule categories that are used to filter rules by its
                category. If any value is present then only rules of given
                category will be promoted to execution.
              items:
                $ref: '#/components/schemas/RuleCategory'
            ignoredRules:
              type: array
              description: Urls of cdl rules ignored during validation process.
              items:
                $ref: '#/components/schemas/BusinessRuleUrl'
            activatedRules:
              type: array
              description: Urls of cdl rules that are active during validation process.
              items:
                $ref: '#/components/schemas/BusinessRuleUrl'
            updatedFrom:
              type: string
              description: >-
                Makes the job validate entries which were modified after given
                date described in ISO-8601 format.
              example: '2025-10-07T05:40:33Z'
            dataSourceIds:
              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).
              type: array
              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'
            configurationId:
              $ref: '#/components/schemas/ConfigurationId'
            criticalities:
              type: array
              description: This parameter can modify criticality level of given rule.
              items:
                $ref: '#/components/schemas/Criticality'
    RecordValidationJob:
      type: object
      description: Job for validation of a single record.
      allOf:
        - $ref: '#/components/schemas/RecordValidationJobRequest'
        - type: object
          description: Job for validation of a single record.
          properties:
            id:
              $ref: '#/components/schemas/JobId'
            status:
              type: string
              description: Current status of the job.
              example: FINISHED
              enum:
                - ARCHIVED
                - UNKNOWN
                - CREATED
                - PERSISTED
                - SCHEDULED
                - WAITING
                - COULDNT_START
                - RUNNING
                - FINISHED
                - DIED
                - FAILED
              x-enumDescriptions:
                UNKNOWN: Job becomes in unknown status.
                CREATED: Job has been created.
                PERSISTED: Job metadata has been persisted.
                SCHEDULED: Job has been scheduled for execution.
                WAITING: Job is waiting for being scheduled.
                COULDNT_START: Job couldn't start.
                RUNNING: Job is being executed.
                FINISHED: Job has finished.
                DIED: Job has died due to unhandled exceptions.
                FAILED: Job has failed.
            createdAt:
              $ref: '#/components/schemas/CreatedAt'
            finishedAt:
              $ref: '#/components/schemas/FinishedAt'
            user:
              $ref: '#/components/schemas/JobUser'
            progress:
              $ref: '#/components/schemas/JobProgress'
            result:
              $ref: '#/components/schemas/RecordValidationResult'
    RecordValidationJobResultPage:
      type: object
      description: Page of validation results.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of validation results.
          items:
            $ref: '#/components/schemas/RecordValidationResult'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
    RecordValidationJobRequest:
      type: object
      description: Parameters for validation of a single record.
      required:
        - storageId
        - customKnowledgeGraph
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        customKnowledgeGraph:
          type: string
          description: >-
            Identifier for the custom knowledge graph that should be used for
            validation.
          example: kg_1_m_1
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        profile:
          type: string
          description: Profile which is used during validation. Default value is STANDARD.
          example: QUICK
          enum:
            - QUICK
            - STANDARD
          x-enumDescriptions:
            QUICK: >-
              This profile checks data quality of records in a quick way, i.e.
              data quality rules that have a negative impact on performance
              (e.g. rules that use external webservices) are not executed. It
              does not provide a full check comprising all data quality rules,
              but allows for a rapid, initial assessment of data quality.
            STANDARD: >-
              This profile checks data quality using CDQ's standard
              configuration
        ruleStatuses:
          type: array
          description: Filter for rule status.
          items:
            $ref: '#/components/schemas/RuleStatus'
        featuresOn:
          type: array
          description: Activate features.
          items:
            type: string
            description: Feature to be activated.
            example: SHOW_LOOKUP_RESULTS
            enum:
              - SHOW_LOOKUP_RESULTS
              - SHOW_DEBUG_INFO
              - LAB_BETA
              - ENRICH_LEGAL_FORM
              - ENRICH_CATEGORIES
              - USE_SPARQL_VALIDATOR
              - QUALIFICATION_SILENT_MODE
              - EXTERNAL_SOURCES_OFF
              - SHOW_BUSINESSPARTNER
              - MED_REG_VALIDATION
            x-enumDescriptions:
              SHOW_LOOKUP_RESULTS: >-
                Displays results from the lookup endpoint (usually enriched data
                in comparison to the original business partner requested).
              SHOW_DEBUG_INFO: >-
                Shows additional information about validation process (number of
                applied rules, used categories, failed executions etc.).
              LAB_BETA: Deprecated feature.
              ENRICH_LEGAL_FORM: Identify and enriches the legal form of a company.
              ENRICH_CATEGORIES: >-
                Enrich a CDL community standardized business partner category
                for a given entity.
              USE_SPARQL_VALIDATOR: Deprecated feature.
              QUALIFICATION_SILENT_MODE: >-
                If enabled all exceptions occurring within execution of business
                rules are ignored. If not enabled then execution error will
                result in creating data defect. By default, part of profile
                QUALIFICATION.
              EXTERNAL_SOURCES_OFF: Turns off external data sources.
              SHOW_BUSINESSPARTNER: Shows business partner that was used in the request.
              MED_REG_VALIDATION: >-
                If enabled it will execute validation only for `MED_REG`
                records. Applies only to Record Validation Job.
        ruleCategoriesOn:
          type: array
          description: Categories use for selecting active business rules.
          items:
            $ref: '#/components/schemas/RuleCategory'
        ignoredRules:
          type: array
          description: Urls of cdl rules ignored during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        activatedRules:
          type: array
          description: Urls of cdl rules that are active during validation process.
          items:
            $ref: '#/components/schemas/BusinessRuleUrl'
        dataSourcesOn:
          type: array
          description: >-
            If data sources are disabled by feature toggle you can enable some
            of them passing their prefixes here.
          items:
            $ref: '#/components/schemas/DataSource'
        dataSourcesOff:
          type: array
          description: >-
            Rules with data sources passed here are not used in validation
            process.
          items:
            $ref: '#/components/schemas/DataSource'
        updatedFrom:
          type: string
          description: >-
            Makes the job validate entries which were modified after given date
            described in ISO-8601 format.
          example: '2025-10-07T05:40:33Z'
        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:
          type: array
          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).
          items:
            $ref: '#/components/schemas/CountryShortName'
    BusinessPartnerChunkValidationRequest:
      type: object
      description: Request for Business Partner Validation.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerValidationRequest'
        - type: object
          description: Request for Business Partner Validation.
          properties:
            businessPartners:
              type: array
              items:
                $ref: '#/components/schemas/BusinessPartner3'
    ValidationChunkWorkerResult:
      type: object
      description: Result of validation chunk.
      allOf:
        - $ref: >-
            #/components/schemas/BusinessPartnerChunkValidationWithQualificationResult
        - type: object
          description: Result of Business Partner Validation.
          properties:
            numberOfProcessingLogTasksSent:
              $ref: >-
                #/components/schemas/ValidationChunkWorkerResultNumberOfProcessingLogTasksSent
    ValidationChunkWorkerResultNumberOfProcessingLogTasksSent:
      type: integer
      description: Number of processing logs tasks sent.
      example: '1'
    Criticality:
      type: object
      description: Criticality level of a Business Rule.
      properties:
        businessRuleUrl:
          $ref: '#/components/schemas/BusinessRuleUrl'
        violationLevel:
          $ref: '#/components/schemas/ViolationLevelEnum'
    ValidationProcessingLogResultPage:
      type: object
      description: Page of validation log entries.
      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 data was
            created.
          example: '2025-10-07T05:40:33Z'
        to:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result data was
            created.
          example: '2025-10-07T05:40:33Z'
        total:
          type: integer
          description: Total number of validation log entries.
          format: int32
          example: '20'
        values:
          type: array
          description: List of validation log entries.
          items:
            $ref: '#/components/schemas/ValidationProcessingLogResult'
    ValidationProcessingLogResult:
      type: object
      description: Validation log entry.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/StorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        addressId:
          type: string
          description: ID of the address in the storage or data mirror.
          example: '123456789'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        addressExternalId:
          $ref: '#/components/schemas/AddressExternalId'
        status:
          type: string
          default: OK
          description: Can be OK or FAILED - default is OK.
          example: OK
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatus'
        message:
          type: string
          description: Additional explanations for status - especially for the FAILED case.
          example: Validation failed
        validationResult:
          $ref: '#/components/schemas/BusinessPartnerValidationResult'
        executedAt:
          $ref: '#/components/schemas/CreatedAt'
    ProcessingStatus:
      type: object
      description: Processing status.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProcessingStatusTechnicalKey'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    ValidationProcessingLogIdParam:
      type: string
      description: Validation processing log id to which data should be upserted by worker.
      example: VALIDATION_LOG
      default: VALIDATION_LOG
      enum:
        - VALIDATION_LOG
        - VALIDATION_SHARING_LOG
      x-enumDescriptions:
        VALIDATION_LOG: Validation log id for validation results.
        VALIDATION_SHARING_LOG: Validation log id for sharing validation results.
    BusinessRuleName:
      type: string
      description: Represents business rule name.
      example: >-
        Identifier unknown (European value added tax identifier (The
        Netherlands))
    BusinessRuleUrl:
      type: string
      description: Represents Data Quality Rule url.
      example: >-
        https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))
    ViolationLevelEnum:
      type: string
      description: >
        Indicates the criticality of the applied rule. 

        If a data defect was found then user will get `INFO`, `WARNING` or
        `ERROR` level. Otherwise, it will be NO_DEFECT.
      example: INFO
      enum:
        - NO_DEFECT
        - INFO
        - WARNING
        - ERROR
      x-enumDescriptions:
        NO_DEFECT: Validation has found no defect. This is the default value.
        INFO: Information.
        WARNING: Warning.
        ERROR: Error.
    ApiErrorTimestamp:
      type: string
      deprecated: true
      description: ISO 8601 representation of the timestamp.
      example: '2025-10-07T05:40:33Z'
    ApiErrorMessage:
      type: string
      deprecated: true
      description: Details about the error.
      example: This user is not allowed to access this service.
    HttpError:
      type: string
      description: RFC 7231 error which belongs to the status code.
      example: BAD_REQUEST
      deprecated: true
    HttpPath:
      type: string
      description: Requested path which caused this error.
      example: /v2/businesspartners/lookup
    HttpStatus:
      type: integer
      description: RFC 7231 status code for this error.
      example: '400'
      deprecated: true
    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.
    StatusTechnicalKey:
      type: string
      description: Technical key for the HTTP status code
      example: OK
    StatusTimestamp:
      type: string
      description: ISO 8601 representation of the timestamp.
      example: '2025-10-07T05:40:33Z'
    BusinessPartnerQualificationRequestProfileEnum:
      type: string
      description: Qualification profiles enum.
      default: EU_TAX_QUALIFICATION
      example: EU_TAX_QUALIFICATION
      enum:
        - EU_TAX_QUALIFICATION
        - WORLDWIDE_TAX_QUALIFICATION
      x-enumDescriptions:
        EU_TAX_QUALIFICATION: >-
          Default option. EU_TAX_QUALIFICATION  profile for the Qualification
          process.
        WORLDWIDE_TAX_QUALIFICATION: WORLDWIDE_TAX_QUALIFICATION profile for the Qualification process.
    BusinessPartnerQualificationRequestFeaturesEnum:
      type: string
      description: Qualification features enum.
      example: FORCE_EXTERNAL_CALL
      enum:
        - SHOW_LOOKUP_RESULTS
        - SHOW_BUSINESS_PARTNER
        - FORCE_EXTERNAL_CALL
        - SHOW_DEBUG_INFO
      x-enumDescriptions:
        SHOW_LOOKUP_RESULTS: Includes lookup results in the response.
        SHOW_BUSINESS_PARTNER: Includes Business Partner in the response.
        FORCE_EXTERNAL_CALL: Forces calls on external services ignoring cache.
        SHOW_DEBUG_INFO: >-
          Shows additional information about validation process (number of
          applied rules, used categories, failed executions etc.).
    BusinessPartnerId:
      type: string
      description: >-
        A CDQ ID identifies a business partner uniquely in the context of the
        Corporate Data League.
      example: 63e635235c06b7396330fe40
    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.
    AddressExternalId:
      type: string
      description: >-
        ID the address has in the external system where the record originates
        from.
      example: '1'
    CharacterSetName:
      type: string
      description: >-
        Name of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: International
    CharacterSetTechnicalKey:
      type: string
      description: >-
        Technical key of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: INTERNATIONAL
    CharacterSet:
      type: object
      description: Character set.
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    LanguageName:
      type: string
      description: ISO 639-1 name of language.
      example: German
    LanguageTechnicalKey:
      type: string
      description: ISO 639-1 two-letter code of languages.
      example: DE
    CountryShortName:
      type: string
      description: Country code (ISO 3166-1 alpha-2).
      example: CH
    CountryValue:
      type: string
      description: Country name (ISO 3166-1 alpha-2).
      example: Switzerland
    AdministrativeAreaValue:
      type: string
      description: >-
        Name of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: Sankt Gallen
    AdministrativeAreaShortName:
      type: string
      description: >-
        Abbreviation for the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: SG
    AdministrativeAreaTypeName:
      type: string
      description: Display label for the Administrative Area Type.
      example: COUNTY
    AdministrativeAreaTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative
        Area](https://meta.cdq.com/Address/administrative_area/type).
      example: https://meta.cdq.com/Address/administrative_area/type
    AdministrativeAreaTypeTechnicalKey:
      type: string
      description: Technical key of the Administrative Area.
      example: COUNTY
    PostCodeValue:
      type: string
      description: Effective [post code](https://meta.cdq.com/Address/post_code).
      example: '9000'
    PostCodeTypeName:
      type: string
      description: Display label for the Post Code Type.
      example: Regular
    PostCodeTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative Area](https://meta.cdq.com/Address/post_code/type).
      example: https://meta.cdq.com/Address/post_code/type
    PostCodeTypeTechnicalKey:
      type: string
      description: Technical key of the Post Code.
      example: REGULAR
    LocalityValue:
      type: string
      description: Name of the [Locality](https://meta.cdq.com/Address/locality).
      example: Sankt Gallen
    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
    ThoroughfareNumber:
      type: string
      description: Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: '4'
    ThoroughfareValue:
      type: string
      description: >-
        Comprehensive designation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the
        thoroughfare type such as Street, or Rue.
      example: Lukasstraße 4
    ThoroughfareName:
      type: string
      description: >-
        Pure name of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising
        the thoroughfare type such as Street, or Rue.
      example: Lukasstraße
    ThoroughfareDirection:
      type: string
      description: >-
        Direction of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: 221-bis Baker Street, North
    PremiseValue:
      type: string
      description: The actual value of a Premise in the language of the address.
      example: Lukasstraße 4
    PremiseShortName:
      type: string
      description: Abbreviation of the Premise.
      example: Lukasstr. 4
    PremiseNumber:
      type: string
      description: Number of the Premise.
      example: '4'
    PremiseTypeName:
      type: string
      description: Display label for the Premise Type.
      example: Factory
    PremiseTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Premise
        Type](https://meta.cdq.com/Address/premise/type).
      example: https://meta.cdq.com/Address/premise/type
    PremiseTypeTechnicalKey:
      type: string
      description: Technical key of the Premise Type.
      example: FACTORY
    PostalDeliveryPointTypeName:
      type: string
      description: Display label for the Postal Delivery Point Type.
      example: Mailbox
    PostalDeliveryPointTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Postal
        Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type)
      example: https://meta.cdq.com/Address/postal_delivery_point/type
    PostalDeliveryPointTypeTechnicalKey:
      type: string
      description: Technical key of the Postal Delivery Point.
      example: MAILBOX
    PostalDeliveryPointShortName:
      type: string
      description: >-
        Stort name of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: St Gallen, Postfach 460
    PostalDeliveryPointNumber:
      type: string
      description: >-
        Number of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: '460'
    PostalDeliveryPointValue:
      type: string
      description: >-
        Value of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: Postfach
    NameShortName:
      type: string
      description: The abbreviated variant of a company's full name.
      example: CDQ AG
    NameTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Name
        Type](https://meta.cdq.com/Business_partner/name/type).
      example: https://meta.cdq.com/Business_partner/name/type
    NameTypeName:
      type: string
      description: Display label for the Name Type.
      example: Local Name
    NameTypeTechnicalKey:
      type: string
      description: Technical Keys of the Name Type.
      example: LOCAL
    NameValue:
      type: string
      description: The actual name.
      example: Corporate Data Quality AG
    schemas-IdentifierValue:
      type: string
      description: Value of the identifier.
      example: CHE-218.608.886 HR/MWST
    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
    IssuingBodyName:
      type: string
      description: Preferred display label for an Issuing Body.
      example: Amtsgericht Aachen
    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
    IssuingBodyTechnicalKey:
      description: Technical key of the Issuing Body.
      example: Amtsgericht Aachen
      type: string
    LegalFormName:
      type: string
      description: Display of the Legal Form.
      example: Aktiengesellschaft
    LegalFormMainAbbreviation:
      type: string
      description: >-
        The primary abbreviation of a legal form, i.e. the most commonly used
        abbreviation in a country.
      example: AG
    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
    InternationalBankAccountIdentifier:
      type: string
      description: The IBAN of a bank account.
      example: CH8800781619278412000
    InternationalBankIdentifier:
      type: string
      description: (BIC/SWIFT) Bank identifier which is globally unique.
      example: KBSGCH22XXX
    NationalBankAccountIdentifier:
      type: string
      description: Identifier of a bank account in a national context, i.e. for a country.
      example: '619278412000'
    NationalBankIdentifier:
      type: string
      description: >-
        Bank identifier which is unique in a national context, i.e. for a
        country.
      example: '00781'
    BankName:
      description: The name of a bank.
      type: string
      example: Sparda Bank
    BankBranch:
      description: The branch of a bank.
      type: string
      example: Filiale München
    BusinessPartnerStatusOfficialDenotation:
      type: string
      description: The status as provided by an official register.
      example: Good Standing
    BusinessPartnerStatusValidFrom:
      type: string
      description: >-
        Describes since when a business partner turned or will turn into the
        provided status. If no official date is known, the date of changing the
        status in the CDQ Community Data Pool or an external data source is
        provided.
      example: '2025-10-07T05:40:33Z'
    BusinessPartnerStatusValidUntil:
      type: string
      description: >-
        Describes until when a business partner had a certain status. If no
        official date is known, the date of changing the status in the CDQ
        Community Data Pool or an external data source is provided.
      example: '2025-10-07T05:40:33Z'
    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
    ContactEmailValue:
      type: string
      description: Value of the email address of the Business Partner.
      example: developer-portal@cdq.com
    ProvenanceTechnicalKey:
      type: string
      description: Technical Key of the Provenance Name.
      example: VIES
    QualificationRequestIdentifier:
      type: object
      description: Request identifier used for the qualification process.
      properties:
        dataSourceTechnicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        value:
          type: string
          description: Value of the datasource technical key.
          example: WAPIAAAAYhCi7BOK
    QualificationDecisionEnum:
      type: string
      description: Qualification decision enum.
      example: VALID
      enum:
        - VALID
        - INVALID
        - NOT_PROCESSED
        - NO_INPUT_PROVIDED
        - NO_REFERENCE_PROVIDED
        - EXECUTION_ERROR
      x-enumDescriptions:
        VALID: Qualification completed and the result is valid.
        INVALID: Qualification completed and the result is invalid.
        NOT_PROCESSED: >-
          there is no rule for qualifying this particular target, a rule was
          deactivated, or we are not able to process this particular data field.
        NO_INPUT_PROVIDED: >-
          The qualification process could not be started because the input data
          is not complete.
        NO_REFERENCE_PROVIDED: >-
          The qualification process could not be concluded because no reference
          data was obtained.
        EXECUTION_ERROR: Server error prevented qualification from reaching conclusion.
    ProvenanceCdqId:
      type: string
      description: The ID provided for a linkage with the source by CDQ.
      example: VIES:PL8660001429
    BusinessRuleResult:
      type: string
      description: >-
        Contains information, if available, about the data returned from
        execution of business rule.
      example: >-
        parentConceptIdSelector = 'businessPartner.identifiers.technicalKey',
        content = '1633582012931231',
        parentConceptUrl='https://meta.cdq.com/Business_partner/identifier',
        recordId = '451ff2f9-8182-43fc-9728-aad9ce62d771', contentSelector =
        'businessPartner.identifiers.value', contentSelectorUrl =
        'https://meta.cdq.com/Business_partner/identifier/value',
        parentConceptId = 'EE_BRN'
    schemas-ViolationLevel:
      type: string
      description: >
        Indicates the criticality of the applied rule. 

        If a data defect was found then user will get `INFO`, `WARNING` or
        `ERROR` level. Otherwise, it will be NO_DEFECT.
      example: INFO
    schemas-ValidationSource:
      type: string
      description: Name of source used for fetching business rules from.
      example: CDQ
    BusinessPartnerStorageDataSourceId:
      type: string
      description: Unique identifier for a Data Source of the Storage.
      example: 648824a691d8d2503d65103e
    DataSourcePrefix:
      type: string
      description: Identifies external Data Source.
      example: VIES
    ValidationRuleStatus:
      type: string
      description: The status of a validation rule.
      example: RELEASED
    StartAfter:
      type: string
      description: The ID which is used to read the page.
      example: '5712566172571652'
    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'
    PageTotal:
      description: Total number of items which can be paged.
      example: '67'
      type: integer
    ConfigurationName:
      type: string
      description: Display name for a configuration.
      example: Client configuration.
    schemas-ConfigurationId:
      type: string
      description: Uniquely identifies a configuration.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    CreatedAt:
      type: string
      description: Date of creation (ISO 8601-compliant).
      example: '2025-10-07T05:40:33Z'
    ModifiedAt:
      type: string
      description: Date of modification (ISO 8601-compliant).
      example: '2025-10-07T05:40:33Z'
    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
    schemas-ValidationProfile:
      type: string
      description: >-
        A validation profile is a predefined setup of the validation for a
        particular use case.
      example: QUICK
    schemas-ValidationFeature:
      type: string
      description: When enabled will trigger rules of related categories to execute.
      example: BUSINESS_PARTNER_CHECKS
    ValidationRuleCategoryUrl:
      type: string
      description: Used to filter rule by its URL.
      example: https://meta.cdq.com/Qualification
    BusinessPartnerStorageId:
      type: string
      description: Unique identifier of the Storage.
      example: 72d6900fce6b326088f5d9d91049e3e6
    ReportBuildToggle:
      type: boolean
      description: Enable to generate this report.
      example: 'true'
    AddressReportConfiguration:
      type: object
      description: Configures if and how Address reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
    BusinessPartnerReportConfiguration:
      type: object
      description: Configures if and how Business Partner reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
    IdentifierReportConfiguration:
      type: object
      description: Configures if and how Identifier reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
    OverallReportConfiguration:
      type: object
      description: Configures if and how Overall reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
    QualificationReportConfiguration:
      type: object
      description: Configures if and how Qualification reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
    DataValidationJobId:
      type: string
      description: Data Validation Job ID.
      example: ef450653-a3bc-4476-83d3-d67397d475a0
    QualityImprovementReportConfiguration:
      type: object
      description: Configures if and how Quality Improvement reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/ReportBuildToggle'
        dataValidationJobIds:
          type: array
          description: An array which contains Data Validation Job IDs.
          example:
            - 6be92567-4327-4463-813f-a8c990410d79
            - f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb
          items:
            $ref: '#/components/schemas/DataValidationJobId'
    schemas-CountryShortName:
      type: string
      description: Optional parameter to limit on specific country only.
      example: DE
    FinishedAt:
      type: string
      description: Date of finish (ISO 8601-compliant).
      example: '2025-10-07T05:40:33Z'
    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
    PropertyContent:
      type: string
      description: The current content of the property of the provided JSON.
      example: DE12345678
    PropertyContentSelector:
      type: string
      description: JSON path to the property in the provided JSON object.
      example: $.partnerProfile.minorityIndicator.value
    PropertyName:
      type: string
      description: Name of the property.
      example: Minority Indicator Value
    PropertyUrl:
      type: string
      description: External documentation URL for this property.
      example: http://meta.cdq.com/Business_Partner/Identifier_Value
    ConceptName:
      type: string
      description: Display name of the Concept.
      example: Address
    ConceptUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the Business
        Partner [Concepts](https://meta.cdq.com/Business_partner).
      example: https://meta.cdq.com/Business_partner
    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
    LegalFormCategoryShortName:
      type: string
      maxLength: 15
      description: Short display name of the Legal Form Category.
      example: LLC
    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
    LegalFormCategoryTechnicalKey:
      type: string
      description: >-
        Technical Key of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: LIMITED
    IdentifierStatusName:
      type: string
      description: Display label for the Identifier Status Name.
      example: ACTIVE
    IdentifierStatusTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Identifier
        Status](https://meta.cdq.com/Business_partner/identifier/status).
      example: https://meta.cdq.com/Business_partner/identifier/status
    IdentifierStatusTechnicalKey:
      type: string
      description: Technical key of the Identifier Status.
      example: ACTIVE
    IssuingBodyDescription:
      type: string
      description: Description for an Issuing Body.
      example: Amtsgericht Aachen
    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
    AdministrativeAreaIsoCode:
      type: string
      description: >-
        ISO 3166-2 code which uniquely defines the names of countries and their
        subdivisions (e.g., provinces or states).
      example: CH-SG
    IssuingBodyGleifCode:
      type: string
      description: Code of Global Legal Entity Identifier Foundation (GLEIF)
      example: RA000004
    IssuingBodyLocalAuthorityCode:
      type: string
      description: Code of the local registration authority
      example: R3101
    IssuingBodyExternalUrl:
      type: string
      description: External url of the issuing body
      example: https://www.amtsgericht.de/muenchen
    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
    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
    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=
    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.
    OpeningHour:
      type: object
      description: Time range in which the company is open.
      properties:
        openingHour:
          type: string
          description: Company openning hour.
          example: 09:00 AM
        closingHour:
          type: string
          description: Company closing hour.
          example: 05:00 PM
        weekday:
          type: string
          description: A day in the week in which the company is open.
          example: Monday
    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
    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
    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
    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'
    BusinessPartnerRelationStartedAt:
      type: string
      description: Describe when this relationship was first established.
      example: '2025-10-07T05:40:33Z'
    BusinessPartnerRelationEndedAt:
      type: string
      description: Describe when this relationship ended.
      example: '2025-10-07T05:40:33Z'
    BusinessPartnerRelationTypeName:
      type: string
      description: Display name of the Business Partner Relation Type.
      example: Commercial ultimate
    BusinessPartnerRelationTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of a [Business
        Partner Relation
        Type](https://meta.cdq.com/Business_partner/relation/type).
      example: https://meta.cdq.com/Business_partner/relation/type
    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
    BusinessPartnerRelationClassUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of a [Business
        Partner Relation
        Class](https://meta.cdq.com/Business_partner/relation/class).
      example: https://meta.cdq.com/Business_partner/relation/class
    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
    BankAccountCountryCode:
      type: string
      description: ISO code to identify the country a bank account is registered in.
      example: DE
    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
    ExternalContextIdentifierValue:
      type: string
      description: Value of own identifiers of a record.
      example: '7250017031'
    ExternalContextIdentifierTypeTechnicalKey:
      type: string
      description: Technical key for the External Context Identifier Type.
      example: KUNNR
    ExternalContextIdentifierType:
      type: object
      description: Type of own identifiers of a record.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    ReplyQueue:
      type: string
      description: >-
        Technical descriptor of reply queue where workers should put back the
        result.
      example: 647328648329632-34890742-3432
    JobId:
      type: string
      description: Unique identifier of a job.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
    UserId:
      type: string
      description: Unique ID of a user.
      example: johndoe
    LookupJobId:
      type: string
      description: Job Id which was received from the "Start Lookup Job".
      example: cbed7ac6-a97d-4c23-9060-2a88fa660957
    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
    StorageDataSourceId:
      type: string
      description: Unique number of Data Source.
      example: 5e2874fb8d2a7400011acee1
    ProcessingStatusTechnicalKey:
      type: string
      description: Possible technical states of processing.
      example: IN_PROGRESS
    MinorityIndicatorValue:
      type: string
      description: >-
        The actual value of the minority indicator, representing the minority
        group.
      example: Social enterprise
    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
    ClassificationLevel:
      type: string
      description: >-
        Defines the hierarchy of classification codes. E.g. whether the industry
        code is a `primary` or `secondary` `SIC` code.
      example: primary
    ClassificationTypeName:
      type: string
      description: Display label for the Classification Type.
      example: NAF 2003
    ClassificationTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Classification
        Type](https://meta.cdq.com/Business_partner/partner_profile/classification/type)
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/classification/type
    ClassificationTypeTechnicalKey:
      type: string
      description: TechnicalKey for the Classification Type.
      example: NAF 2003
    ClassificationType:
      type: object
      description: >-
        Type of classification such as NACE, SIC, NAF or other industry
        classification standards.
      properties:
        name:
          $ref: '#/components/schemas/ClassificationTypeName'
        url:
          $ref: '#/components/schemas/ClassificationTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ClassificationTypeTechnicalKey'
    PhoneNumberCountryPrefix:
      type: string
      description: The country prefix of a phone number.
      example: '+41'
    PhoneNumberNumber:
      type: string
      description: The complete phone number without any country prefixes.
      example: 71 571 10 40
    PhoneNumberTypeName:
      type: string
      description: Display label for a Phone Number Type Name.
      example: FAX
    PhoneNumberTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Phone
        Number
        Type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      example: https://meta.cdq.com/Business_partner/partner_profile/phone_number/type
    PhoneNumberTypeTechnicalKey:
      type: string
      description: Technical Keys of the PhoneNumber.
      example: FAX
    PhoneNumberType:
      type: object
      description: >-
        The type of a phone number such as mobile phone or fixed line 
        [here](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      properties:
        name:
          $ref: '#/components/schemas/PhoneNumberTypeName'
        url:
          $ref: '#/components/schemas/PhoneNumberTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PhoneNumberTypeTechnicalKey'
    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
    schemas-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'
    CorrelationId:
      type: string
      description: ID which uniquely chains a set of request()s and or task(s).
      example: 123e4567-e89b-12d3-a456-426614174000
    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'
    Worker:
      type: string
      description: Worker which generated the result.
      example: pod-647328648329632-34890742-3432
    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'
  responses:
    400_BadRequest:
      description: The sent request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  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. "johndoe")
          * user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
      in: header
      required: true
      schema:
        type: string
        example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
    validationJobId:
      name: id
      in: path
      description: ID of the validation report.
      required: true
      schema:
        $ref: '#/components/schemas/DataValidationJobId'
    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
    StorageId:
      name: storageId
      description: Unique identifier of the Storage.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/BusinessPartnerStorageId'
    ProcessingLogId:
      name: processingLogId
      in: query
      description: |
        Processing log id with acceptable values:
        * VALIDATION_LOG
        * VALIDATION_SHARING_LOG
        VALIDATION_LOG is default value.
      required: true
      schema:
        $ref: '#/components/schemas/ValidationProcessingLogIdParam'
    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'
