openapi: 3.0.0
info:
  version: '3'
  title: Referencedata API
  description: This API provides services to search and read reference data
servers:
  - description: Production
    url: https://api.cdq.com/referencedata/rest
    x-cdq-soap-url: https://api.corporate-data-league.ch/referencedata/soap/v3
security:
  - apiKey: []
tags:
  - name: Business Partners
    description: Everything about Business Partners
  - name: Addresses
    description: Everything about Addresses
  - name: Analytics
    description: Everything about reference data analytics
  - name: Registrations
    description: Registrations
paths:
  /configurations/businesspartnerfetch:
    get:
      tags:
        - Configurations
      summary: List Fetch Configurations
      description: List all fetch configurations of the current user.
      parameters:
        - in: query
          name: startAfter
          description: >-
            ID of the last configuration returned in the previous request. Used
            for pagination.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - in: query
          name: limit
          description: Maximum number of configurations to return. Used for pagination.
          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
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationPage'
    post:
      tags:
        - Configurations
      summary: Create Fetch Configuration
      description: Create a new fetch configuration for the current user.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerFetchConfigurationCreate'
      responses:
        '200':
          description: Configuration created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerFetchConfiguration'
        '400':
          description: Bad Request.
  /configurations/businesspartnerfetch/{configurationId}:
    get:
      tags:
        - Configurations
      summary: Read Fetch Configuration
      description: Read a fetch configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerFetchConfiguration'
    put:
      tags:
        - Configurations
      summary: Update Fetch Configuration
      description: Update a fetch configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerFetchConfigurationUpdate'
      responses:
        '200':
          description: Configuration updated successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerFetchConfiguration'
        '400':
          description: Bad Request.
    delete:
      tags:
        - Configurations
      summary: Delete Fetch Configuration
      description: Delete a fetch configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerFetchConfiguration'
        '400':
          description: Bad Request.
  /configurations/businesspartnerfetch/{configurationId}/versions/{version}:
    get:
      tags:
        - Configuration
      summary: Read Business Partner Fetch Configuration Version
      description: >-
        Read a specific version of a business partner fetch 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/BusinessPartnerFetchConfigurationVersion'
  /configurations/businesspartnerlookup:
    get:
      tags:
        - Configurations
      summary: List Lookup Configurations
      description: List all lookup 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: Is default workspace configuration of given type.
          schema:
            type: boolean
            example: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfigurationPage'
  /configurations/businesspartnerlookup/{configurationId}:
    get:
      tags:
        - Configurations
      summary: Read Lookup Configuration
      description: Read a lookup configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupConfiguration'
    put:
      tags:
        - Configurations
      summary: Update Lookup Configuration
      description: Update a lookup configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerLookupConfigurationUpdate'
      responses:
        '200':
          description: Configuration updated successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupConfiguration'
        '400':
          description: Bad Request.
    delete:
      tags:
        - Configurations
      summary: Delete Lookup Configuration
      description: Delete a lookup configuration of the current user.
      parameters:
        - $ref: '#/components/parameters/configurationId'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupConfiguration'
        '400':
          description: Bad Request.
  /configurations/businesspartnerlookup/{configurationId}/versions/{version}:
    get:
      tags:
        - Configuration
      summary: Read Business partner Lookup Configuration Version
      description: >-
        Read a specific version of a business partner lookup 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/BusinesPartnerLookupConfigurationVersion'
  /v3/businesspartners/fetch:
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Fetch Business Partner
      description: >-
        Retrieves the Business Partner based on the Lookup and returning the
        result of the single record.
      parameters:
        - $ref: '#/components/parameters/dnbUser'
        - $ref: '#/components/parameters/dnbPassword'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerFetchResult'
              examples:
                fetchEntryById:
                  summary: Fetch business partner by VIES ID
                  value:
                    cdqId: VIES:CZ46981691
                    dataSource: VIES
                    businessPartner:
                      names:
                        - type:
                            url: >-
                              https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                            name: VAT Registered Name
                            technicalKey: VAT_REGISTERED
                          value: TESCOMA s.r.o.
                          language: {}
                      identifiers:
                        - type:
                            url: >-
                              https://meta.cdq.com/European_value_added_tax_identifier_(Czech_Republic)
                            name: Value added tax identification number
                            technicalKey: EU_VAT_ID_CZ
                          value: CZ46981691
                          status:
                            technicalKey: ACTIVE
                      categories: []
                      addresses:
                        - version:
                            characterSet:
                              name: Latin
                              technicalKey: LATIN
                            language:
                              name: en
                              technicalKey: en
                          country:
                            shortName: CZ
                            value: Czechia
                          administrativeAreas: []
                          postCodes:
                            - value: 760 01
                              type:
                                name: Regular
                                url: >-
                                  https://meta.cdq.com/Address/post_code/type/regular
                                technicalKey: REGULAR
                          localities:
                            - value: Zlín
                          thoroughfares:
                            - type:
                                name: Street
                                url: >-
                                  https://meta.cdq.com/Address/thoroughfare/type/street
                                technicalKey: STREET
                              number: '1'
                              value: U Tescomy Lužkovice
                          premises: []
                          postalDeliveryPoints: []
                          types:
                            - name: VAT Registered Address
                              url: >-
                                https://meta.cdq.com/Address/type/vat_registered_address
                              technicalKey: VAT_REGISTERED
                          formattedAddress:
                            country: Czechia
                            locality: Zlín
                            postalCode: 760 01
                            thoroughfare: U Tescomy Lužkovice 1
                      formattedSapRecord:
                        narp: 'NO'
                        stceg: CZ46981691
                        country: Czechia
                        countryCode: CZ
                        city: Zlín
                        postalCode: 760 01
                        street1: U Tescomy Lužkovice
                        houseNum: '1'
                      types: []
                fetchEntryByBVDId:
                  summary: Fetch business partner by BVD ID
                  value:
                    status: OK
                    cdqId: BVD:DE7130197492
                    dataSource: BVD
                    businessPartner:
                      names:
                        - type:
                            url: >-
                              https://meta.cdq.com/Business_partner/name/type/international
                            name: International Name
                            technicalKey: INTERNATIONAL
                          value: CDQ GMBH
                          language: {}
                        - type:
                            url: >-
                              https://meta.cdq.com/Business_partner/name/type/local
                            name: Local Name
                            technicalKey: LOCAL
                          value: CDQ GMBH
                          language: {}
                      legalForm:
                        name: Limited liability company - GmbH
                      identifiers:
                        - type:
                            url: >-
                              https://meta.cdq.com/Bureau_van_Dijk_Identifier_(World)
                            name: Bureau van Dijk Identifier
                            technicalKey: BVD_ID
                          value: DE7130197492
                      categories: []
                      status:
                        type:
                          name: Active
                          url: >-
                            https://meta.cdq.com/Business_partner/status/type/technical_key/active
                          technicalKey: ACTIVE
                      addresses:
                        - version:
                            characterSet:
                              name: Latin
                              technicalKey: LATIN
                            language:
                              name: en
                              technicalKey: en
                          administrativeAreas: []
                          postCodes:
                            - value: '88045'
                              type:
                                name: Regular
                                url: >-
                                  https://meta.cdq.com/Address/post_code/type/regular
                                technicalKey: REGULAR
                          localities:
                            - type:
                                name: City
                                url: >-
                                  https://meta.cdq.com/Address/locality/type/city
                                technicalKey: CITY
                              value: FRIEDRICHSHAFEN
                          thoroughfares:
                            - type:
                                name: Street
                                url: >-
                                  https://meta.cdq.com/Address/thoroughfare/type/street
                                technicalKey: STREET
                              value: ALBRECHTSTR. 8
                          premises: []
                          postalDeliveryPoints: []
                          types: []
                          formattedAddress:
                            locality: FRIEDRICHSHAFEN
                            postalCode: '88045'
                            thoroughfare: ALBRECHTSTR. 8
                      externalId: DE7130197492
                      profile:
                        classifications: []
                        phoneNumbers: []
                        websites:
                          - url: www.cdq.ch
                        contactEmails:
                          - value: info@cdq.ch
                      formattedSapRecord:
                        name1: CDQ GMBH
                        legalEntity: Limited liability company - GmbH
                        legalForm: Limited liability company - GmbH
                        narp: 'NO'
                        city: FRIEDRICHSHAFEN
                        postalCode: '88045'
                        street1: ALBRECHTSTR. 8
                      relations:
                        - type:
                            technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                            name: Global Legal Ultimate Relation
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                            name: BvD Hierarchy
                          startNode: DE7130197492
                          endNode: CHCHE218608886
                        - type:
                            technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                            name: Domestic Legal Ultimate Relation
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                            name: BvD Hierarchy
                          startNode: DE7130197492
                          endNode: DE7130197492
                        - type:
                            technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                            name: Global Legal Ultimate Relation
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                            name: CDQ Hierarchy
                          startNode: DE7130197492
                          endNode: CHCHE218608886
                        - type:
                            technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                            name: Domestic Legal Ultimate Relation
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                            name: CDQ Hierarchy
                          startNode: DE7130197492
                          endNode: DE7130197492
                        - type:
                            technicalKey: COMMERCIAL_ULTIMATE
                            name: Commercial Ultimate
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                            name: BvD Hierarchy
                          startNode: DE7130197492
                          endNode: CHCHE218608886
                        - type:
                            technicalKey: COMMERCIAL_ULTIMATE
                            name: Commercial Ultimate
                          class:
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                            name: CDQ Hierarchy
                          startNode: DE7130197492
                          endNode: CHCHE218608886
                      types: []
                    mappedRecord:
                      attributes:
                        - key: BP_LEGALFORM
                          value: Limited liability company - GmbH
                        - key: ADDR_POSTCODE
                          value: '88045'
                        - key: BP_IDENTIFIER_1
                          value: DE7130197492
                        - key: BP_NAME1
                          value: CDQ GMBH
                        - key: ADDR_STREET1
                          value: ALBRECHTSTR. 8
                        - key: ADDR_CITY1
                          value: FRIEDRICHSHAFEN
                    additionalInformation: []
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerFetchRequest'
            examples:
              fetchEntryByViesId:
                summary: Fetch business partner by VIES ID
                value:
                  cdqId: VIES:CZ46981691
              fetchEntryByBVDId:
                summary: Fetch business partner by BVD ID
                value:
                  cdqId: BVD:DE7130197492
                  outboundMapping: SAP
                  featuresOn:
                    - SHOW_COMMERCIAL_ULTIMATE
                    - ACTIVATE_DATASOURCE_BVD
              fetchBPforCU:
                summary: Fetch Business Partner for Commercial Ultimate
                value:
                  cdqId: DNB:480062239
                  esOn":
                    - ACTIVATE_MASTER_DATA_EXTENDED
                    - SHOW_COMMERCIAL_ULTIMATE
        required: true
  /v3/businesspartners/fetchrelations:
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Fetch Business Partner Relations
      operationId: fetchRelations
      description: >-
        Retrieves the Business Partner Relations based on the Lookup and
        returning the result of the single record.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerRelationFetchResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerRelationFetchRequest'
            examples:
              fetchRelationEntryByCdqId:
                summary: Fetch business partner relations by cdqId
                value:
                  cdqId: LEI:CZ46981691
        required: true
  /v3/businesspartners/fetch-batch:
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Fetch Batch Business Partners
      description: >-
        Retrieves the Business Partners based on the Lookup and returning the
        result of the multiple records.
      parameters:
        - $ref: '#/components/parameters/dnbUser'
        - $ref: '#/components/parameters/dnbPassword'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessPartnerFetchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerFetchBatchRequest'
            examples:
              fetchBatchByCdqIdList:
                summary: Fetch multiple business partners by cdqId
                value:
                  cdqIds:
                    - LEI:529900IM9PTBU50P5M88L
                    - PL.NOBR:5220000080
        required: true
  /v3/businesspartners/lookup:
    get:
      x-wsdl: false
      tags:
        - Business Partners
      summary: Simplified Lookup Business Partners
      description: >
        Perform a comprehensive Business Partner lookup across all accessible 
        Data Sources. This endpoint offers a simplified HTTP GET method for 
        conducting the lookup. However, it only offers a limited set of default 
        features. For the complete range of features, it is recommended to
        utilize  the HTTP POST version.
      parameters:
        - in: query
          name: name
          schema:
            type: string
            example: CDQ
          description: The name of the Business Partner.
        - in: query
          name: country
          schema:
            type: string
            example: CH
          description: The country (ISO code) of the Business Partner address.
        - in: query
          name: locality
          schema:
            type: string
            example: Sankt Gallen
          description: The locality (city) of the Business Partner address.
        - in: query
          name: postCode
          schema:
            type: string
            example: '9000'
          description: The postal code of the Business Partner address.
        - in: query
          name: thoroughfare
          schema:
            type: string
            example: Lukasstrasse 4
          description: >-
            The thoroughfare (street, incl. house number) of the Business
            Partner address.
        - in: query
          name: identifier
          schema:
            type: string
            example: CHCHE218608886
          description: An identifier (the value, number, payload) of the Business Partner.
        - in: query
          name: identifierType
          schema:
            type: string
            example: BVD_ID
          description: The type of given identifier of the Business Partner.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Lookup Business Partners
      description: >
        Perform a Business Partner lookup operation across all available Data
        Sources. 

        The output of this operation will be a comprehensive list of Business
        Partners, 

        each accompanied by their respective Data Sources and meticulously
        calculated 

        matching scores. It is important to note that all accessible data
        sources are 

        comprehensively documented within the [Data_source
        Category](https://meta.cdq.com/Category:Data_source) on CDQ Wiki. 


        The Data Sources are categorized as follows:
          * OPEN: These Data Sources are open to everyone without any registration requirement.
          * FREE: These Data Sources are free to use, but registration is required.
          * COMMERCIAL: These Data Sources are only available to commercial users.

        The results of the Business Partner lookup operation are sorted in
        descending 

        order based on their matching scores. Additionally, the results are
        conveniently 

        paginated, allowing for efficient navigation through the extensive list.
        The page 

        size can be effortlessly customized to accommodate specific preferences.
      parameters:
        - $ref: '#/components/parameters/dnbUser'
        - $ref: '#/components/parameters/dnbPassword'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupResult'
              examples:
                lookupFromVIES:
                  summary: >-
                    Lookup Business Partner by identifier from public Data
                    Source (VIES & NOBR)
                  value:
                    pageSize: 10
                    totals: 2
                    page: 0
                    limit: 10
                    startAfter: RVtH+Q==
                    nextStartAfter: RVtH8w==
                    values:
                      - cdqId: VIES:PL9280012700
                        dataSource: VIES
                        matchingProfile:
                          matchingScores:
                            overall:
                              classification:
                                technicalKey: MAYBE_MATCH
                                name: Maybe Match
                              value: 0.9
                              explanation: >-
                                BP: [overall: [EU_VAT_ID_PL: 0.9; overall:
                                0.9;]] A: []
                            businessPartner:
                              classification:
                                technicalKey: FULL_MATCH
                                name: Full Match
                              value: 0.9
                            address:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.5
                        businessPartner:
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/vat_registered_name
                                name: VAT Registered Name
                                technicalKey: VAT_REGISTERED
                              value: >-
                                SWISS KRONO SPÓŁKA Z OGRANICZONĄ
                                ODPOWIEDZIALNOŚCIĄ
                          legalForm:
                            name: Spółka z ograniczoną odpowiedzialnością
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/PL_2712
                            mainAbbreviation: Sp. z o.o.
                            technicalKey: PL_2712
                          identifiers:
                            - type:
                                url: >-
                                  https://meta.cdq.com/European_value_added_tax_identifier_(Poland)
                                name: Value added tax identification number
                                technicalKey: EU_VAT_ID_PL
                              value: PL9280012700
                              status:
                                technicalKey: ACTIVE
                          categories: []
                          addresses:
                            - country:
                                shortName: PL
                                value: Poland
                              administrativeAreas: []
                              postCodes:
                                - value: 68-200
                                  type:
                                    name: Regular
                                    url: >-
                                      https://meta.cdq.com/Address/post_code/type/regular
                                    technicalKey: REGULAR
                              localities:
                                - value: Żary
                              thoroughfares:
                                - shortName: Serbska
                                  number: '56'
                                  value: Serbska
                              premises: []
                              types:
                                - name: VAT Registered Address
                                  url: >-
                                    https://meta.cdq.com/Address/type/vat_registered_address
                                  technicalKey: VAT_REGISTERED
                          externalId: PL9280012700
                          types: []
                      - cdqId: PL.NOBR:9280012700
                        dataSource: PL.NOBR
                        matchingProfile:
                          matchingScores:
                            overall:
                              classification:
                                technicalKey: MAYBE_MATCH
                                name: Maybe Match
                              value: 0.89
                              explanation: >-
                                BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A:
                                []
                            businessPartner:
                              classification:
                                technicalKey: FULL_MATCH
                                name: Full Match
                              value: 0.89
                            address:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.5
                        businessPartner:
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/local
                                name: Local Name
                                technicalKey: LOCAL
                              value: >-
                                SWISS KRONO SPÓŁKA Z OGRANICZONĄ
                                ODPOWIEDZIALNOŚCIĄ
                          legalForm:
                            name: Spółka z ograniczoną odpowiedzialnością
                            url: >-
                              https://meta.cdq.com/Business_partner/legal_form/technical_key/PL_2712
                            mainAbbreviation: Sp. z o.o.
                            technicalKey: PL_2712
                          identifiers:
                            - type:
                                url: https://meta.cdq.com/REGON_(Poland)
                                name: Rejestr Gospodarki Narodowej
                                technicalKey: PL_REG
                              value: '970327738'
                            - type:
                                url: https://meta.cdq.com/NIP_number_(Poland)
                                name: Numer Identyfikacji Podatkowej
                                technicalKey: PL_NIP
                              value: '9280012700'
                          categories:
                            - name: Company
                              url: >-
                                https://meta.cdq.com/Business_partner/category/company
                              technicalKey: COMPANY
                          addresses:
                            - country:
                                shortName: PL
                                value: Poland
                              administrativeAreas:
                                - value: LUBUSKIE
                                - value: żarski
                                - value: Żary
                              postCodes:
                                - value: 68-200
                                  type:
                                    name: Regular
                                    url: >-
                                      https://meta.cdq.com/Address/post_code/type/regular
                                    technicalKey: REGULAR
                              localities:
                                - value: Żary
                              thoroughfares:
                                - shortName: ul. Serbska
                                  number: '56'
                                  value: ul. Serbska
                              premises: []
                              types:
                                - name: Registered Address
                                  url: >-
                                    https://meta.cdq.com/Address/type/registered_address
                                  technicalKey: REGISTERED
                          externalId: '9280012700'
                          types: []
                lookupFromDVB:
                  summary: Lookup Business Partner from Premium Data Source BVD
                  value:
                    pageSize: 10
                    totals: 2
                    page: 0
                    limit: 10
                    startAfter: RVtH+Q==
                    nextStartAfter: RVtH8w==
                    values:
                      - cdqId: BVD:CHCHE218608886
                        dataSource: BVD
                        matchingProfile:
                          matchingScores:
                            overall:
                              classification:
                                technicalKey: MAYBE_MATCH
                                name: Maybe Match
                              value: 0.95
                              explanation: >-
                                BP: [overall: [NAME: 0.95; overall: 0.95;]] A:
                                []
                            businessPartner:
                              classification:
                                technicalKey: FULL_MATCH
                                name: Full Match
                              value: 0.95
                            address:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.5
                        businessPartner:
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/international
                                name: International Name
                                technicalKey: INTERNATIONAL
                              value: CDQ AG
                              language: {}
                          legalForm:
                            name: Limited company - AG/SA
                          identifiers:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Bureau_van_Dijk_Identifier_(World)
                                name: Bureau van Dijk Identifier
                                technicalKey: BVD_ID
                              value: CHCHE218608886
                          categories: []
                          status:
                            type:
                              name: Active
                              url: >-
                                https://meta.cdq.com/Business_partner/status/type/technical_key/active
                              technicalKey: ACTIVE
                          addresses:
                            - version:
                                characterSet:
                                  name: Latin
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: CH
                                value: Switzerland
                              administrativeAreas:
                                - value: St. Gallen
                                  type:
                                    name: Region
                                    url: >-
                                      https://meta.cdq.com/Address/administrative_area/type/region
                                    technicalKey: REGION
                              postCodes:
                                - value: '9008'
                                  type:
                                    name: Regular
                                    url: >-
                                      https://meta.cdq.com/Address/post_code/type/regular
                                    technicalKey: REGULAR
                              localities:
                                - type:
                                    name: City
                                    url: >-
                                      https://meta.cdq.com/Address/locality/type/city
                                    technicalKey: CITY
                                  value: ST. GALLEN
                              thoroughfares:
                                - type:
                                    name: Street
                                    url: >-
                                      https://meta.cdq.com/Address/thoroughfare/type/street
                                    technicalKey: STREET
                                  shortName: LUKASSTRASSE 4
                                  value: LUKASSTRASSE 4
                              premises: []
                              postalDeliveryPoints: []
                              types:
                                - name: Registered Address
                                  url: >-
                                    https://meta.cdq.com/Address/type/registered_address
                                  technicalKey: REGISTERED
                          externalId: CHCHE218608886
                          profile:
                            classifications: []
                            phoneNumbers: []
                            websites:
                              - url: www.cdq.ch
                            contactEmails: []
                          relations:
                            - type:
                                technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                                name: Global Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                                name: Domestic Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                                name: Global Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                            - type:
                                technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                                name: Domestic Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                            - type:
                                technicalKey: COMMERCIAL_ULTIMATE
                                name: Commercial Ultimate
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: COMMERCIAL_ULTIMATE
                                name: Commercial Ultimate
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                          types: []
                        additionalInformation:
                          - key: customRule
                          - key: hint
                            value: Selected
                          - key: score
                            value: '1.0'
                        mappedRecord:
                          attributes:
                            - key: BP_LEGALFORM
                              value: Limited company - AG/SA
                            - key: ADDR_POSTCODE
                              value: '9008'
                            - key: BP_IDENTIFIER_1
                              value: CHCHE218608886
                            - key: BP_NAME1
                              value: CDQ AG
                            - key: ADDR_STREET1
                              value: LUKASSTRASSE 4
                            - key: ADDR_CITY1
                              value: ST. GALLEN
                            - key: ADDR_REGION
                              value: St. Gallen
                            - key: ADDR_COUNTRY_CODE
                              value: CH
                      - cdqId: BVD:CHCHE229623973
                        dataSource: BVD
                        matchingProfile:
                          matchingScores:
                            overall:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.2
                              explanation: 'BP: [overall: [NAME: 0.2; overall: 0.2;]] A: []'
                            businessPartner:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.2
                            address:
                              classification:
                                technicalKey: NO_MATCH
                                name: No Match
                              value: 0.5
                        businessPartner:
                          names:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/international
                                name: International Name
                                technicalKey: INTERNATIONAL
                              value: ARIST SARL
                              language: {}
                            - type:
                                url: >-
                                  https://meta.cdq.com/Business_partner/name/type/local
                                name: Local Name
                                technicalKey: LOCAL
                              value: ARIST SARL
                              language: {}
                          legalForm:
                            name: Limited liability company - GmbH/SARL
                          identifiers:
                            - type:
                                url: >-
                                  https://meta.cdq.com/Bureau_van_Dijk_Identifier_(World)
                                name: Bureau van Dijk Identifier
                                technicalKey: BVD_ID
                              value: CHCHE229623973
                          categories: []
                          status:
                            type:
                              name: Active
                              url: >-
                                https://meta.cdq.com/Business_partner/status/type/technical_key/active
                              technicalKey: ACTIVE
                          addresses:
                            - version:
                                characterSet:
                                  name: Latin
                                  technicalKey: LATIN
                                language:
                                  name: en
                                  technicalKey: en
                              country:
                                shortName: CH
                                value: Switzerland
                              administrativeAreas:
                                - value: Vaud
                                  type:
                                    name: Region
                                    url: >-
                                      https://meta.cdq.com/Address/administrative_area/type/region
                                    technicalKey: REGION
                              postCodes:
                                - value: '1315'
                                  type:
                                    name: Regular
                                    url: >-
                                      https://meta.cdq.com/Address/post_code/type/regular
                                    technicalKey: REGULAR
                              localities:
                                - type:
                                    name: City
                                    url: >-
                                      https://meta.cdq.com/Address/locality/type/city
                                    technicalKey: CITY
                                  value: LA SARRAZ
                              thoroughfares:
                                - type:
                                    name: Street
                                    url: >-
                                      https://meta.cdq.com/Address/thoroughfare/type/street
                                    technicalKey: STREET
                                  shortName: RUE du CHENE 42-44, BOX 27
                                  value: RUE du CHENE 42-44, BOX 27
                              premises: []
                              postalDeliveryPoints: []
                              types:
                                - name: Registered Address
                                  url: >-
                                    https://meta.cdq.com/Address/type/registered_address
                                  technicalKey: REGISTERED
                          externalId: CHCHE229623973
                          profile:
                            classifications: []
                            phoneNumbers: []
                            websites:
                              - url: www.cdq.ch
                            contactEmails: []
                          relations:
                            - type:
                                technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                                name: Global Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                                name: Domestic Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: GLOBAL_LEGAL_ULTIMATE_RELATION
                                name: Global Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                            - type:
                                technicalKey: DOMESTIC_LEGAL_ULTIMATE_RELATION
                                name: Domestic Legal Ultimate Relation
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                            - type:
                                technicalKey: COMMERCIAL_ULTIMATE
                                name: Commercial Ultimate
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_BVD_HIERARCHY
                                name: BvD Hierarchy
                            - type:
                                technicalKey: COMMERCIAL_ULTIMATE
                                name: Commercial Ultimate
                              class:
                                technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                                name: CDQ Hierarchy
                          types: []
                        additionalInformation:
                          - key: customRule
                          - key: hint
                            value: Unlikely
                          - key: score
                            value: '0.08'
                        mappedRecord:
                          attributes:
                            - key: BP_LEGALFORM
                              value: Limited liability company - GmbH/SARL
                            - key: ADDR_POSTCODE
                              value: '1315'
                            - key: BP_IDENTIFIER_1
                              value: CHCHE229623973
                            - key: BP_NAME1
                              value: ARIST SARL
                            - key: ADDR_STREET1
                              value: RUE du CHENE 42-44, BOX 27
                            - key: ADDR_CITY1
                              value: LA SARRAZ
                            - key: ADDR_REGION
                              value: Vaud
                            - key: ADDR_COUNTRY_CODE
                              value: CH
                    debugInfo:
                      features:
                        - feature: MATCHING_SCORE_CALCULATION
                          active: true
                        - feature: ACTIVATE_IDENTIFIER_ONLY_MATCH
                          active: false
                        - feature: FORCE_EXTERNAL_CALL
                          active: true
                        - feature: ACTIVATE_DATASOURCE_GOOGLEPLACES
                          active: false
                        - feature: ACTIVATE_DATASOURCE_STORAGES
                          active: false
                        - feature: ACTIVATE_DATASOURCE_ZEFIX
                          active: false
                        - feature: ACTIVATE_DATASOURCE_NLBR
                          active: false
                        - feature: ACTIVATE_DATASOURCE_CDQ_POOL
                          active: false
                        - feature: ACTIVATE_DATASOURCE_DNB
                          active: false
                        - feature: ACTIVATE_DATASOURCE_BZST
                          active: false
                        - feature: ACTIVATE_DATASOURCE_VIES_FOR_ES
                          active: true
                        - feature: ACTIVATE_DATASOURCE_BVD
                          active: true
                        - feature: ENABLE_IDENTIFIER_DERIVATION
                          active: true
                        - feature: FORCE_EXTERNAL_CALL
                          active: false
                        - feature: SHOW_GOLDENRECORD_STANDARD
                          active: false
                        - feature: SHOW_GOLDENRECORD_QUICK
                          active: false
                        - feature: SHOW_DEBUG_INFO
                          active: true
                        - feature: SHOW_FORMATTED_ADDRESS
                          active: false
                        - feature: SHOW_FORMATTED_SAP_RECORD
                          active: false
                        - feature: SHOW_SUBSCRIPTION_METADATA
                          active: false
                        - feature: SHOW_INCOMPLETE_CANDIDATES
                          active: false
                        - feature: SHOW_REGISTERED_INDIVIDUAL
                          active: true
                        - feature: LAB_ALLOW_BIG_CANDIDATES
                          active: false
                        - feature: LAB_ALLOW_LONG_EXTERNAL_CALLS
                          active: false
                        - feature: LAB_PREFIX_QUERY
                          active: true
                      request:
                        dataSources:
                          - BVD
                        matchingThreshold: 0
                        maxCandidates: 50
                        pageSize: 10
                        page: 0
                        featuresOn:
                          - MATCHING_SCORE_CALCULATION
                          - ENABLE_IDENTIFIER_DERIVATION
                          - LAB_PREFIX_QUERY
                          - SHOW_REGISTERED_INDIVIDUAL
                          - ACTIVATE_DATASOURCE_VIES_FOR_ES
                          - ACTIVATE_DATASOURCE_BVD
                          - SHOW_DEBUG_INFO
                        featuresOff: []
                        outboundMapping: SAP
                      externalServiceResponses:
                        - timestamp: '2022-03-29T05:05:14.183541181Z'
                          httpStatus: 200
                          status: OK
                          source: BVD
                          additionalInformations:
                            - key: rawJson
                              value: >-
                                [{"hint":"Selected","score":1.0,"name":"CDQ
                                AG","matchedName":"CDQ
                                AG","matchedNameType":"CurrentInternational","address":"LUKASSTRASSE
                                4","postcode":"9008","city":"ST.
                                GALLEN","country":"CH","addressType":"Priority
                                address: Registered address / Incorporation
                                address / Legal address, Post(al)
                                address","emailOrWebsite":"www.cdq.ch","nationalId":"CH-320.3.076.934-1","nationalIdLabel":"CH-number","region":"St.
                                Gallen","legalForm":"Limited company -
                                AG/SA","consolidationCode":"LF","status":"Active","bvDId":"CHCHE218608886"},{"hint":"Unlikely","score":0.08,"name":"ARIST
                                SARL","nameLocal":"ARIST
                                SARL","matchedName":"ARIST LTD LIAB.
                                CO","matchedNameType":"Alias","address":"RUE du
                                CHENE 42-44, BOX
                                27","postcode":"1315","city":"LA
                                SARRAZ","country":"CH","addressType":"Priority
                                address: Registered address / Incorporation
                                address / Legal address, Post(al)
                                address","emailOrWebsite":"www.cdq.ch","nationalId":"CH-550.1.170.010-0","nationalIdLabel":"CH-number","region":"Vaud","legalForm":"Limited
                                liability company -
                                GmbH/SARL","consolidationCode":"LF","status":"Active","bvDId":"CHCHE229623973"}]
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerLookupRequest'
            examples:
              lookupRequestBody:
                summary: Body to be filled with data
                value:
                  matchingThreshold: 0
                  pageSize: 10
                  page: 0
                  dataSources:
                    - string
                  businessPartner:
                    names:
                      - value: string
                    identifiers:
                      - value: string
                        type:
                          technicalKey: string
                    legalForm:
                      value: string
                    addresses:
                      - thoroughfares:
                          - value: string
                            number: string
                        localities:
                          - value: string
                        administrativeAreas:
                          - value: string
                        postCodes:
                          - value: string
                        country:
                          shortName: string
              lookupByEuVatIdPl:
                summary: >-
                  Lookup Business Partner by identifier from public Data Source
                  (VIES & NOBR)
                value:
                  businessPartner:
                    addresses:
                      - country:
                          shortName: PL
                    identifiers:
                      - value: PL9280012700
                        type:
                          technicalKey: EU_VAT_ID_PL
              lookupFromDVB:
                summary: Lookup Business Partner from Premium Data Source BVD
                value:
                  businessPartner:
                    addresses:
                      - country:
                          shortName: CH
                    names:
                      - value: CDQ AG
                  featuresOn:
                    - ACTIVATE_DATASOURCE_BVD
                  outboundMapping: SAP
                  dataSources:
                    - BVD
              lookupFromDNB:
                summary: Lookup Business Partner from DNB
                value:
                  dataSources:
                    - DNB
                  businessPartner:
                    names:
                      - value: CDQ POLAND SP Z O O
                    addresses:
                      - thoroughfares:
                          - value: street
                            number: ''
                        localities:
                          - value: ''
                        country:
                          shortName: PL
                  featuresOn:
                    - ACTIVATE_DATASOURCE_DNB
        description: cmd
        required: true
  /v3/businesspartners/search:
    post:
      tags:
        - Business Partners
      summary: Search Business Partners
      description: >
        Use for single queries to quickly find a Business Partner.

        User have to verify the results.

        To be used when Business Partner is not normalized e.g. Company Name and
        Address are in one line.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerSearchRequest'
            examples:
              searchCdq:
                summary: Search business partner by multiple fields in one query string
                value:
                  query: CDQ, 50-078 Wrocław
        description: cmd
        required: true
  /v3/businesspartners/goldenrecord:
    post:
      tags:
        - Business Partners
      summary: Generate Golden Record
      description: >-
        Create a Business Partner's golden record by computing the matching
        score using data completeness. The golden record generated has the
        highest matching score.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersGoldenRecordRequest'
        description: cmd
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoldenRecord'
        '400':
          description: Bad Request
  /v3/overlaplogs/{storageId}/results:
    get:
      x-wsdl: false
      tags:
        - Processing Logs
      summary: List Processing Log Results
      description: >
        Retrieves latest overlap results persisted in Processing Log.


        Data is populated only when [Data
        Monitor](https://developer.cdq.com/reference-docs/data-exchange/V4/tag/Business-Partner-Storages/#tag/Business-Partner-Storages/paths/~1v2~1storages~1{storageId}~1datamonitors/post)
        is configured for provided storage.
      parameters:
        - name: storageId
          in: path
          description: Business Partner Storage ID.
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageId'
        - name: businessPartnerId
          in: query
          description: Business Partner IDs.
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: dataSourceId
          in: query
          description: Business Partner Data Source ID.
          required: false
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: externalId
          in: query
          description: Business Partner External IDs.
          required: false
          schema:
            type: array
            description: List of Business Partner External IDs.
            maxItems: 500
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: startAfter
          in: query
          description: Used to retrieve the next page of results.
          required: false
          schema:
            $ref: '#/components/schemas/StartAfter'
        - name: limit
          in: query
          description: >-
            Number of results that should be fetched. Maximum 100 results can be
            returned in one page.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            format: int32
            default: 100
            example: '50'
        - name: from
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result since when
            data was created.
          required: false
          schema:
            type: string
            example: '2025-10-07T05:40:40Z'
        - name: to
          in: query
          description: >-
            ISO 8601 representation of the timestamp when the result until when
            data was created.
          required: false
          schema:
            type: string
            example: '2025-10-07T05:40:40Z'
        - name: featuresOn
          in: query
          description: Features to be activated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProcessingLogResultsReadFeatureEnum'
        - name: featuresOff
          in: query
          description: Features to be deactivated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProcessingLogResultsReadFeatureEnum'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverlapProcessingLogResultPage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /sgw/businesspartners:
    post:
      tags:
        - Business Partners
      summary: Create Supplier Gateway Record
      description: >-
        Creates a new Supplier Gateway record by providing the necessary
        information and returns the created record.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierGatewayCreate'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierGateway'
            application/xml:
              schema:
                $ref: '#/components/schemas/SupplierGateway'
  /sgw/businesspartners/fetch:
    post:
      tags:
        - Business Partners
      summary: Fetch Supplier Gateway Record
      description: >-
        Fetches a Supplier Gateway record by providing the necessary information
        and returns the fetched record.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierGatewayFetchRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierGatewayFetchResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/SupplierGatewayFetchResult'
  /dnb/businesspartners/fetch:
    post:
      x-wsdl: true
      deprecated: true
      tags:
        - Business Partners
      summary: Fetch DNB Record
      description: >
        Fetch D&B record by CDQ-ID. It is possible to read:

        - legacy CMPELK data

        - Data Blocks defined
        [here](https://directplus.documentation.dnb.com/DataBlocks.html)


        # Fetch CMPELK


        To fetch the CMPELK object no features have to be activated.

        ```

        POST /dnb/businesspartners/fetch

        {
          "cdqId": "DNB:123456789"
        }

        ```

        # Fetch Data Blocks

        It is possible to read pre-defined Data Blocks


        ## Fetch pre-defined Data Blocks

        There are 2 features with pre-defined data blocks:

        - ACTIVATE_MASTER_DATA_BASIC uses following data blocks:
          * COMPANYINFO_L1_V1
        - ACTIVATE_MASTER_DATA_EXTENDED uses following data blocks:
          * COMPANYINFO_L1_V1
          * COMPANYINFO_L2_V1
          * HIERARCHYCONNECTIONS_L1_V1
          * PRINCIPALSCONTACTS_L2_V2
        ```

        POST /dnb/businesspartners/fetch

        {
          "cdqId": "DNB:123456789",
          "featuresOn": [
            "ACTIVATE_MASTER_DATA_BASIC"
          ]
        }

        ```

        # Fetch LNKELI

        It is possible to fetch LNKELI data:

        ```

        POST /dnb/businesspartners/fetch

        {
          "cdqId": "DNB:123456789",
          "featuresOn": [
            "ACTIVATE_LINKAGE_LNKELI"
          ]
        }

        ```
      parameters:
        - name: X-DNB-USER
          description: Dnb Consumer Key.
          in: header
          required: false
          schema:
            type: string
            example: dnb_consumer_key
        - name: X-DNB-PASSWORD
          description: Dnb Consumer Secret.
          in: header
          required: false
          schema:
            type: string
            example: dnb_consumer_key
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbFetchResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/DnbFetchResult'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnbFetchRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/DnbFetchRequest'
        required: true
  /dnb/lookupjobs/{id}/results:
    get:
      x-wsdl: true
      tags:
        - Batch Lookup
      summary: Read DNB Lookup Job results
      description: Reads the results of a DNB lookup job by job ID.
      parameters:
        - $ref: '#/components/parameters/lookupJobId'
        - $ref: '#/components/parameters/businessPartnerId'
        - $ref: '#/components/parameters/startAfter'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbLookupJobResultPage'
        '404':
          description: Not Found
  /dnb/lookupjobs:
    post:
      x-wsdl: true
      tags:
        - Batch Lookup
      summary: Start DNB Lookup Job
      description: >-
        Initialisation of a DNB lookup job. The job will be executed
        asynchronously. The response contains the job ID which can be used to
        poll for the status of the job.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbLookupJob'
        '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/DnbLookupJobRequest'
        description: cmd
        required: true
  /dnb/lookupjobs/{id}:
    get:
      x-wsdl: true
      tags:
        - Batch Lookup
      summary: Poll DNB Lookup Job
      description: >
        After you have started a curation job, you will receive a job id in the
        response: `{ 'id' : '' }`

        Use this ID to poll for the status of the job using this endpoint. Once
        the status is FINISHED, you can download the results.
      parameters:
        - name: id
          description: ID of the DNB lookup job.
          in: path
          required: true
          schema:
            type: string
            example: cbed7ac6-a97d-4c23-9060-2a88fa660957
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbLookupJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  parameters:
    dnbUser:
      name: X-DNB-USER
      description: Credentials are now stored in Data Source Settings in Cloud Apps.
      in: header
      required: false
      schema:
        type: string
        example: dnb_consumer_key
      deprecated: true
    dnbPassword:
      name: X-DNB-PASSWORD
      description: Credentials are now stored in Data Source Settings in Cloud Apps.
      in: header
      required: false
      schema:
        type: string
        example: dnb_consumer_secret
      deprecated: true
    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
    usernameHeaderParam:
      name: X-Credential-Username
      description: >
        Username that is passed as header parameter with the name
        X-Credential-Username.

        The header can take form of:
          * username (e.g. "lukaszmichta")
          * user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
      in: header
      required: true
      schema:
        type: string
        example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
    page:
      name: page
      description: Current page number.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/Page'
    limitParam:
      name: limit
      description: Limits the number of returned results.
      in: query
      required: false
      schema:
        type: integer
        minimum: 10
        default: 10
        multipleOf: 10
        format: int32
        example: '20'
    businessPartnerId:
      name: businessPartnerId
      description: Business Partner IDs which should be filtered.
      in: query
      required: false
      schema:
        type: array
        description: List of Business Partner IDs.
        items:
          $ref: '#/components/schemas/BusinessPartnerId'
    startAfter:
      name: startAfter
      description: Only records with an ID greater than this ID will be fetched.
      in: query
      required: false
      schema:
        type: string
        default: '0'
        example: '5712566172571652'
    limit:
      name: limit
      description: >-
        Number of results that should be fetched. Maximum 100 results can be
        returned in one page.
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        format: int32
        default: 100
        example: '50'
    lookupJobId:
      name: id
      description: ID of the lookup job.
      in: path
      required: true
      schema:
        type: string
        example: cbed7ac6-a97d-4c23-9060-2a88fa660957
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
  schemas:
    BusinessPartnersGoldenRecordRequest:
      type: object
      description: Parameters for generating a Business Partner golden record.
      properties:
        cdqId:
          type: string
          description: CDQ ID of the Golden Record.
          example: VIES:PL1132639219
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerGoldenRecordFeatureEnum'
        configurationId:
          $ref: '#/components/schemas/ConfigurationId'
    BusinessPartnerGoldenRecordFeatureEnum:
      type: string
      description: Feature used to control generation of golden record.
      example: SHOW_FORMATTED_SAP_RECORD
      enum:
        - SHOW_FORMATTED_SAP_RECORD
      x-enumDescriptions:
        SHOW_FORMATTED_SAP_RECORD: Show formatted sap records in the golden record response.
    BusinessPartnerRelationFetchResult:
      type: object
      description: Result of a Business Partner relation fetch.
      properties:
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Business Partner relations.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
    BusinessPartnerRelation:
      type: object
      description: Business Partner relation with other entities.
      allOf:
        - $ref: '#/components/schemas/schemas-BusinessPartnerRelation'
        - type: object
          description: Business Partner relation with other entities.
          properties:
            startNodeBusinessPartner:
              $ref: '#/components/schemas/RelationBusinessPartner'
            endNodeBusinessPartner:
              $ref: '#/components/schemas/RelationBusinessPartner'
    RelationBusinessPartner:
      type: object
      description: Relation of the Business Partner.
      properties:
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/Name'
        addresses:
          type: array
          description: List of addresses.
          items:
            $ref: '#/components/schemas/RelationBusinessPartnerAddress'
    RelationBusinessPartnerAddress:
      type: object
      description: Address of the related Business Partner.
      properties:
        country:
          $ref: '#/components/schemas/Country'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
    BusinessPartnerRelationFetchRequest:
      type: object
      description: Parameters for fetching Business Partner relations.
      properties:
        cdqId:
          type: string
          description: CDQ ID for Business Partner and address.
          example: VIES:DE123456789
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        endedAfter:
          type: string
          description: Find relations which endedAt is after given date.
          example: '2025-10-07T05:40:40Z'
        endedBefore:
          type: string
          description: Find relations which endedAt is before given date.
          example: '2025-10-07T05:40:40Z'
        startedAfter:
          type: string
          description: Find relations which startedAt is after given date.
          example: '2025-10-07T05:40:40Z'
        startedBefore:
          type: string
          description: Find relations which startedAt is before given date.
          example: '2025-10-07T05:40:40Z'
        classTechnicalKey:
          type: string
          description: Filter by class technical key.
          example: BUSINESS_PARTNER_RELATION_CLASS_LEI_HIERARCHY
        typeTechnicalKey:
          type: string
          description: Filter by type.
          example: LEI_DIRECT_PARENT
    BusinessPartnerFetchRequest:
      type: object
      description: Request for fetching Business Partner.
      required:
        - cdqId
      properties:
        cdqId:
          type: string
          description: CDQ ID for Business Partner and address.
          example: VIES:DE123456789
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
        outboundMapping:
          $ref: '#/components/schemas/OutboundMapping'
        screeningMatchingThreshold:
          type: number
          description: >-
            The matching threshold for compliance screening. If set and a fetch
            result is not above threshold, it will not be returned.
          example: '0.5'
        configurationId:
          $ref: '#/components/schemas/ReferenceDataFetchConfigurationId'
    BusinessPartnerFetchBatchRequest:
      type: object
      description: Request for fetching batch of Business Partner.
      properties:
        cdqIds:
          type: array
          description: List of CDQ IDs for Business Partner and address.
          items:
            type: string
            description: CDQ ID of the Business Partner.
            example: VIES:DE123456789
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
    BusinessPartnerFetchFeatures:
      type: string
      description: Feature to be used during Business Partner fetch.
      example: ENABLE_SETTINGS
      x-cdq-beta:
        - SHOW_DOMESTIC_COMMERCIAL_ULTIMATE
        - DETECT_LEGAL_ENTITY
      enum:
        - ENABLE_SETTINGS
        - SHOW_DEBUG_INFO
        - SHOW_RAW_DATA
        - SHOW_RAW_DATA_JSON
        - FORCE_EXTERNAL_CALL
        - SCREEN_BUSINESS_NAMES
        - SHOW_COMMERCIAL_ULTIMATE
        - SHOW_DOMESTIC_COMMERCIAL_ULTIMATE
        - DETECT_LEGAL_ENTITY
        - ACTIVATE_DATASOURCE_BVD
        - ACTIVATE_DATASOURCE_DNB
        - ACTIVATE_DATASOURCE_DNB_STORAGE
        - ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY
        - ACTIVATE_MASTER_DATA_BASIC
        - ACTIVATE_MASTER_DATA_EXTENDED
        - ACTIVATE_MASTER_DATA_MGMT
        - ACTIVATE_MASTER_DATA_LNKG
        - ACTIVATE_LINKAGE_LNKELI
        - ACTIVATE_MASTER_DATA_BASIC_BVD
        - ACTIVATE_MASTER_DATA_EXTENDED_BVD
        - ACTIVATE_FINANCIAL_RISK_DATA_BVD
        - ACTIVATE_OWNERSHIP_DATA_BVD
      title: BusinessPartnerFetchFeaturesDesc
      x-enumDescriptions:
        ENABLE_SETTINGS: Apply rules stored in organizational settings during curation.
        SHOW_DEBUG_INFO: >-
          Show additional information regarding request processing, including
          enabled features, request, request after curation procedure and
          responses from external services.
        SHOW_RAW_DATA: Show raw data returned by external service.
        SHOW_RAW_DATA_JSON: Show raw data returned by external service in JSON format.
        FORCE_EXTERNAL_CALL: >-
          Call external service even when results from data mirrors are
          available.
        SCREEN_BUSINESS_NAMES: Add `screeningResult` to the Business Partner.
        SHOW_COMMERCIAL_ULTIMATE: >-
          Fetch Global Commercial Ultimate from BvD or DNB (depending on
          selected datasource). `ACTIVATE_DATASOURCE_DNB`,
          `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be
          active if you want to calculate DNB commercial ultimate.
        SHOW_DOMESTIC_COMMERCIAL_ULTIMATE: >-
          <b style="color: white; background: #077fbb; border-radius: 5px;
          margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
          super;">BETA</b><br>Fetch Domestic Commercial Ultimate from DNB.
          `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or
          `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate
          DNB commercial ultimate.
        DETECT_LEGAL_ENTITY: >-
          <b style="color: white; background: #077fbb; border-radius: 5px;
          margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align:
          super;">BETA</b><br>Finds out whether requested DUNS is a branch or
          headquarter.
        ACTIVATE_DATASOURCE_BVD: Allows to use DVB datasource in golden record.
        ACTIVATE_DATASOURCE_DNB: Allows to use DNB datasource in golden record.
        ACTIVATE_DATASOURCE_DNB_STORAGE: >-
          Checks storage and skips call to D&B if results were found. By default
          turned on.
        ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY: Skips call to D&B entirely and only checks storage for results.
        ACTIVATE_MASTER_DATA_BASIC: Use DNB Master Data Basic to fetch record.
        ACTIVATE_MASTER_DATA_EXTENDED: Use DNB Master Data Extended to fetch record.
        ACTIVATE_MASTER_DATA_MGMT: Use DNB Master Data Lnkg to fetch record.
        ACTIVATE_MASTER_DATA_LNKG: Use DNB Master Data Mgmt to fetch record.
        ACTIVATE_LINKAGE_LNKELI: Fetch LNKELI data.
        ACTIVATE_MASTER_DATA_BASIC_BVD: Returns Master Data Basic from BvD
        ACTIVATE_MASTER_DATA_EXTENDED_BVD: Returns Master Data Extended from BvD
        ACTIVATE_FINANCIAL_RISK_DATA_BVD: Returns Financial Risk Data from BvD
        ACTIVATE_OWNERSHIP_DATA_BVD: Returns Ownership Data from BvD
    ReferenceDataConfigurationId:
      type: string
      description: >
        Configuration ID used to set up lookup. If provided, those parameters
        will be affected.

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

        * `dataSource`

        * `dataMatchingDefinitionId`

        * `matchingThreshold`

        * `maxCandidates`

        * `pageSize` (deprecated)

        * `limit`

        * `featuresOn`

        * `featuresOff`
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    ReferenceDataFetchConfigurationId:
      type: string
      description: >
        Configuration ID used to set up fetch. If provided, those parameters
        will be affected.

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

        * `screeningMatchingThreshold`

        * `featuresOn`

        * `featuresOff`
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    BusinessPartnerLookupRequest:
      type: object
      description: >
        Specify the parameters for a Business Partner lookup. 


        It allows you to:

        * filter the data sources and data mirrors that will be queried, 

        * set a threshold for the data matching, 

        * specify the maximum number of candidates to be returned, 

        * activate or deactivate specific features.


        If outboundMapping is set, Business Partner is transformed to the
        desired mapped record in a key-value representation.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartnerParam'
        dataSource:
          deprecated: true
          type: string
          description: Data source to be used for the lookup.
          example: VIES
        dataSources:
          type: array
          description: Filter data sources used during lookup
          items:
            type: string
            description: Data source to be used for the lookup.
            example: VIES
        storagesDataSources:
          description: >-
            This field allows to filter data mirrors that will be queried. For
            each data mirror, data sources can also be filtered. Leave empty to
            include all available data mirrors in query.
          type: array
          items:
            type: object
            description: Data Mirror and Data Source to be included during lookup.
            properties:
              storageId:
                $ref: '#/components/schemas/BusinessPartnerStorageId'
              dataSources:
                type: array
                description: >-
                  IDs of Data Sources in specified Data Mirror to be included
                  during lookup. Leave empty to include all Data Dources.
                items:
                  $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        dataMatchingDefinitionId:
          type: string
          deprecated: true
          description: >
            The data matching definition ID to be used for the lookup. If set,
            it will overwrite the default data matching definition.

            If not set, the default data matching definition will be used.
          example: 6461e6113b1865304b3038b6
        matchingClassifications:
          type: array
          items:
            $ref: '#/components/schemas/LookupMatchingClassification'
        matchingThreshold:
          type: number
          format: double
          description: Matching threshold for the lookup. Default 0.5.
          example: '0.8'
          minimum: 0
          maximum: 1
        maxCandidates:
          type: integer
          description: Maximum number of candidates to be returned. Default 10.
          example: '20'
          minimum: 20
          maximum: 200
        pageSize:
          $ref: '#/components/schemas/PageSize'
        page:
          type: integer
          description: Current page number.
          example: '1'
          default: 0
          minimum: 0
        limit:
          type: integer
          description: Number of items per page.
          example: '100'
          minimum: 0
          maximum: 1000
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        featuresOn:
          type: array
          description: The features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFeatures'
        featuresOff:
          type: array
          description: The features to be deactivated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFeatures'
        configurationId:
          $ref: '#/components/schemas/ReferenceDataConfigurationId'
        outboundMapping:
          $ref: '#/components/schemas/OutboundMapping'
    OutboundMapping:
      type: string
      deprecated: true
      description: >
        If `outboundMapping` is set, business partner is transformed to the
        desired mapped record in a key-value representation.


        Avaliable mappings:

        * SAP
      example: SAP
    BusinessPartnerSearchRequest:
      type: object
      description: Parameters for Business Partner search.
      properties:
        query:
          type: string
          minLength: 1
          description: Pattern which will be used to search in multiple fields.
          example: CDQ Lukasstrasse 4, Sankt Gallen 9000
        pageSize:
          $ref: '#/components/schemas/PageSize'
        page:
          $ref: '#/components/schemas/Page'
    BusinessPartnerSearchResult:
      type: object
      description: Result of Business Partner search.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        totals:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          description: List of Business Partners search entry.
          items:
            $ref: '#/components/schemas/BusinessPartnerSearchResultEntry'
    BusinessPartnerSearchResultEntry:
      type: object
      description: Single entry of Business Partner search result.
      properties:
        relevanceScore:
          type: number
          description: Value shows how relevant the results are based on given query
          example: '0.8'
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    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:
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/ValueParam'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/IdentifierParam'
        legalForm:
          $ref: '#/components/schemas/ValueParam'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/AddressParam'
          minItems: 0
          maxItems: 1
        jsonRecord:
          $ref: '#/components/schemas/JsonRecord'
        bankAccounts:
          type: array
          description: List of bank accounts of the Business Partner.
          items:
            $ref: '#/components/schemas/BankAccountParam'
    JsonRecord:
      description: Custom-representation of a data record
      type: object
      additionalProperties: true
    AddressParam:
      type: object
      description: Parameters for address concept.
      properties:
        thoroughfares:
          type: array
          description: List of thoroughfares.
          items:
            $ref: '#/components/schemas/ThoroughfareParam'
        localities:
          type: array
          description: List of localities.
          items:
            $ref: '#/components/schemas/ValueParam'
        administrativeAreas:
          type: array
          description: List of administrative areas.
          items:
            $ref: '#/components/schemas/ValueParam'
        postCodes:
          type: array
          description: List of post codes.
          items:
            $ref: '#/components/schemas/ValueParam'
        country:
          $ref: '#/components/schemas/CountryParam'
    IdentifierParam:
      type: object
      description: Parameters for Identifier concept.
      properties:
        value:
          $ref: '#/components/schemas/IdentifierValue'
        type:
          $ref: '#/components/schemas/IdentifierTypeParam'
        issuingBody:
          $ref: '#/components/schemas/IssuingBodyParam'
    IssuingBodyParam:
      type: object
      description: Parameters for Issuing Body concept.
      properties:
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        name:
          $ref: '#/components/schemas/IssuingBodyName'
    IdentifierTypeParam:
      type: object
      description: Parameters for Identifier Type concept.
      properties:
        technicalKey:
          $ref: '#/components/schemas/IdentifierTypeTechnicalKey'
    ValueParam:
      type: object
      description: Parameters for different kind of concept.
      properties:
        value:
          type: string
          description: Value of the concept.
          example: Concept name or value
    ThoroughfareParam:
      type: object
      description: Parameters for thoroughfare concept.
      properties:
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
    CountryParam:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    BusinessPartnerLookupResult:
      type: object
      description: >-
        Display results of Business Partner Lookup with the Golden Record and
        other records with na matching score.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        totals:
          $ref: '#/components/schemas/PageTotal'
        page:
          $ref: '#/components/schemas/Page'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        values:
          type: array
          description: List of Business Partner Lookup Matches.
          items:
            $ref: '#/components/schemas/BusinessPartnerLookupMatch'
        goldenRecord:
          $ref: '#/components/schemas/GoldenRecord'
        debugInfo:
          type: object
          description: >-
            Reference implementation how to structure external service
            responses. Can be activated by a feature `SHOW_DEBUG_INFO`.
          properties:
            features:
              type: array
              description: The features to be activated during the lookup.
              items:
                $ref: '#/components/schemas/Feature'
            request:
              $ref: '#/components/schemas/BusinessPartnerLookupRequest'
            curatedRequest:
              $ref: '#/components/schemas/BusinessPartnerLookupRequest'
            externalServiceResponses:
              type: array
              description: The list of external service responses.
              items:
                $ref: '#/components/schemas/ExternalServiceResponse'
        annotations:
          $ref: '#/components/schemas/Annotations'
    Annotations:
      type: array
      description: The list of annotations.
      items:
        $ref: '#/components/schemas/Annotation'
    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'
        status:
          $ref: '#/components/schemas/HttpStatus'
        path:
          $ref: '#/components/schemas/HttpPath'
        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: >-
        Additional information about any external services used during the
        original request.
      properties:
        apiError:
          $ref: '#/components/schemas/ApiError'
        timestamp:
          $ref: '#/components/schemas/ApiErrorTimestamp'
        httpStatus:
          $ref: '#/components/schemas/HttpStatus'
        httpPath:
          $ref: '#/components/schemas/HttpPath'
        status:
          $ref: '#/components/schemas/ExternalServiceResponseStatus'
        message:
          type: string
          description: Received message of the external service.
          example: VIES_NOT_AVAILABLE - Vies is currently not available
        source:
          type: string
          description: Source of the response.
          example: CHUID
        additionalInformations:
          type: array
          description: Any additional information received during the original request.
          items:
            $ref: '#/components/schemas/AdditionalInformation'
    AdditionalInformation:
      type: object
      description: >-
        Object provide additional information from the request to the external
        service like headers, requestor id etc.
      properties:
        key:
          type: string
          description: Key of the generic key/value map.
          example: KEY
        value:
          type: string
          description: Key of the generic key/value map.
          example: '1'
    Annotation:
      type: object
      description: Additional information about the result.
      properties:
        technicalKey:
          type: string
          description: Unique code of this annotation type.
          example: Ref-cred
        url:
          type: string
          description: Page with information related to this annotation type.
          example: https://cdq.com/cred
        message:
          type: string
          description: Content of annotation.
          example: Incorrect credentials
        severity:
          type: string
          description: |
            Additional information regarding results severity:
              * `INFO` - Result is correct
              * `WARNING` - Result may be incomplete
              * `ERROR` - Result are not reliable
              * `OTHER` - Annotation is not related to results
          example: ERROR
    GoldenRecord:
      type: object
      description: >-
        Represent a Business Partner record with the highest matching score
        based on data completeness.
      properties:
        cdqId:
          type: string
          description: CDQ ID of the Golden Record.
          example: VIES:PL1132639219
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        mappedRecord:
          $ref: '#/components/schemas/MappedRecord'
        metadata:
          type: array
          description: Metadata of the Golden Record.
          items:
            $ref: '#/components/schemas/Metadata'
        businessPartnerChanges:
          type: array
          items:
            $ref: '#/components/schemas/PropertyChange'
    Metadata:
      type: object
      description: >-
        Contains additional information and context about the generation
        process.
      properties:
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        dataSource:
          $ref: '#/components/schemas/DataSource'
        cdqId:
          type: string
          description: CDQ ID.
          example: VIES:PL1132639219
    DataSource:
      type: object
      description: Data Source of the Data Pool.
      properties:
        name:
          $ref: '#/components/schemas/DataSourceName'
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    BusinessPartnerFetchResult:
      type: object
      description: >-
        Business Partner Fetch Result. Contains the Business Partner and the
        metadata.
      properties:
        debugInfo:
          $ref: '#/components/schemas/FetchDebugInfo'
        status:
          type: string
          description: |
            status:
              * `OK` - Service returned a correct response.
              * `FAILED` - Call to external service failed.
              * `INVALID_INPUT` - Given input parameter is invalid or entry not found.
              * `AUTHORIZATION_FAILED` - Authorization to external service does not succeed.
              * `EXTERNAL_QUOTA_EXCEEDED` - External service quota is exceeded. Not applies to CDQ quota.
          example: OK
        message:
          type: string
          description: Additional information regarding results.
          example: Given input parameter is invalid or entry not found.
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        lastSyncAt:
          type: string
          description: Last time the Business Partner was synchronized.
          example: '2025-10-07T05:40:40Z'
        lastUpdatedAt:
          type: string
          description: Last time the Business Partner was updated.
          example: '2025-10-07T05:40:40Z'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        dataSourceName:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        rawRecord:
          type: array
          description: List of raw records returned by external service.
          items:
            $ref: '#/components/schemas/KeyValueItem'
        rawRecordJson:
          $ref: '#/components/schemas/RawRecordJson'
        mappedRecord:
          $ref: '#/components/schemas/MappedRecord'
        businessPartnerChanges:
          type: array
          description: List of changes in the Business Partner.
          items:
            $ref: '#/components/schemas/PropertyChange'
        screeningResult:
          $ref: '#/components/schemas/BusinessPartnerFetchScreeningResult'
        additionalInformation:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInformation'
        commercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
        domesticCommercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
        legalEntity:
          $ref: '#/components/schemas/BusinessPartner'
    RawRecordJson:
      type: object
      description: Raw record returned by external service in JSON format.
      additionalProperties: true
    BusinessPartnerFetchScreeningResult:
      type: object
      description: Result of the screening process.
      properties:
        summary:
          $ref: '#/components/schemas/BusinessPartnerFetchScreeningResultSummary'
        details:
          $ref: '#/components/schemas/BusinessPartnerFetchScreeningResultDetails'
        auditTrail:
          $ref: '#/components/schemas/BusinessPartnerFetchScreeningAuditTrail'
    BusinessPartnerFetchScreeningAuditTrail:
      type: object
      description: Contains the screening audit trail for a Business Partner.
      properties:
        screeningSubject:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSubject
        screenedNames:
          type: array
          description: List of screened names.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreenedName
        screeningDate:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningDate
        screeningSettings:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettings
        matchingProfileSettings:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailMatchingProfileSettings
    BusinessPartnerFetchScreeningAuditTrailScreeningDate:
      type: string
      description: Date and time when the screening was performed.
      example: '2025-10-07T05:40:40Z'
    BusinessPartnerFetchScreeningAuditTrailScreenedName:
      type: string
      description: Name of the Business Partner that was screened.
      example: John Doe
    BusinessPartnerFetchScreeningAuditTrailScreeningSubject:
      type: string
      description: Subject of the screening.
      example: VIES:PL8660001429
    BusinessPartnerFetchScreeningAuditTrailMatchingProfileSettings:
      type: object
      description: Matching profile settings for the screening audit trail.
      properties:
        sanctionsMinMatchingsScore:
          $ref: '#/components/schemas/DataMatchingThreshold'
        watchlistsMinMatchingsScore:
          $ref: '#/components/schemas/DataMatchingThreshold'
        pepMinMatchingsScore:
          $ref: '#/components/schemas/DataMatchingThreshold'
    BusinessPartnerFetchScreeningAuditTrailScreeningSettings:
      type: object
      description: Screening settings for the screening audit trail.
      properties:
        pepCheckEnabled:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsPepCheckEnabled
        sanctionCheckEnabled:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsSanctionCheckEnabled
        watchListCheckEnabled:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListsUsedForCheck
        listsUsedForCheck:
          type: array
          description: List of lists used for the screening process.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsList
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsPepCheckEnabled:
      type: boolean
      description: Specifies whether PEP checks are enabled for the screening audit trail
      example: 'true'
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsSanctionCheckEnabled:
      type: boolean
      description: >-
        Specifies whether sanction checks are enabled for the screening audit
        trail.
      example: 'true'
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListsUsedForCheck:
      type: boolean
      description: >-
        Specifies whether the lists used for the check are included in the
        screening audit trail.
      example: 'true'
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsList:
      type: object
      description: List used for the screening process.
      properties:
        authority:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListAuthority
        name:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListName
        type:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListType
        date:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListDate
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListType:
      type: object
      description: Type of list used for the screening process.
      properties:
        name:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeName
        url:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeUrl
        technicalKey:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeTechnicalKey
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListAuthority:
      type: string
      description: Authority of the list used for the check.
      example: EU
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListDate:
      type: string
      description: Date of the list used for the check.
      example: '2025-10-07T05:40:40Z'
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListName:
      type: string
      description: Name of the list used for the check.
      example: EU Sanctions
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeName:
      type: string
      description: Name of the type of list used for the check.
      example: OFAC Sanctions
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeUrl:
      type: string
      description: URL of the type of list used for the check.
      example: >-
        https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx
    BusinessPartnerFetchScreeningAuditTrailScreeningSettingsListTypeTechnicalKey:
      type: string
      description: Technical key of the type of list used for the check.
      example: OFAC
    BusinessPartnerFetchScreeningResultDetails:
      type: object
      description: Details of the screening process.
      properties:
        sanctions:
          type: array
          description: List of sanctions hits.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerFetchScreeningResultDetailsItem
        watchlists:
          type: array
          description: List of watchlists hits.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerFetchScreeningResultDetailsItem
        pep:
          type: array
          description: List of PEP hits.
          items:
            $ref: >-
              #/components/schemas/BusinessPartnerFetchScreeningResultDetailsItem
    BusinessPartnerFetchScreeningResultDetailsItem:
      type: object
      description: Details of a single screening result item for a Business Partner.
      properties:
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        rawRecord:
          type: array
          description: List of raw records returned by external service.
          items:
            $ref: '#/components/schemas/KeyValueItem'
        list:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningResultDetailsItemList
        rationale:
          $ref: >-
            #/components/schemas/BusinessPartnerFetchScreeningResultDetailsItemRationale
    BusinessPartnerFetchScreeningResultDetailsItemList:
      type: object
      description: List of screening result items for a Business Partner.
      properties:
        name:
          type: string
          description: Name of the list.
          example: EU Sanctions
        type:
          type: string
          description: Type of the list.
          example: Sanctions
        dateOfPublication:
          type: string
          description: Publication date of the list.
          example: '2025-10-07T05:40:40Z'
        authority:
          type: string
          description: Authority of the list.
          example: EU
    BusinessPartnerFetchScreeningResultDetailsItemRationale:
      type: object
      description: Rationale for the screening result.
      properties:
        value:
          type: string
          description: Explanation of the rationale.
          example: The name is similar to a name on the EU Sanctions list.
        url:
          type: string
          description: URL to review the rationale.
          example: >-
            https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx
    BusinessPartnerFetchScreeningResultSummary:
      type: object
      description: Summary of a screening result for a Business Partner.
      properties:
        hitCountOverall:
          type: integer
          description: Total number of hits.
          example: '3'
        hitCountSanctions:
          type: integer
          description: Number of hits in the sanctions list.\
          example: '5'
        hitCountWatchlists:
          type: integer
          description: Number of hits in the watchlists.
          example: '7'
        hitCountPep:
          type: integer
          description: Number of hits in the PEP list.
          example: '11'
    FetchDebugInfo:
      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: The list of external service responses.
          items:
            $ref: '#/components/schemas/ExternalServiceResponse'
    Feature:
      type: object
      description: Feature used in the lookup.
      properties:
        feature:
          type: string
          description: Feature name.
          example: ACTIVATE_DATASOURCE_BVD
        active:
          type: boolean
          description: Indicates whether the feature is active.
          example: 'true'
    BusinessPartnerLookupMatch:
      type: object
      description: Business Partner found in the Data Mirror with the match.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        lastSyncAt:
          type: string
          description: Date of last synchronization
          example: '2025-10-07T05:40:40Z'
        lastUpdatedAt:
          type: string
          description: Date of last business partner modification
          example: '2025-10-07T05:40:40Z'
        dataSourceName:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        storageDataSource:
          type: string
          description: Identifier of Data Source in data Mirror Storage.
          example: 648824a691d8d2503d65103e
        subscriptionMetadata:
          $ref: '#/components/schemas/SubscriptionMetadata'
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        additionalInformation:
          type: array
          description: Any additional information received during the original request.
          items:
            $ref: '#/components/schemas/AdditionalInformation'
        goldenRecordUse:
          type: string
          description: >
            Describes if and how was business partner used in golden record
            composition.
              * `PRIMARY` - Base entry for golden record
              * `ENRICHMENT` - Entry used to add information to base entry
          example: PRIMARY
        mappedRecord:
          $ref: '#/components/schemas/MappedRecord'
    MappedRecord:
      type: object
      description: Custom-representation of a data record.
      properties:
        attributes:
          type: array
          description: List of attributes of the Business Partner.
          items:
            $ref: '#/components/schemas/Attribute'
    Attribute:
      type: object
      description: Attribute of a data record.
      required:
        - key
      properties:
        key:
          type: string
          description: >-
            Name of the attribute in the system/database. The key is never null
            or empty.
          example: name
        value:
          type: string
          description: >-
            Value of the attribute identified by the key. The value can be null
            or empty.
          example: John
    LookupJobResult:
      type: object
      description: Lookup job result. It contains the lookup job and the lookup result.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        lookupRequest:
          $ref: '#/components/schemas/BusinessPartnerLookupRequest'
        businessPartnerLookupResult:
          $ref: '#/components/schemas/BusinessPartnerLookupResult'
        resultStatus:
          $ref: '#/components/schemas/ResultStatus'
        addressId:
          type: string
          description: Address ID of the lookup result.
          example: '0'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
    ResultStatus:
      type: object
      description: Status of the lookup result.
      properties:
        status:
          type: string
          description: Status of the lookup result.
          example: SUCCESS
        message:
          type: string
          description: Message of the lookup result.
          example: Lookup successful
    LookupConfigurationModel:
      type: object
      description: >-
        Defines the configuration settings for a Business Partner lookup
        process.
      properties:
        limit:
          type: integer
          description: Number of items per page.
          example: '10'
          minimum: 0
          maximum: 1000
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        dataSources:
          type: array
          description: Filter data sources used during lookup.
          items:
            type: string
            description: ID of the data source to be included during lookup.
            example: VIES
        dataMatchingDefinitionId:
          type: string
          deprecated: true
          description: ID of the Data Matching definition.
          example: 6461e6113b1865304b3038b6
        matchingClassifications:
          type: array
          items:
            $ref: '#/components/schemas/LookupMatchingClassification'
        matchingThreshold:
          type: number
          description: Matching threshold for the lookup process.
          example: '0.5'
          minimum: 0
          maximum: 1
        maxCandidates:
          type: integer
          description: Maximum number of candidates to be returned.
          example: '50'
          minimum: 20
          maximum: 200
        pageSize:
          $ref: '#/components/schemas/PageSize'
        storagesDataSources:
          type: array
          description: List of Data Mirrors and Data Sources to be included during lookup.
          items:
            type: object
            description: Data Mirror and Data Source to be included during lookup.
            properties:
              storageId:
                $ref: '#/components/schemas/BusinessPartnerStorageId'
              dataSources:
                type: array
                description: >-
                  IDs of Data Sources in specified Data Mirror to be included
                  during lookup. Leave empty to include all Data Dources.
                items:
                  $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFeatures'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFeatures'
    WorkspaceConfigurationPage:
      type: object
      description: Page of workspace configurations.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of workspace configurations.
          items:
            $ref: '#/components/schemas/WorkspaceConfigurationSearchResult'
    WorkspaceConfigurationSearchResult:
      type: object
      description: Workspace configuration search result.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    BusinessPartnerLookupConfigurationUpdate:
      type: object
      description: Update an existing Business Partner lookup configuration.
      properties:
        name:
          $ref: '#/components/schemas/ConfigurationName'
        configuration:
          $ref: '#/components/schemas/LookupConfigurationModel'
    BusinessPartnerLookupConfiguration:
      type: object
      description: Configuration for Business Partner lookup.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/LookupConfigurationModel'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    BusinesPartnerLookupConfigurationVersion:
      type: object
      description: Specific version of a business partner lookup configuration.
      properties:
        id:
          type: string
          description: >-
            Unique identifier of the business partner lookup configuration
            version. Not to be confused with the configuration ID.
          example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
        name:
          type: string
          description: The name of the configuration
          example: Configuration Name
        configurationId:
          $ref: '#/components/schemas/ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/LookupConfigurationModel'
        createdAt:
          type: string
          description: >-
            Date and time when the first version of the configuration was
            created (ISO 8601-compliant).
          example: '2025-10-07T05:40:40Z'
        modifiedAt:
          type: string
          description: >-
            Date and time when this version of the configuration was created
            (ISO 8601-compliant).
          example: '2025-10-07T05:40:40Z'
        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
    RelatedConfigurationId:
      type: string
      description: Id of the related configuration
      example: a0200062daa56952a8640005
    RelatedConfigurationOwner:
      type: object
      description: Configuration which relates to the root configuration.
      properties:
        service:
          $ref: '#/components/schemas/RelatedConfigurationOwnerService'
        path:
          $ref: '#/components/schemas/RelatedConfigurationOwnerPath'
    RelatedConfigurationOwnerService:
      type: string
      description: Name of the service which is the owner of the configuration.
      example: reference-data-api
    RelatedConfigurationOwnerPath:
      type: string
      description: Endpoint used to read the related configuration.
      example: /public/configurations/businesspartnerlookup
    LookupWorkerBusinessPartner:
      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.
      allOf:
        - $ref: '#/components/schemas/BusinessPartner'
        - type: object
          description: >-
            Refers to an organizational entity engaged in various facets of
            another organization's business interactions. This collaborative
            connection often manifests as a customer, supplier, vendor, or
            service provider. In the CDQ (Corporate Data Quality) framework, the
            Business Partner assumes a pivotal role as a core managed entity.
            Each Business Partner is distinctly and globally identifiable
            through a unique CDQ ID. All pertinent information, including
            addresses, identifiers, and hierarchical data, is intricately
            associated with and linked to the specific Business Partner,
            ensuring comprehensive management and traceability within the
            system.
          properties:
            id:
              $ref: '#/components/schemas/BusinessPartnerId'
            dataSourceId:
              $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    BusinessPartner:
      type: object
      description: >-
        Refers to an organizational entity engaged in various facets of another
        organization's business interactions. This collaborative connection
        often manifests as a customer, supplier, vendor, or service provider. In
        the CDQ (Corporate Data Quality) framework, the Business Partner assumes
        a pivotal role as a core managed entity. Each Business Partner is
        distinctly and globally identifiable through a unique CDQ ID. All
        pertinent information, including addresses, identifiers, and
        hierarchical data, is intricately associated with and linked to the
        specific Business Partner, ensuring comprehensive management and
        traceability within the system.
      properties:
        names:
          type: array
          description: List of names of the Business Partner.
          items:
            $ref: '#/components/schemas/Name'
        legalForm:
          $ref: '#/components/schemas/LegalForm'
        identifiers:
          type: array
          description: List of identifiers of the Business Partner.
          items:
            $ref: '#/components/schemas/Identifier'
        categories:
          type: array
          description: List of categories of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        addresses:
          type: array
          description: List of addresses of the Business Partner.
          items:
            $ref: '#/components/schemas/Address'
        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'
        types:
          type: array
          description: List of types of the Business Partner.
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
        externalContext:
          $ref: '#/components/schemas/ExternalContext'
        jsonRecord:
          $ref: '#/components/schemas/JsonRecord'
        bankAccounts:
          type: array
          description: List of bank accounts of the Business Partner.
          items:
            $ref: '#/components/schemas/BankAccount'
    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'
        countryCode:
          $ref: '#/components/schemas/BankAccountCountryCode'
        bankAccountIdentifier:
          $ref: '#/components/schemas/BankAccountIdentifier'
    BankAccountParam:
      type: object
      description: >-
        A bank account record holds information that universally describes a
        registered bank account.
      properties:
        bankAccountIdentifier:
          $ref: '#/components/schemas/BankAccountIdentifier'
    BusinessPartnerType:
      type: object
      description: >-
        A distinct type a business partner is assigned to. It determines the
        business context a business partner is involved in. In the Corporate
        Data League, most business partners are legal entities.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKey'
    Name:
      type: object
      description: >-
        The name of a Business Partner. Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/name).
      properties:
        shortName:
          $ref: '#/components/schemas/NameShortName'
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        language:
          $ref: '#/components/schemas/Language'
        details:
          type: array
          items:
            $ref: '#/components/schemas/NameDetail'
    NameDetail:
      type: object
      description: >-
        Some additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      properties:
        value:
          $ref: '#/components/schemas/NameDetailValue'
        type:
          $ref: '#/components/schemas/NameDetailType'
    NameDetailType:
      type: object
      description: >-
        Type of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      properties:
        name:
          $ref: '#/components/schemas/NameDetailTypeName'
        url:
          $ref: '#/components/schemas/NameDetailTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/NameDetailTypeTechnicalKey'
    NameType:
      type: object
      description: >-
        The type of the name, e.g. a locally used name or an international
        version. Allowed types are documented
        [here](https://meta.cdq.com/Business_partner/name/type).
      properties:
        url:
          $ref: '#/components/schemas/NameTypeUrl'
        name:
          $ref: '#/components/schemas/NameTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-NameTypeTechnicalKey'
    Language:
      type: object
      description: Naming of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    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.).
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        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'
        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'
    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.
      properties:
        type:
          $ref: '#/components/schemas/IdentifierType'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
        status:
          $ref: '#/components/schemas/IdentifierStatus'
    IdentifierStatus:
      type: object
      description: >-
        Identifier Status refers to the current state of a unique identification
        number.
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    IdentifierType:
      type: object
      description: >-
        Value of the identifier. Allowed types are documented
        [here](https://meta.cdq.com/Category:Business_partner/identifier/type).
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    IssuingBody:
      type: object
      description: >-
        An Issuing Body is an organization or government institution that is
        responsible for assigning unique identifiers to individuals,
        organizations, or objects.
      properties:
        shortName:
          $ref: '#/components/schemas/IssuingBodyShortName'
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        names:
          $ref: '#/components/schemas/IssuingBodyNames'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
    IssuingBodyNames:
      type: array
      description: List of names of the Issuing Body.
      items:
        $ref: '#/components/schemas/schemas-Name'
    Jurisdiction:
      type: object
      description: >-
        The authority of an official organization to make decisions and
        judgments in a particular administrative area.
      properties:
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of administrative areas in the jurisdiction.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
    Country:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
        value:
          $ref: '#/components/schemas/CountryValue'
    AdministrativeArea:
      type: object
      description: A top-level geographical or political area division in a country.
      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/AdministrativeAreaType'
        language:
          $ref: '#/components/schemas/Language'
    AdministrativeAreaType:
      type: object
      description: >-
        Type of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: null
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    BusinessPartnerCategory:
      type: object
      description: >-
        A Business Partner category of a Business Partner groups similar
        Business Partners.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        url:
          $ref: '#/components/schemas/BusinessPartnerCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    BusinessPartnerStatus:
      type: object
      description: >-
        Describes the status of a business partner with respect to its level of
        activity (e.g. out of business) or legally relevant conditions (e.g. in
        liquidation).
      properties:
        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.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    PartnerProfile:
      type: object
      description: >-
        A Business Partner [profile](https://meta.cdq.com/Partner_profile)
        contains important information about a company, such as its
        classification, tags, contact details, or minority indicator.
      properties:
        minorityIndicator:
          $ref: '#/components/schemas/MinorityIndicator'
        classifications:
          type: array
          description: List of classifications of the Business Partner.
          items:
            $ref: '#/components/schemas/Classification'
        phoneNumbers:
          type: array
          description: List of phone numbers of the Business Partner.
          items:
            $ref: '#/components/schemas/PhoneNumber'
        websites:
          type: array
          description: List of websites of the Business Partner.
          items:
            $ref: '#/components/schemas/Website'
        contactEmails:
          type: array
          description: List of contact emails of the Business Partner.
          items:
            $ref: '#/components/schemas/ContactEmail'
        tags:
          type: array
          description: List of Tags.
          items:
            $ref: '#/components/schemas/Tag'
        vatPayerStatus:
          $ref: '#/components/schemas/VatPayerStatus'
        hcpProfile:
          $ref: '#/components/schemas/HcpProfile'
    HcpProfile:
      type: object
      description: >
        Healthcare Professional Profile informs about the status, licenses, and
        location of a natural person who is a member 

        of the medical, dental, pharmacy, or nursing professions or any other
        person who, in the course of his/her professional 

        activities, may prescribe, purchase, supply, recommend or administer a
        Medicinal Product and whose primary practice, 

        principal professional address or place of incorporation is in Europe.
      properties:
        generalLicense:
          $ref: '#/components/schemas/GeneralLicense'
        operationalPermissions:
          type: array
          description: Operational permissions of the Healthcare Professional.
          items:
            $ref: '#/components/schemas/OperationalPermission'
    GeneralLicense:
      type: object
      description: The general license of the Healthcare Professional.
      properties:
        professionType:
          $ref: '#/components/schemas/ProfessionType'
        licenseStatus:
          $ref: '#/components/schemas/LicenseStatus'
    ProfessionType:
      type: object
      description: The profession type of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/ProfessionTypeName'
        url:
          $ref: '#/components/schemas/ProfessionTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ProfessionTypeTechnicalKey'
    LicenseStatus:
      type: object
      description: The license status of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/LicenseStatusName'
        url:
          $ref: '#/components/schemas/LicenseStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/LicenseStatusTechnicalKey'
    OperationalPermission:
      type: object
      description: The operational permission of the Healthcare Professional.
      properties:
        issuingAuthority:
          type: string
          description: The issuing authority of the operational permission.
          example: Swiss Medical Association
        permissionStatus:
          $ref: '#/components/schemas/PermissionStatus'
        activityStatus:
          $ref: '#/components/schemas/ActivityStatus'
        practiceLocations:
          type: array
          description: Practice locations of the Healthcare Professional.
          items:
            $ref: '#/components/schemas/PracticeLocation'
    PermissionStatus:
      type: object
      description: The permission status of the operational permission.
      properties:
        name:
          $ref: '#/components/schemas/PermissionStatusName'
        url:
          $ref: '#/components/schemas/PermissionStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/PermissionStatusTechnicalKey'
    ActivityStatus:
      type: object
      description: The activity status of the operational permission.
      properties:
        name:
          $ref: '#/components/schemas/ActivityStatusName'
        url:
          $ref: '#/components/schemas/ActivityStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/ActivityStatusTechnicalKey'
    PracticeLocation:
      type: object
      description: The practice location of the Healthcare Professional.
      properties:
        practiceName:
          type: string
          description: The practice location of the Healthcare Professional.
          example: VIVOMED AG
        selfDispensationStatus:
          $ref: '#/components/schemas/SelfDispensationStatus'
        controlledSubstancePurchasePermission:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermission'
    SelfDispensationStatus:
      type: object
      description: The self-dispensation status of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/SelfDispensationStatusName'
        url:
          $ref: '#/components/schemas/SelfDispensationStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/SelfDispensationStatusTechnicalKey'
    ControlledSubstancePurchasePermission:
      type: object
      description: >-
        The controlled substance purchase permission of the Healthcare
        Professional.
      properties:
        name:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermissionName'
        url:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermissionUrl'
        technicalKey:
          $ref: >-
            #/components/schemas/ControlledSubstancePurchasePermissionTechnicalKey
    VatPayerStatus:
      description: >-
        Information about VAT status including publication date and registration
        authority.
      type: object
      properties:
        publicationDate:
          $ref: '#/components/schemas/VatPayerStatusPublicationDate'
        status:
          $ref: '#/components/schemas/PayerStatus'
        registrationAuthority:
          $ref: '#/components/schemas/RegistrationAuthority'
    RegistrationAuthority:
      description: Additional information about registration authority.
      type: object
      properties:
        registrationAuthorityId:
          $ref: '#/components/schemas/RegistrationAuthorityId'
        registrationAuthorityEntityId:
          $ref: '#/components/schemas/RegistrationAuthorityEntityId'
        otherRegistrationAuthorityId:
          $ref: '#/components/schemas/OtherRegistrationAuthorityId'
    PayerStatus:
      description: Information about payer status.
      type: object
      properties:
        name:
          $ref: '#/components/schemas/PayerStatusName'
        technicalKey:
          $ref: '#/components/schemas/PayerStatusTechnicalKey'
    Tag:
      type: object
      description: Tag
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagType'
    TagValue:
      type: string
      description: Value of the tag.
      example: Warehouse
    TagType:
      description: A type that specifies the nature of the tag.
      type: object
      properties:
        technicalKey:
          $ref: '#/components/schemas/TagTypeTechnicalKey'
    TagTypeTechnicalKey:
      type: string
      description: Technical Key of the Tag.
      example: WAREHOUSE
    MinorityIndicator:
      description: >
        The minority indicator determines the minority group to which a vendor
        belongs. Usually, the minority indicator is only relevant in the United
        States and it is used for reporting purposes only. There is a
        corresponding SAP field in the vendor master for maintaining the
        minority indicator.


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


        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/partner_profile/minority_indicator).
      type: object
      properties:
        value:
          $ref: '#/components/schemas/MinorityIndicatorValue'
    Classification:
      type: object
      description: >-
        A business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      properties:
        value:
          $ref: '#/components/schemas/ClassificationValue'
        code:
          $ref: '#/components/schemas/ClassificationCode'
        type:
          $ref: '#/components/schemas/ClassificationType'
    ClassificationType:
      type: object
      description: >-
        Type of classification such as NACE, SIC, NAF or other industry
        classification standards.
      properties:
        name:
          $ref: '#/components/schemas/ClassificationTypeName'
        url:
          $ref: '#/components/schemas/ClassificationTypeUrl'
    PhoneNumber:
      type: object
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarters.
      properties:
        countryPrefix:
          $ref: '#/components/schemas/PhoneNumberCountryPrefix'
        number:
          $ref: '#/components/schemas/PhoneNumberNumber'
        type:
          $ref: '#/components/schemas/PhoneNumberType'
        value:
          $ref: '#/components/schemas/PhoneNumberValue'
    PhoneNumberType:
      type: object
      description: >-
        The
        [type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type)
        of phone number such as mobile phone or fixed line.
      properties:
        name:
          $ref: '#/components/schemas/PhoneNumberTypeName'
        url:
          $ref: '#/components/schemas/PhoneNumberTypeUrl'
    Website:
      type: object
      description: >-
        Webpages related to the Business Partner, e.g. the main corporate
        website as also provided by some company registers.
      properties:
        url:
          $ref: '#/components/schemas/WebsiteUrl'
        type:
          $ref: '#/components/schemas/WebsiteType'
    WebsiteType:
      type: object
      description: >-
        Describes the type of website of a business partner, e.g. corporate
        website, official LinkedIn profile, etc.
      properties:
        name:
          $ref: '#/components/schemas/WebsiteTypeName'
        url:
          $ref: '#/components/schemas/WebsiteTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/WebsiteTypeTechnicalKey'
    ContactEmail:
      type: object
      description: Actual email address of the Business Partner.
      properties:
        value:
          $ref: '#/components/schemas/ContactEmailValue'
    Address:
      type: object
      description: >-
        An address provides information about the physical location of a
        Business Partner. It can be specialized in a certain context(e.g.
        delivery address or invoice address).
      properties:
        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/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'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        types:
          type: array
          description: List of address types.
          items:
            $ref: '#/components/schemas/AddressType'
        formattedAddress:
          $ref: '#/components/schemas/schemas-FormattedAddress'
    GeographicCoordinates:
      type: object
      description: Decimal geographic coordinates (WGS 84 - reference coordinate system).
      properties:
        latitude:
          $ref: '#/components/schemas/GeographicCoordinatesLatitude'
        longitude:
          $ref: '#/components/schemas/GeographicCoordinatesLongitude'
    AddressVersion:
      type: object
      description: >-
        CDQ supports multiple versions of addresses comprising different
        charsets and languages. An address version is a unique combination of a
        character set and a language.
      properties:
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
        language:
          $ref: '#/components/schemas/Language'
    CharacterSet:
      type: object
      description: >-
        Collection of
        [characters](https://meta.cdq.com/Address/version/character_set) that
        can be used to represent and manipulate textual data.
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    AddressIdentifyingName:
      type: object
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      properties:
        value:
          $ref: '#/components/schemas/AddressIdentifyingNameValue'
    CareOf:
      type: object
      description: >-
        Signifies an intermediary who is responsible for transferring a piece of
        mail between the postal system and the final addressee. For example,
        when the addressee has no standard address, is under a corporate mail
        system, or is being manually forwarded mail sent to a more accessible
        location.
      properties:
        value:
          $ref: '#/components/schemas/CareOfValue'
    AddressContext:
      type: object
      description: >-
        The address context provides us with some additional information about
        the usage or specific recipient information of the addresses. It may
        hold multiple information organized as "tags".
      properties:
        value:
          $ref: '#/components/schemas/AddressContextValue'
    PostCode:
      type: object
      description: >-
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or an combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    PostCodeType:
      type: object
      description: 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.
      properties:
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        value:
          $ref: '#/components/schemas/LocalityValue'
        language:
          $ref: '#/components/schemas/Language'
    LocalityType:
      type: object
      description: Type of the [Locality](https://meta.cdq.com/Address/locality).
      properties:
        name:
          $ref: '#/components/schemas/LocalityTypeName'
        url:
          $ref: '#/components/schemas/LocalityTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/LocalityTypeTechnicalKey'
    Thoroughfare:
      type: object
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      properties:
        type:
          $ref: '#/components/schemas/ThoroughfareType'
        shortName:
          $ref: '#/components/schemas/ThoroughfareShortName'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        name:
          $ref: '#/components/schemas/ThoroughfareName'
        direction:
          $ref: '#/components/schemas/ThoroughfareDirection'
        language:
          $ref: '#/components/schemas/Language'
    ThoroughfareType:
      type: object
      description: Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      properties:
        name:
          $ref: '#/components/schemas/ThoroughfareTypeName'
        url:
          $ref: '#/components/schemas/ThoroughfareTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    Premise:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        shortName:
          $ref: '#/components/schemas/PremiseShortName'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseType'
        language:
          $ref: '#/components/schemas/Language'
    PremiseType:
      type: object
      description: Type of the Premise.
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/schemas-PremiseTypeTechnicalKey'
    PostalDeliveryPoint:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        type:
          $ref: '#/components/schemas/PostalDeliveryPointType'
        shortName:
          $ref: '#/components/schemas/PostalDeliveryPointShortName'
        number:
          $ref: '#/components/schemas/PostalDeliveryPointNumber'
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        language:
          $ref: '#/components/schemas/Language'
    PostalDeliveryPointType:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/schemas-PostalDeliveryPointTypeTechnicalKey'
    AddressMetadata:
      type: object
      description: Specifies the language and primary data provenance.
      properties:
        primaryProvenance:
          $ref: '#/components/schemas/Provenance'
        language:
          $ref: '#/components/schemas/Language'
    AddressType:
      type: object
      description: >-
        An address type characterizes an address. The type of address is a
        structural statement and provides a truth that is applicable to any user
        (e.g. a legal address is a fact, or that an address is a PO BOX
        address), other than address functions that may differ from user to
        user. Address functions determine the particular business context in
        which an address is in use.
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    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'
    ExternalContext:
      type: object
      description: Describe own identifiers of a record (others than just the external ID).
      properties:
        identifiers:
          type: array
          description: List of external context identifiers.
          items:
            $ref: '#/components/schemas/ExternalContextIdentifier'
    ExternalContextIdentifier:
      type: object
      description: Describe own identifiers of a record (others than just the external ID).
      properties:
        value:
          $ref: '#/components/schemas/ExternalContextIdentifierValue'
        type:
          $ref: '#/components/schemas/ExternalContextIdentifierType'
    ExternalContextIdentifierType:
      type: object
      description: Type of own identifiers of a record.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    BusinessPartnerFetchConfiguration:
      type: object
      description: Configuration for fetching Business Partners.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/FetchConfigurationModel'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    BusinessPartnerFetchConfigurationVersion:
      type: object
      description: Specific version of a business partner fetch configuration.
      properties:
        id:
          type: string
          description: >-
            Unique identifier of the business partner fetch configuration
            version. Not to be confused with the configuration ID.
          example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
        name:
          type: string
          description: The name of the configuration
          example: Configuration Name
        configurationId:
          $ref: '#/components/schemas/ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersionNumber'
        configuration:
          $ref: '#/components/schemas/FetchConfigurationModel'
        createdAt:
          type: string
          description: >-
            Date and time when the first version of the configuration was
            created (ISO 8601-compliant).
          example: '2025-10-07T05:40:40Z'
        modifiedAt:
          type: string
          description: >-
            Date and time when this version of the configuration was created
            (ISO 8601-compliant).
          example: '2025-10-07T05:40:40Z'
        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'
    FetchConfigurationModel:
      type: object
      description: Configuration for fetching Business Partners.
      properties:
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/BusinessPartnerFetchFeatures'
        screeningMatchingThreshold:
          type: number
          description: >-
            The matching threshold. When not set then all entries are taken into
            consideration
          example: '0.8'
    BusinessPartnerFetchConfigurationCreate:
      type: object
      description: Create a new configuration for fetching Business Partners.
      required:
        - name
        - configuration
      properties:
        workspaceId:
          $ref: '#/components/schemas/WorkspaceId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        configuration:
          $ref: '#/components/schemas/FetchConfigurationModel'
    BusinessPartnerFetchConfigurationUpdate:
      type: object
      description: Update an existing configuration for fetching Business Partners.
      properties:
        name:
          $ref: '#/components/schemas/ConfigurationName'
        configuration:
          $ref: '#/components/schemas/FetchConfigurationModel'
    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.
    LookupChunkWorkerRequest:
      type: object
      description: Request for Lookup chunk.
      properties:
        requests:
          type: array
          description: List of Lookup requests.
          items:
            $ref: '#/components/schemas/SingleLookupWorkerRequest'
        processingLog:
          $ref: '#/components/schemas/ProcessingLog'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        storageOrganizationId:
          $ref: '#/components/schemas/OrganizationId'
    SingleLookupWorkerRequest:
      type: object
      description: Request for single Lookup.
      properties:
        request:
          $ref: '#/components/schemas/SingleLookupRequest'
    SingleLookupRequest:
      type: object
      description: Parameters for a Single Business Partner Lookup.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerLookupRequest'
        - type: object
          description: Parameters for a Single Business Partner Lookup.
          required:
            - businessPartner
          properties:
            businessPartner:
              $ref: '#/components/schemas/LookupWorkerBusinessPartner'
    ProcessingLog:
      type: object
      description: ID of the processing log.
      properties:
        id:
          $ref: '#/components/schemas/ProcessingLogId'
        trigger:
          $ref: '#/components/schemas/ProcessingLogTrigger'
        replyQueue:
          $ref: '#/components/schemas/ReplyQueue'
    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: OVERLAP_LOG
    ProcessingLogTrigger:
      type: object
      description: Processing log trigger.
      properties:
        type:
          $ref: '#/components/schemas/ProcessingLogTriggerType'
        provenance:
          $ref: '#/components/schemas/ProcessingLogTriggerProvenance'
        details:
          $ref: '#/components/schemas/ProcessingLogTriggerDetails'
    ProcessingLogTriggerProvenance:
      type: object
      description: Processing log trigger provenance.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    ProcessingLogTriggerDetails:
      type: object
      description: Processing log trigger details.
      properties:
        value:
          $ref: '#/components/schemas/ProcessingLogTriggerDetailsValue'
    ProcessingLogTriggerDetailsValue:
      type: string
      description: Processing log trigger details value.
      example: '123'
    ProcessingLogTriggerType:
      type: string
      description: >-
        Processing log trigger type determining way how the lookup item or job
        has been triggered.
      example: INITIALIZED
    LookupChunkWorkerResult:
      type: object
      description: Result of Lookup chunk.
      properties:
        numberOfProcessed:
          $ref: '#/components/schemas/LookupChunkWorkerResultNumberOfProcessed'
        numberOfFailed:
          $ref: '#/components/schemas/LookupChunkWorkerResultNumberOfFailed'
        numberOfProcessingLogTasksSent:
          $ref: >-
            #/components/schemas/LookupChunkWorkerResultNumberOfProcessingLogTasksSent
        results:
          type: array
          description: List of Lookup results.
          items:
            $ref: '#/components/schemas/BusinessPartnerLookupWorkerResult'
    LookupChunkWorkerResultNumberOfProcessed:
      type: integer
      description: Number of processed business partners.
      example: '1'
    LookupChunkWorkerResultNumberOfFailed:
      type: integer
      description: Number of failed business partners.
      example: '1'
    LookupChunkWorkerResultNumberOfProcessingLogTasksSent:
      type: integer
      description: Number of processing logs tasks sent.
      example: '1'
    BusinessPartnerLookupWorkerResult:
      type: object
      description: Result of Business Partner Lookup.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        businessPartnerExternalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
        results:
          type: array
          description: List of Lookup results.
          items:
            $ref: '#/components/schemas/LookupWorkerResult'
    LookupWorkerResult:
      type: object
      description: Result of Lookup for Business Partner.
      properties:
        status:
          $ref: '#/components/schemas/SingleLookupWorkerResultStatus'
        message:
          $ref: '#/components/schemas/SingleLookupWorkerResultMessage'
        result:
          $ref: '#/components/schemas/SingleLookupResult'
        addressId:
          $ref: '#/components/schemas/SingleLookupWorkerResultAddressId'
    SingleLookupWorkerResultStatus:
      type: string
      description: |
        Status of the Batch Lookup Job Result.
        Possible values: 
        * `OK` - Batch Lookup Job Result was successfully processed.
        * `FAILED` - Batch Lookup Job Result was failed.
      example: OK
    SingleLookupWorkerResultMessage:
      type: string
      description: Additional explanations for status - especially for the FAILED case.
      example: Storage with provided ID doesn’t exist.
    SingleLookupWorkerResultAddressId:
      type: string
      description: ID of the address in the Storage or Data Mirror.
      example: '1'
    SingleLookupResult:
      type: object
      description: Lookup result for a Single Business Partner.
      properties:
        businessPartnerLookupResult:
          $ref: '#/components/schemas/BusinessPartnerLookupResult'
    OverlapProcessingLogResultPage:
      type: object
      description: Page of Overlap Processing Log Results with search results.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        from:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result since when
            data was created.
          example: '2025-10-07T05:40:40Z'
        to:
          type: string
          description: >-
            ISO 8601 representation of the timestamp when the result until when
            data was created.
          example: '2025-10-07T05:40:40Z'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Overlap Processing Log Results.
          items:
            $ref: '#/components/schemas/OverlapProcessingLogResult'
    OverlapProcessingLogResult:
      type: object
      description: Allows to search for and find specific Overlap Processing Log Results.
      properties:
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        status:
          type: string
          default: OK
          description: OK or FAILED.
          example: OK
        message:
          type: string
          description: Additional explanations for status - especially for the FAILED case.
          example: >-
            Input data is not representing a Business Partner. Reason: Unallowed
            pattern detected.
        lookupResult:
          $ref: '#/components/schemas/BusinessPartnerLookupResult'
        executedAt:
          $ref: '#/components/schemas/ExecutedAt'
        configuration:
          $ref: '#/components/schemas/ProcessingLogConfiguration'
    ProcessingLogConfiguration:
      type: object
      description: Configuration used for Lookup
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        version:
          $ref: '#/components/schemas/ConfigurationVersion'
    ExecutedAt:
      type: string
      description: >-
        ISO 8601 representation of the timestamp when the result data was
        created.
      example: '2025-10-07T05:40:40Z'
    ProcessingLogResultsReadFeatureEnum:
      type: string
      description: Processing log results read feature.
      example: FILTER_BY_ENABLED_AUGMENTATION_MONITORS
      enum:
        - FILTER_BY_ENABLED_AUGMENTATION_MONITORS
        - NUMBER_OF_TOTAL
        - SHOW_LOOKUP_RESULTS
      x-enumDescription:
        FILTER_BY_ENABLED_AUGMENTATION_MONITORS: >-
          Filters out results by enabled, existing data sources of augmentation
          monitors. By default, turned on.
        NUMBER_OF_TOTAL: >-
          Allows to switch fetching the total number of results to improve
          performance. By default, turned off.
        SHOW_LOOKUP_RESULTS: >-
          Allows to include lookup results in the response. By default, turned
          off.
    LookupMatchingClassification:
      type: object
      description: Matching classifications configuration.
      required:
        - countryScope
        - businessPartnerThreshold
        - addressThreshold
      properties:
        countryScope:
          $ref: '#/components/schemas/LookupMatchingClassificationCountryScope'
        businessPartnerThreshold:
          $ref: '#/components/schemas/LookupMatchingClassificationThresholds'
        addressThreshold:
          $ref: '#/components/schemas/LookupMatchingClassificationThresholds'
    LookupMatchingClassificationCountryScope:
      type: object
      description: Matching classification countries scope.
      properties:
        shortNames:
          type: array
          items:
            $ref: '#/components/schemas/CountryShortName'
    LookupMatchingClassificationThresholds:
      type: object
      description: Matching classification thresholds.
      required:
        - fullMatch
        - maybeMatch
      properties:
        fullMatch:
          $ref: '#/components/schemas/LookupMatchingClassificationThreshold'
        maybeMatch:
          $ref: '#/components/schemas/LookupMatchingClassificationThreshold'
    LookupMatchingClassificationThreshold:
      description: Matching classification threshold.
      example: 0.75
      minimum: 0
      maximum: 1
      type: number
      format: double
    BusinessPartnerFeatures:
      type: string
      description: >
        Feature to be used in the Business Partner lookup. 


        All of DNB related features are not exclusive, so they can be used
        together. 

        For example if both `ACTIVATE_DATASOURCE_DNB` and
        `ACTIVATE_DATASOURCE_DNB_MASTER_DATA_EXTENDED` are used, two lookups
        will be made, one with DNB and one with DNB.MASTER.DATA.EXTENDED
        credentials.
      example: ACTIVATE_DATASOURCE_BVD
      enum:
        - ACTIVATE_IDENTIFIER_ONLY_MATCH
        - ACTIVATE_DATASOURCE_STORAGES
        - ACTIVATE_DATASOURCE_GOOGLEPLACES
        - ACTIVATE_DATASOURCE_ZEFIX
        - ACTIVATE_DATASOURCE_NLBR
        - ACTIVATE_DATASOURCE_CDL
        - ACTIVATE_DATASOURCE_DNB
        - ACTIVATE_DATASOURCE_DNB_MASTER_DATA_BASIC
        - ACTIVATE_DATASOURCE_DNB_MASTER_DATA_EXTENDED
        - ACTIVATE_DATASOURCE_DNB_MASTER_DATA_MGMT
        - ACTIVATE_DATASOURCE_DNB_MASTER_DATA_LNKG
        - ACTIVATE_DATASOURCE_BZST
        - ACTIVATE_DATASOURCE_VIES_FOR_ES
        - ACTIVATE_DATASOURCE_BVD
        - ACTIVATE_DATASOURCE_FR_SIRENE
        - ENABLE_IDENTIFIER_DERIVATION
        - ENABLE_TRANSLITERATION_MATCHING
        - FORCE_EXTERNAL_CALL
        - MATCHING_SCORE_CALCULATION
        - LAB_ALLOW_BIG_CANDIDATES
        - LAB_ALLOW_LONG_EXTERNAL_CALLS
        - LAB_PREFIX_QUERY
        - SHOW_DEBUG_INFO
        - SHOW_FORMATTED_ADDRESS
        - SHOW_FORMATTED_SAP_RECORD
        - SHOW_GOLDENRECORD_STANDARD
        - SHOW_GOLDENRECORD_QUICK
        - GOLDENRECORD_INLINE
        - GOLDENRECORD_INLINE_SORTED
        - SHOW_INCOMPLETE_CANDIDATES
        - SHOW_REGISTERED_INDIVIDUAL
        - SHOW_SUBSCRIPTION_METADATA
        - FORCE_DATA_SOURCES_INTERSECTION
        - ACTIVATE_MASTER_DATA_BASIC_BVD
        - ACTIVATE_MASTER_DATA_EXTENDED_BVD
        - ACTIVATE_FINANCIAL_RISK_DATA_BVD
        - ACTIVATE_OWNERSHIP_DATA_BVD
      title: businessPartnerFeaturesDescription
      x-enumDescriptions:
        ACTIVATE_IDENTIFIER_ONLY_MATCH: >-
          Executes lookup based only on identifier. Company names and addresses
          will not affect results.
        ACTIVATE_DATASOURCE_CDQ_POOL: >-
          Add results from CDQ Data Sharing Community Data Pool to the lookup
          results.
        ACTIVATE_DATASOURCE_CDL: '**DEPRECATED** Please use ACTIVATE_DATASOURCE_CDQ_POOL instead'
        ACTIVATE_DATASOURCE_BZST: dd results from Bzst to the lookup results.
        ACTIVATE_DATASOURCE_VIES_FOR_ES: Use VIES to check for data correctness (only for spanish records).
        ACTIVATE_DATASOURCE_GOOGLEPLACES: Add results from Google Places to the lookup results.
        ACTIVATE_DATASOURCE_STORAGES: Add results from organizational data mirrors to the lookup results.
        ACTIVATE_DATASOURCE_DNB: >-
          Activate lookup in DNB. If used, DNB data source credentials will be
          used for lookup.
        ACTIVATE_DATASOURCE_DNB_MASTER_DATA_BASIC: >-
          Activate lookup in DNB. If used, DNB.MASTER.DATA.BASIC credentials
          will be used for lookup.
        ACTIVATE_DATASOURCE_DNB_MASTER_DATA_EXTENDED: >-
          Activate lookup in DNB. If used, DNB.MASTER.DATA.EXTENDED credentials
          will be used for lookup.
        ACTIVATE_DATASOURCE_DNB_MASTER_DATA_MGMT: >-
          Activate lookup in DNB. If used, DNB.MASTER.DATA.MGMT credentials will
          be used for lookup.
        ACTIVATE_DATASOURCE_DNB_MASTER_DATA_LNKG: >-
          Activate lookup in DNB. If used, DNB.MASTER.DATA.LNKG credentials will
          be used for lookup.
        ACTIVATE_DATASOURCE_BVD: Add results from BVD to the lookup results.
        ACTIVATE_DATASOURCE_NLBR: >-
          Add results from the Netherlands Company Register
          [NL.BR](https://developers.kvk.nl/documentation/search-v2) to the
          lookup results. Works only when in organization setting the NL.BR
          credentials are provided.
        ACTIVATE_DATASOURCE_ZEFIX: >-
          Add results from the Swiss Business Partner register
          [Zefix](https://zefix.ch).
        ENABLE_IDENTIFIER_DERIVATION: Use fuzzy matching when searching with identifiers.
        ENABLE_TRANSLITERATION_MATCHING: Uses transliteration during matching process
        FORCE_EXTERNAL_CALL: >-
          Call external service even when results from data mirrors are
          available.
        MATCHING_SCORE_CALCULATION: Calculate matching score. Active by default.
        SHOW_DEBUG_INFO: >-
          Show additional information regarding request processing, including
          enabled features, request, request after curation procedure and
          responses from external services.
        SHOW_FORMATTED_ADDRESS: Formats addresses using data curation procedure.
        SHOW_FORMATTED_SAP_RECORD: Show formatted sap records in the lookup response.
        SHOW_GOLDENRECORD_STANDARD: Calculate golden record for given request.
        SHOW_GOLDENRECORD_QUICK: >-
          Calculate golden record for given request without performing
          enrichment.
        GOLDENRECORD_INLINE: Includes golden record at first position in array of values
        GOLDENRECORD_INLINE_SORTED: Includes golden record in values array in response
        SHOW_INCOMPLETE_CANDIDATES: Do not filter out search results without complete address data.
        SHOW_REGISTERED_INDIVIDUAL: Show individual personas registered in company registers.
        SHOW_SUBSCRIPTION_METADATA: >-
          Provide information whether current user is subscribed to given
          business partner, and overall subscription count.
        FORCE_DATA_SOURCES_INTERSECTION: >-
          If used with augmentation configuration and data sources are provided
          in the request, lookup will be performed using the intersection of
          data sources from request and configuration
        ACTIVATE_MASTER_DATA_BASIC_BVD: Returns Master Data Basic from BvD
        ACTIVATE_MASTER_DATA_EXTENDED_BVD: Returns Master Data Extended from BvD
        ACTIVATE_FINANCIAL_RISK_DATA_BVD: Returns Financial Risk Data from BvD
        ACTIVATE_OWNERSHIP_DATA_BVD: Returns Ownership Data from BvD
    IdentifierTypeTechnicalKey:
      type: string
      description: >-
        Allowed types are documented
        [here](https://meta.cdq.com/Category:Business_partner/identifier/type)
        under Technical Key property.
      example: ABN_AU
      enum:
        - ABN_AU
        - AD_FI_CODE
        - AE_BRN
        - AE_CCN
        - AL_BRN
        - AL_COC
        - AL_GGN
        - AL_TRN
        - AM_COC
        - AM_GGN
        - AM_TRN
        - AO_BRN
        - AR_AGENT_NO
        - AR_CUIT
        - AR_IATAIN
        - AR_NIP
        - AR_PGRTN
        - AR_SEN
        - AR_UTIK
        - AT_ARN
        - AT_TRN
        - AZ_CCN
        - AZ_GGN
        - AZ_TRN
        - BA_COC
        - BA_GGN
        - BA_TRN
        - BD_CIN
        - BD_TIN
        - BE_ARN
        - BE_BUN
        - BE_ENT_NO
        - BE_VAT_ID
        - BF_BRN
        - BG_CCN
        - BG_GGN
        - BG_SEC_ID
        - BG_TAX_ID
        - BG_UID
        - BH_BRN
        - BH_CCN
        - BIC_FI
        - BI_BRN
        - BI_US_AK
        - BI_US_CO
        - BJ_BRN
        - BN_CA
        - BN_TIN
        - BR_CNPJ
        - BR_CPF
        - BR_GRT
        - BR_ID_AT
        - BR_TAX_MUN
        - BR_TAX_STATE
        - BTW_NUMBER
        - BT_TIN
        - BUSINESS_REGISTER_ID
        - BW_BRN
        - BY_BRN
        - BY_COC
        - BY_GGN
        - BY_TRN
        - CDN_US_FL
        - CF_BRN
        - CG_BRN
        - CH_UID
        - CH_VAT_ID
        - CID_NY_US
        - CIF_ES
        - CIK_US
        - CL_RUT
        - CM_BRN
        - CM_CCN
        - CM_TRN
        - CN_BRN
        - CN_IE
        - CN_JP
        - CN_US_IA
        - CN_VAT_15
        - CN_VAT_18
        - CO_NIT
        - CR_TRN
        - CX_BPN
        - CVR_DK
        - CV_BRN
        - CY_CCN
        - CY_GGN
        - CY_TRN
        - CZ_CBN
        - CZ_DIC
        - CZ_ICO
        - CZ_TRN
        - DE_BNUM
        - DE_TAX_ID
        - DJ_BRN
        - DUNS_ID
        - DZ_BRN
        - DZ_CCN
        - EE_BRN
        - EE_COC
        - EE_GGN
        - EE_TRN
        - EG_BRN
        - EG_CCN
        - EG_TRN
        - EORI
        - ES_NIE
        - ES_NIF
        - ET_BRN
        - EU_VAT_ID_AT
        - EU_VAT_ID_BE
        - EU_VAT_ID_BG
        - EU_VAT_ID_CY
        - EU_VAT_ID_CZ
        - EU_VAT_ID_DE
        - EU_VAT_ID_DK
        - EU_VAT_ID_EE
        - EU_VAT_ID_EL
        - EU_VAT_ID_ES
        - EU_VAT_ID_FI
        - EU_VAT_ID_FR
        - EU_VAT_ID_HR
        - EU_VAT_ID_HU
        - EU_VAT_ID_IE
        - EU_VAT_ID_IT
        - EU_VAT_ID_LT
        - EU_VAT_ID_LU
        - EU_VAT_ID_LV
        - EU_VAT_ID_MT
        - EU_VAT_ID_NL
        - EU_VAT_ID_PL
        - EU_VAT_ID_PT
        - EU_VAT_ID_RO
        - EU_VAT_ID_SE
        - EU_VAT_ID_SI
        - EU_VAT_ID_SK
        - EU_VAT_ID_UK
        - FID_US_WY
        - FR_CCN
        - FR_SIREN
        - FR_SIRET
        - GA_CCN
        - GA_TRN
        - GE_BRN
        - GE_COC
        - GE_GGN
        - GE_TRN
        - GH_BRN
        - GH_TRN
        - GI_BRN
        - GI_CCN
        - GI_GGN
        - GI_TRN
        - GM_BRN
        - GN_BRN
        - GQ_BRN
        - GR_AFM
        - GR_BRN
        - GR_COC
        - GR_GGN
        - GR_PERS_ID
        - GR_TRN
        - GS1_GLN
        - GST_CA
        - GST_MY
        - HN_NTRN
        - HR_BRN
        - HR_COC
        - HR_COMP_ID
        - HR_GGN
        - HR_TRN
        - HST_CA
        - HU_TAX_ID
        - HU_TIN
        - ID_CRN
        - ID_NL_OB
        - ID_TIN
        - ID_TVA_FR
        - ID_TVA_LU
        - ID_UTR
        - ID_VAT_UK
        - IN_CIN
        - IN_DOCR
        - IN_GST
        - IN_LBT
        - IN_LSN
        - IN_MOEDU
        - IN_PAN
        - IN_SEC
        - IN_SERVICE_TAX_ID
        - IN_SRN
        - IQ_BRN
        - IR_CCN
        - IS_BRN
        - IS_CCN
        - IS_GGN
        - IT_FISC_ID
        - IT_VAT_ID
        - JO_CCN
        - KE_BRN
        - KG_BRN
        - KG_COC
        - KH_BRN
        - KH_TIN
        - KM_BRN
        - KR_CORP_ID
        - KR_CRBN
        - KR_VAT_ID
        - KVK_NL
        - KW_BRN
        - KW_CCN
        - KZ_BRN
        - KZ_CCN
        - KZ_GGN
        - KZ_TRN
        - LA_TIN
        - LB_BRN
        - LB_CCN
        - LEI_ID
        - LIN_US_SA
        - LK_TIN
        - LR_BRN
        - LS_BRN
        - LT_BRN
        - LT_COC
        - LT_GGN
        - LT_TRN
        - LV_GGN
        - LV_TRN
        - MA_BRN
        - MA_CCN
        - MA_TRN
        - MD_BRN
        - MD_COC
        - MD_GGN
        - MD_TRN
        - ME_GGN
        - ME_TRN
        - MG_BRN
        - MK_BRN
        - MK_COC
        - MK_GGN
        - MK_TRN
        - ML_BRN
        - MM_TIN
        - MR_BRN
        - MT_BRN
        - MT_COC
        - MT_GGN
        - MT_TRN
        - MU_BRN
        - MU_TRN
        - MV_TIN
        - MW_BRN
        - MX_CURP
        - MX_FTRN
        - MX_RFC
        - MY_BRN
        - MZ_BRN
        - NA_BRN
        - NE_BRN
        - NG_BRN
        - NL_SI_ID
        - NL_TAX_ID
        - NP_TIN
        - OM_BRN
        - OM_CCN
        - PE_RUC
        - PH_TAX_ID
        - PK_TIN
        - PT_NIF
        - PL_NIP
        - PL_REG
        - PL_TAX_ID
        - PST_CA
        - PT_CCN
        - PY_UTR
        - QA_BRN
        - QA_CCN
        - RN_US_OR
        - RO_BRN
        - RO_CCN
        - RO_GGN
        - RO_TAX_ID
        - RSIN_NL
        - RS_BRN
        - RU_INN
        - RU_KPP
        - RU_OFK
        - RU_OKPO
        - RW_BRN
        - SA_BRN
        - SA_CCN
        - SC_BRN
        - SC_CCN
        - SD_BRN
        - SE_BRN
        - SE_ORG_ID
        - SI_BRN
        - SI_CCN
        - SI_GGN
        - SI_TAX_ID
        - SK_DIC
        - SK_ICO
        - SK_TRN
        - SL_BRN
        - SN_BRN
        - SN_CCN
        - SN_TRN
        - SO_BRN
        - SPOR_ORG_ID
        - SPOR_LOC_ID
        - SZ_BRN
        - TD_BRN
        - TG_BRN
        - TH_PERS_ID
        - TH_TAX_ID
        - TJ_BRN
        - TJ_COC
        - TJ_GGN
        - TJ_TRN
        - TL_TIN
        - TM_BRN
        - TM_COC
        - TM_TRN
        - TR_BRN
        - TR_CCN
        - TR_GGN
        - TR_TAX_ID
        - TR_TAX_OFFICE_ID
        - TT_TIN
        - TW_BRN
        - TW_GUID
        - TW_TAX_ID
        - TZ_BRN
        - UA_BRN
        - UA_CCN
        - UA_GGN
        - UA_TAX_ID
        - UA_USREOU
        - UBI_US_WS
        - UG_BRN
        - UK_IN_ID
        - UK_VAT_ID
        - US_BRN
        - US_EMPL_ID
        - US_FTIN
        - US_SEC_ID
        - UZ_BRN
        - UZ_COC
        - UZ_GGN
        - UZ_TRN
        - VEN_NL
        - VE_NIT
        - VE_RIF
        - VN_BRN
        - VN_TIN
        - WR_BSC
        - WR_BTRN
        - WR_CAGE
        - WR_CINS
        - WR_CUSIP
        - WR_MIN
        - XK_BRN
        - XK_GGN
        - YE_BRN
        - YE_CCN
        - ZA_TIN
        - ZM_BRN
        - ZW_BRN
        - ZW_COC
        - ZW_GGN
        - ZW_TRN
      x-enumDescriptions:
        ABN_AU: Australian Business Number.
        AD_FI_CODE: Finnish Company Registration Number.
        AE_BRN: United Arab Emirates Business Registration Number.
        AE_CCN: United Arab Emirates Chamber of Commerce Number.
        AL_BRN: Albanian Business Registration Number.
        AL_COC: Albanian Certificate of Incorporation.
        AL_GGN: Albanian General Government Number.
        AL_TRN: Albanian Tax Registration Number.
        AM_COC: Armenian Certificate of Incorporation.
        AM_GGN: Armenian General Government Number.
        AM_TRN: Armenian Tax Registration Number.
        AO_BRN: Angolan Business Registration Number.
        AR_AGENT_NO: Argentine Agent Number.
        AR_CUIT: Argentine Tax Identification Code.
        AR_IATAIN: Argentine IATA Number.
        AR_NIP: Argentine National Identification Number.
        AR_PGRTN: Argentine Registration Number.
        AR_SEN: Argentine Social Security Number.
        AR_UTIK: Argentine Tax Identification Code.
        AT_ARN: Austrian Registration Number.
        AT_TRN: Austrian Tax Registration Number.
        AZ_CCN: Azerbaijani Chamber of Commerce Number.
        AZ_GGN: Azerbaijani General Government Number.
        AZ_TRN: Azerbaijani Tax Registration Number.
        BA_COC: Bosnian Certificate of Incorporation.
        BA_GGN: Bosnian General Government Number.
        BA_TRN: Bosnian Tax Registration Number.
        BD_CIN: Bangladeshi Company Identification Number.
        BD_TIN: Bangladeshi Tax Identification Number.
        BE_ARN: Belgian Registration Number.
        BE_BUN: Belgian Business Number.
        BE_ENT_NO: Belgian Enterprise Number.
        BE_VAT_ID: Belgian VAT Identification Number.
        BF_BRN: Burkinabe Business Registration Number.
        BG_CCN: Bulgarian Chamber of Commerce Number.
        BG_GGN: Bulgarian General Government Number.
        BG_SEC_ID: Bulgarian Securities Identification Code.
        BG_TAX_ID: Bulgarian Tax Identification Number.
        BG_UID: Bulgarian Unique Identification Number.
        BH_BRN: Bahraini Business Registration Number.
        BH_CCN: Bahraini Chamber of Commerce Number.
        BIC_FI: Finnish Business Identity Code.
        BI_BRN: Burundian Business Registration Number.
        BI_US_AK: US Alaska Business Entity Report.
        BI_US_CO: US Colorado Business Entity Report.
        BJ_BRN: Beninese Business Registration Number.
        BN_CA: Canadian Business Number.
        BN_TIN: Bruneian Tax Identification Number.
        BR_CNPJ: Brazilian Corporate Taxpayer's Registry.
        BR_CPF: Brazilian Individual Taxpayer's Registry.
        BR_GRT: Brazilian State Registration Number.
        BR_ID_AT: Brazilian State Registration Number.
        BR_TAX_MUN: Brazilian Municipal Tax Number.
        BR_TAX_STATE: Brazilian State Tax Number.
        BTW_NUMBER: Belgian VAT Identification Number.
        BT_TIN: Bhutanese Tax Identification Number.
        BUSINESS_REGISTER_ID: Business Register ID.
        BW_BRN: Botswanan Business Registration Number.
        BY_BRN: Belarusian Business Registration Number.
        BY_COC: Belarusian Certificate of Incorporation.
        BY_GGN: Belarusian General Government Number.
        BY_TRN: Belarusian Tax Registration Number.
        CDN_US_FL: Canadian US Federal Corporation Number.
        CF_BRN: Central African Republic Business Registration Number.
        CG_BRN: Congolese Business Registration Number.
        CH_UID: >-
          Swiss UID (Unternehmens-Identifikationsnummer/Numéro d'identification
          des entreprises).
        CH_VAT_ID: Swiss VAT Identification Number.
        CID_NY_US: US Central Index Key (CIK) assigned by the SEC in New York.
        CIF_ES: Spanish Tax Identification Code (CIF/NIF).
        CIK_US: US Central Index Key (CIK) assigned by the SEC.
        CL_RUT: Chilean Tax Identification Number (Rol Único Tributario).
        CM_BRN: Cameroonian Business Registration Number.
        CM_CCN: Cameroonian Chamber of Commerce Number.
        CM_TRN: Cameroonian Tax Registration Number.
        CN_BRN: Chinese Business Registration Number.
        CN_IE: Chinese Importer/Exporter Code.
        CN_JP: Chinese Juridical Person Code.
        CN_US_IA: US Iowa Business Entity Report.
        CN_VAT_15: Chinese VAT Registration Number (Standard rate).
        CN_VAT_18: Chinese VAT Registration Number (Reduced rate).
        CO_NIT: >-
          Colombian Tax Identification Number (Número de Identificación
          Tributaria).
        CR_TRN: Costa Rican Tax Registration Number.
        CX_BPN: Christmas Island Business Partner Number.
        CVR_DK: Danish CVR Number.
        CV_BRN: Cape Verdean Business Registration Number.
        CY_CCN: Cypriot Chamber of Commerce Number.
        CY_GGN: Cypriot General Government Number.
        CY_TRN: Cypriot Tax Registration Number.
        CZ_CBN: Czech Business Number.
        CZ_DIC: Czech Identification Number.
        CZ_ICO: Czech Business Identification Number.
        CZ_TRN: Czech Tax Registration Number.
        DE_BNUM: German Business Number.
        DE_TAX_ID: German Tax Identification Number.
        DJ_BRN: Djiboutian Business Registration Number.
        DUNS_ID: Dun & Bradstreet D-U-N-S Number.
        DZ_BRN: Algerian Business Registration Number.
        DZ_CCN: Algerian Chamber of Commerce Number.
        EE_BRN: Estonian Business Registration Number.
        EE_COC: Estonian Certificate of Incorporation.
        EE_GGN: Estonian General Government Number.
        EE_TRN: Estonian Tax Registration Number.
        EG_BRN: Egyptian Business Registration Number.
        EG_CCN: Egyptian Chamber of Commerce Number.
        EG_TRN: Egyptian Tax Registration Number.
        EORI: Economic Operators Registration and Identification.
        ES_NIE: >-
          Spanish Foreigner Identification Number (Número de Identificación de
          Extranjero).
        ES_NIF: Spanish Tax Identification Number (Número de Identificación Fiscal).
        ET_BRN: Ethiopian Business Registration Number.
        EU_VAT_ID_AT: European Union VAT Identification Number (Austria).
        EU_VAT_ID_BE: European Union VAT Identification Number (Belgium).
        EU_VAT_ID_BG: European Union VAT Identification Number (Bulgaria).
        EU_VAT_ID_CY: European Union VAT Identification Number (Cyprus).
        EU_VAT_ID_CZ: European Union VAT Identification Number (Czech Republic).
        EU_VAT_ID_DE: European Union VAT Identification Number (Germany).
        EU_VAT_ID_DK: European Union VAT Identification Number (Denmark).
        EU_VAT_ID_EE: European Union VAT Identification Number (Estonia).
        EU_VAT_ID_EL: European Union VAT Identification Number (Greece).
        EU_VAT_ID_ES: European Union VAT Identification Number (Spain).
        EU_VAT_ID_FI: European Union VAT Identification Number (Finland).
        EU_VAT_ID_FR: European Union VAT Identification Number (France).
        EU_VAT_ID_HR: European Union VAT Identification Number (Croatia).
        EU_VAT_ID_HU: European Union VAT Identification Number (Hungary).
        EU_VAT_ID_IE: European Union VAT Identification Number (Ireland).
        EU_VAT_ID_IT: European Union VAT Identification Number (Italy).
        EU_VAT_ID_LT: European Union VAT Identification Number (Lithuania).
        EU_VAT_ID_LU: European Union VAT Identification Number (Luxembourg).
        EU_VAT_ID_LV: European Union VAT Identification Number (Latvia).
        EU_VAT_ID_MT: European Union VAT Identification Number (Malta).
        EU_VAT_ID_NL: European Union VAT Identification Number (Netherlands).
        EU_VAT_ID_PL: European Union VAT Identification Number (Poland).
        EU_VAT_ID_PT: European Union VAT Identification Number (Portugal).
        EU_VAT_ID_RO: European Union VAT Identification Number (Romania).
        EU_VAT_ID_SE: European Union VAT Identification Number (Sweden).
        EU_VAT_ID_SI: European Union VAT Identification Number (Slovenia).
        EU_VAT_ID_SK: European Union VAT Identification Number (Slovakia).
        EU_VAT_ID_UK: European Union VAT Identification Number (United Kingdom).
        FID_US_WY: US Wyoming Business Entity Report.
        FR_CCN: French Chamber of Commerce Number.
        FR_SIREN: French Business Registration Number (SIREN).
        FR_SIRET: French Business Identification Number (SIRET).
        GA_CCN: Gabonese Chamber of Commerce Number.
        GA_TRN: Gabonese Tax Registration Number.
        GE_BRN: Georgian Business Registration Number.
        GE_COC: Georgian Certificate of Incorporation.
        GE_GGN: Georgian General Government Number.
        GE_TRN: Georgian Tax Registration Number.
        GH_BRN: Ghanaian Business Registration Number.
        GH_TRN: Ghanaian Tax Registration Number.
        GI_BRN: Gibraltar Business Registration Number.
        GI_CCN: Gibraltar Chamber of Commerce Number.
        GI_GGN: Gibraltar General Government Number.
        GI_TRN: Gibraltar Tax Registration Number.
        GM_BRN: Gambian Business Registration Number.
        GN_BRN: Guinean Business Registration Number.
        GQ_BRN: Equatorial Guinean Business Registration Number.
        GR_AFM: Greek Tax Identification Number (AFM).
        GR_BRN: Greek Business Registration Number.
        GR_COC: Greek Certificate of Incorporation.
        GR_GGN: Greek General Government Number.
        GR_PERS_ID: Greek Personal Identification Number.
        GR_TRN: Greek Tax Registration Number.
        GST_CA: Canadian Goods and Services Tax Number.
        GST_MY: Malaysian Goods and Services Tax Number.
        HN_NTRN: Honduran Tax Registration Number.
        HR_BRN: Croatian Business Registration Number.
        HR_COC: Croatian Certificate of Incorporation.
        HR_COMP_ID: Croatian Company Identification Number.
        HR_GGN: Croatian General Government Number.
        HR_TRN: Croatian Tax Registration Number.
        HST_CA: Canadian Harmonized Sales Tax Number.
        HU_TAX_ID: Hungarian Tax Identification Number.
        HU_TIN: Hungarian Taxpayer Identification Number.
        ID_CRN: Indonesian Company Registration Number.
        ID_NL_OB: Dutch Business Registration Number (Onderhandse Borgstelling).
        ID_TIN: Indonesian Tax Identification Number.
        ID_TVA_FR: French Tax Identification Number.
        ID_TVA_LU: Luxembourgian Tax Identification Number.
        ID_UTR: Indian Unique Transaction Reference.
        ID_VAT_UK: UK Value Added Tax Identification Number.
        IN_CIN: Indian Corporate Identification Number.
        IN_DOCR: Indian Director Identification Number.
        IN_GST: Indian Goods and Services Tax Identification Number.
        IN_LBT: Indian Local Body Tax Number.
        IN_LSN: Indian Labour Identification Number.
        IN_MOEDU: Indian Ministry of Education Number.
        IN_PAN: Indian Permanent Account Number.
        IN_SEC: >-
          Indian Securities and Exchange Board of India (SEBI) Registration
          Number.
        IN_SERVICE_TAX_ID: Indian Service Tax Identification Number.
        IN_SRN: Indian Service Registration Number.
        IQ_BRN: Iraqi Business Registration Number.
        IR_CCN: Iranian Chamber of Commerce Number.
        IS_BRN: Icelandic Business Registration Number.
        IS_CCN: Icelandic Chamber of Commerce Number.
        IS_GGN: Icelandic General Government Number.
        IT_FISC_ID: Italian Fiscal Code (Codice Fiscale).
        IT_VAT_ID: Italian VAT Identification Number.
        JO_CCN: Jordanian Chamber of Commerce Number.
        KE_BRN: Kenyan Business Registration Number.
        KG_BRN: Kyrgyzstani Business Registration Number.
        KG_COC: Kyrgyzstani Certificate of Incorporation.
        KH_BRN: Cambodian Business Registration Number.
        KH_TIN: Cambodian Tax Identification Number.
        KM_BRN: Comorian Business Registration Number.
        KR_CORP_ID: South Korean Corporate Registration Number.
        KR_CRBN: South Korean Business Registration Number.
        KR_VAT_ID: South Korean VAT Identification Number.
        KVK_NL: Dutch Chamber of Commerce Number.
        KW_BRN: Kuwaiti Business Registration Number.
        KW_CCN: Kuwaiti Chamber of Commerce Number.
        KZ_BRN: Kazakhstani Business Registration Number.
        KZ_CCN: Kazakhstani Chamber of Commerce Number.
        KZ_GGN: Kazakhstani General Government Number.
        KZ_TRN: Kazakhstani Tax Registration Number.
        LA_TIN: Laotian Tax Identification Number.
        LB_BRN: Lebanese Business Registration Number.
        LB_CCN: Lebanese Chamber of Commerce Number.
        LEI_ID: Legal Entity Identifier.
        LIN_US_SA: US State of South Carolina Legal Identification Number.
        LK_TIN: Sri Lankan Tax Identification Number.
        LR_BRN: Liberian Business Registration Number.
        LS_BRN: Basotho Business Registration Number.
        LT_BRN: Lithuanian Business Registration Number.
        LT_COC: Lithuanian Certificate of Incorporation.
        LT_GGN: Lithuanian General Government Number.
        LT_TRN: Lithuanian Tax Registration Number.
        LV_GGN: Latvian General Government Number.
        LV_TRN: Latvian Tax Registration Number.
        MA_BRN: Moroccan Business Registration Number.
        MA_CCN: Moroccan Chamber of Commerce Number.
        MA_TRN: Moroccan Tax Registration Number.
        MD_BRN: Moldovan Business Registration Number.
        MD_COC: Moldovan Certificate of Incorporation.
        MD_GGN: Moldovan General Government Number.
        MD_TRN: Moldovan Tax Registration Number.
        ME_GGN: Montenegrin General Government Number.
        ME_TRN: Montenegrin Tax Registration Number.
        MG_BRN: Malagasy Business Registration Number.
        MK_BRN: Macedonian Business Registration Number.
        MK_COC: Macedonian Certificate of Incorporation.
        MK_GGN: Macedonian General Government Number.
        MK_TRN: Macedonian Tax Registration Number.
        ML_BRN: Malian Business Registration Number.
        MM_TIN: Burmese Tax Identification Number.
        MR_BRN: Mauritanian Business Registration Number.
        MT_BRN: Maltese Business Registration Number.
        MT_COC: Maltese Certificate of Incorporation.
        MT_GGN: Maltese General Government Number.
        MT_TRN: Maltese Tax Registration Number.
        MU_BRN: Mauritian Business Registration Number.
        MU_TRN: Mauritian Tax Registration Number.
        MV_TIN: Maldivian Tax Identification Number.
        MW_BRN: Malawian Business Registration Number.
        MX_CURP: Mexican Unique Population Registry Code.
        MX_FTRN: Mexican Federal Taxpayer Registration Number.
        MX_RFC: Mexican Tax Identification Number.
        MY_BRN: Malaysian Business Registration Number.
        MZ_BRN: Mozambican Business Registration Number.
        NA_BRN: Namibian Business Registration Number.
        NE_BRN: Nigerien Business Registration Number.
        NG_BRN: Nigerian Business Registration Number.
        NL_SI_ID: Dutch Social Insurance Identification Number.
        NL_TAX_ID: Dutch Tax Identification Number.
        NP_TIN: Nepalese Tax Identification Number.
        OM_BRN: Omani Business Registration Number.
        OM_CCN: Omani Chamber of Commerce Number.
        PE_RUC: Peruvian Taxpayer Registry Number (Registro Único de Contribuyentes).
        PH_TAX_ID: Philippine Tax Identification Number.
        PK_TIN: Pakistani Tax Identification Number.
        PL_NIP: Polish Tax Identification Number.
        PL_REG: Polish National Court Register Number.
        PL_TAX_ID: Polish Tax Identification Number.
        PST_CA: Canadian Provincial Sales Tax Number.
        PT_CCN: Portuguese Chamber of Commerce Number.
        PT_NIF: Tax Identification Number in Portugal.
        PY_UTR: Paraguayan Tax Identification Number.
        QA_BRN: Qatari Business Registration Number.
        QA_CCN: Qatari Chamber of Commerce Number.
        RN_US_OR: US Oregon Business Entity Report.
        RO_BRN: Romanian Business Registration Number.
        RO_CCN: Romanian Chamber of Commerce Number.
        RO_GGN: Romanian General Government Number.
        RO_TAX_ID: Romanian Tax Identification Number.
        RSIN_NL: Dutch Rechtspersonen en Samenwerkingsverbanden Informatie Nummer.
        RS_BRN: Serbian Business Registration Number.
        RU_INN: Russian Individual Taxpayer Number.
        RU_KPP: Russian KPP (Kod Priezzhego Punkta) Code.
        RU_OFK: Russian OFK (Osnovnoy Federalniy Kod) Code.
        RU_OKPO: >-
          Russian OKPO (Obshchiy Klassifikator Predpriyatiy i Organizatsiy)
          Code.
        RW_BRN: Rwandan Business Registration Number.
        SA_BRN: Saudi Arabian Business Registration Number.
        SA_CCN: Saudi Arabian Chamber of Commerce Number.
        SC_BRN: Seychellois Business Registration Number.
        SC_CCN: Seychellois Chamber of Commerce Number.
        SD_BRN: Sudanese Business Registration Number.
        SE_BRN: Swedish Business Registration Number.
        SE_ORG_ID: Swedish Organizational Number.
        SI_BRN: Slovenian Business Registration Number.
        SI_CCN: Slovenian Chamber of Commerce Number.
        SI_GGN: Slovenian General Government Number.
        SI_TAX_ID: Slovenian Tax Identification Number.
        SK_DIC: Slovak Business Registration Number (IČO).
        SK_ICO: Slovak Identification Number (IČO).
        SK_TRN: Slovak Tax Registration Number.
        SL_BRN: Sierra Leonean Business Registration Number.
        SN_BRN: Senegalese Business Registration Number.
        SN_CCN: Senegalese Chamber of Commerce Number.
        SN_TRN: Senegalese Tax Registration Number.
        SO_BRN: Somalian Business Registration Number.
        SPOR_ORG_ID: Sports Organization Identification Number.
        SPOR_LOC_ID: Sports Location Identification Number.
        SZ_BRN: Swazi Business Registration Number.
        TD_BRN: Chadian Business Registration Number.
        TG_BRN: Togolese Business Registration Number.
        TH_PERS_ID: Thai Personal Identification Number.
        TH_TAX_ID: Thai Tax Identification Number.
        TJ_BRN: Tajikistani Business Registration Number.
        TJ_COC: Tajikistani Certificate of Incorporation.
        TJ_GGN: Tajikistani General Government Number.
        TJ_TRN: Tajikistani Tax Registration Number.
        TL_TIN: Timorese Tax Identification Number.
        TM_BRN: Turkmen Business Registration Number.
        TM_COC: Turkmen Certificate of Incorporation.
        TM_TRN: Turkmen Tax Registration Number.
        TR_BRN: Turkish Business Registration Number.
        TR_CCN: Turkish Chamber of Commerce Number.
        TR_GGN: Turkish General Government Number.
        TR_TAX_ID: Turkish Tax Identification Number.
        TR_TAX_OFFICE_ID: Turkish Tax Office Identification Number.
        TT_TIN: Trinidad and Tobago Tax Identification Number.
        TW_BRN: Taiwanese Business Registration Number.
        TW_GUID: Taiwanese Global Unique Identifier.
        TW_TAX_ID: Taiwanese Tax Identification Number.
        TZ_BRN: Tanzanian Business Registration Number.
        UA_BRN: Ukrainian Business Registration Number.
        UA_CCN: Ukrainian Chamber of Commerce Number.
        UA_GGN: Ukrainian General Government Number.
        UA_TAX_ID: Ukrainian Tax Identification Number.
        UA_USREOU: Ukrainian State Register of Enterprises and Organizations Code.
        UBI_US_WS: US Washington Business Entity Report.
        UG_BRN: Ugandan Business Registration Number.
        UK_IN_ID: UK Individual Identification Number.
        UK_VAT_ID: UK VAT Identification Number.
        US_BRN: US Business Registration Number.
        US_EMPL_ID: US Employer Identification Number (EIN).
        US_FTIN: US Federal Taxpayer Identification Number.
        US_SEC_ID: US Securities and Exchange Commission Identifier.
        UZ_BRN: Uzbek Business Registration Number.
        UZ_COC: Uzbek Certificate of Incorporation.
        UZ_GGN: Uzbek General Government Number.
        UZ_TRN: Uzbek Tax Registration Number.
        VEN_NL: Venezuelan National Identification Number.
        VE_NIT: Venezuelan Tax Identification Number.
        VE_RIF: Venezuelan Taxpayer's Registry Information.
        VN_BRN: Vietnamese Business Registration Number.
        VN_TIN: Vietnamese Tax Identification Number.
        WR_BSC: World Rugby Business Supporter Code.
        WR_BTRN: World Rugby Business Trading Number.
        WR_CAGE: World Rugby Commercial and Government Entity Code.
        WR_CINS: World Rugby Commercial Insurance Number.
        WR_CUSIP: >-
          World Rugby Committee on Uniform Securities Identification Procedures
          Number.
        WR_MIN: World Rugby Manufacturer Identification Number.
        XK_BRN: Kosovar Business Registration Number.
        XK_GGN: Kosovar General Government Number.
        YE_BRN: Yemeni Business Registration Number.
        YE_CCN: Yemeni Chamber of Commerce Number.
        ZA_TIN: South African Tax Identification Number.
        ZM_BRN: Zambian Business Registration Number.
        ZW_BRN: Zimbabwean Business Registration Number.
        ZW_COC: Zimbabwean Certificate of Incorporation.
        ZW_GGN: Zimbabwean General Government Number.
        ZW_TRN: Zimbabwean Tax Registration Number.
    FrRcCedexLookupMatch:
      type: object
      description: French Business Partner found in the Data Mirror with the match.
      properties:
        cedex:
          type: string
          description: >-
            System used in France for the delivery of mail to business customers
            with a large volume of incoming mail.
          example: 64205 CEDEX
        regularPostCode:
          type: string
          description: Regular post code.
          example: '64200'
        locality:
          type: string
          description: Locality.
          example: Biarritz
        companyName:
          type: string
          description: Name of the company.
          example: CDQ AG
        siret:
          type: string
          description: Unique identifier for a business entity in France.
          example: 732 829 320
    SubscriptionMetadata:
      type: object
      description: Metadata of a subscription.
      properties:
        subscribed:
          type: boolean
          description: Indicates if the subscription is subscribed.
          example: 'true'
        numberOfSubscribers:
          type: integer
          description: Number of subscribers.
          example: '50'
    MatchingProfile:
      type: object
      description: >-
        Matching profile used for the match. It contains the matching threshold
        and the matching scores.
      properties:
        matchingScores:
          $ref: '#/components/schemas/MatchingScores'
    MatchingScores:
      type: object
      description: >-
        List of the numerical value of similarity between Business Partners or
        addresses enhanced with the overall score.
      properties:
        overall:
          $ref: '#/components/schemas/MatchingScore'
        businessPartner:
          $ref: '#/components/schemas/MatchingScore'
        address:
          $ref: '#/components/schemas/MatchingScore'
    MatchingScore:
      type: object
      description: >-
        Shows numerical value of similarity between Business Partners or address
        stored in the Data Mirror and the Business Partner from the request.
      properties:
        classification:
          $ref: '#/components/schemas/MatchingClassification'
        value:
          type: number
          description: Matching score value.
          example: '0.9'
        explanation:
          type: string
          description: Explanation for matching score value.
          example: >-
            BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall:
            [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]
    MatchingClassification:
      type: object
      description: >-
        Classification of the matching score. It can be `HIGH`, `MEDIUM` or
        `LOW`.
      properties:
        technicalKey:
          type: string
          description: Technical key of the Matching Classification.
          example: HIGH
        name:
          type: string
          description: Name of the Matching Classification.
          example: My Matching Configuration
    DataSources:
      type: array
      description: >-
        IDs of Data Sources in specified Data Mirror to be included during
        lookup. Leave empty to include all Data Dources.
      items:
        $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
      enum:
        - UNKNOWN
        - CANCELED
        - 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 could not be started.
        RUNNING: Job is being executed.
        FINISHED: Job has finished.
        DIED: Job has died due to unhandled exceptions.
        CANCELED: Job has been canceled due to invalid input configuration.
        FAILED: Job has failed.
    AddDunsRequest:
      type: object
      description: Request to add DUNS numbers.
      properties:
        duns:
          type: array
          description: List of DUNS numbers to add.
          items:
            $ref: '#/components/schemas/Duns'
          minItems: 1
          maxItems: 100
    Duns:
      type: string
      description: >-
        A 9-character numeric string identifying the entity called Data
        Universal Numbering System (DUNS) number.
      example: 15-048-3782
    AddDunsResponse:
      type: object
      description: Response to add DUNS numbers.
      properties:
        dnbResponses:
          type: array
          description: List of DUNS numbers added.
          items:
            $ref: '#/components/schemas/SingleDunsResponse'
    SingleDunsResponse:
      type: object
      description: Response to add a single DUNS number.
      properties:
        duns:
          $ref: '#/components/schemas/Duns'
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        dnbResponse:
          type: object
          description: Response from DNB.
          properties:
            callSucceed:
              $ref: '#/components/schemas/SingleDunsFromRegistrationResponse'
            failed:
              $ref: '#/components/schemas/DnbCallFailed'
    DnbCallFailed:
      type: object
      description: Response from DNB when the call failed.
      properties:
        httpCode:
          type: string
          description: HTTP code.
          example: '400'
        message:
          type: string
          description: Message.
          example: Bad Request
    SingleDunsFromRegistrationResponse:
      type: object
      description: Response from DNB when the call succeeded.
      properties:
        transactionDetail:
          $ref: '#/components/schemas/TransactionDetails'
        information:
          $ref: '#/components/schemas/Information'
    TransactionDetails:
      type: object
      description: The information used to process this request.
      properties:
        transactionID:
          type: string
          description: >-
            A value assigned by the Dun & Bradstreet application to uniquely
            identify this request.
          example: rlh-hi9puyoijk-jop8u-kd-d-1
        transactionTimestamp:
          type: string
          description: >-
            The date and time, in ISO 8601 UTC Z standard, when this response
            was created.
          example: '2025-10-07T05:40:40Z'
        inLanguage:
          type: string
          description: >-
            An IETF BCP 47 code value that defines the language in which this
            product was rendered.
          example: en-US
    Information:
      description: The details of the request.
      type: object
      properties:
        code:
          type: string
          description: >-
            A unique code assigned by Dun & Bradstreet to identify the status of
            this request. See the Error and Information Code list for more
            information.
          example: '99999'
        message:
          type: string
          description: The description assigned to the information code.
          example: A message appropriate to the request outcome.
    DnbLookupJobResultPage:
      type: object
      description: Contains a list of DNB Lookup Job results and pagination information.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of DNB Lookup Job results.
          items:
            $ref: '#/components/schemas/DnbLookupJobItemResult'
    DnbLookupJobItemResult:
      type: object
      description: Contains the result of a DNB Lookup Job.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        addressId:
          type: string
          description: Address ID of the Business Partner.
          example: '0'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        requestData:
          $ref: '#/components/schemas/DnbLookupJobMatchRequestData'
        matchResults:
          type: array
          description: List of DNB Lookup Job match results.
          items:
            $ref: '#/components/schemas/DnbLookupJobMatchResult'
    DnbLookupJobMatchResult:
      type: object
      description: Contains the result of a DNB Lookup Job match.
      properties:
        candidate:
          $ref: '#/components/schemas/DnbModel'
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
    DnbLookupJobMatchRequestData:
      type: object
      description: Contains the request data of a DNB Lookup Job match.
      properties:
        nameLocal:
          type: string
          description: Local name of the Business Partner.
          example: CDQ
        nameInternational:
          type: string
          description: International name of the Business Partner.
          example: CDQ AG
        countryValue:
          $ref: '#/components/schemas/CountryValue'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
        administrativeArea:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        postCodeValue:
          $ref: '#/components/schemas/PostCodeValue'
        localityValue:
          $ref: '#/components/schemas/LocalityValue'
        thoroughfareValue:
          $ref: '#/components/schemas/ThoroughfareValue'
        thoroughfareNumber:
          $ref: '#/components/schemas/ThoroughfareNumber'
        premiseValue:
          $ref: '#/components/schemas/PremiseValue'
        classificationCode:
          $ref: '#/components/schemas/ClassificationCode'
        classificationTypeName:
          $ref: '#/components/schemas/ClassificationTypeName'
        classificationName:
          $ref: '#/components/schemas/ClassificationValue'
        careOf:
          $ref: '#/components/schemas/CareOfValue'
        addressTypes:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
        isInactive:
          type: string
          description: Indicates whether the Business Partner is inactive.
          example: Inactive
        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'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        duns:
          type: string
          description: DUNS number of the record to be fetched.
          example: 15-048-3782
    DnbLookupJob:
      type: object
      description: Lookup Job for D&B data.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        status:
          $ref: '#/components/schemas/JobStatus'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        progress:
          $ref: '#/components/schemas/JobProgress'
        result:
          $ref: '#/components/schemas/DnbLookupJobResult'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
    DnbLookupJobResult:
      type: object
      description: Lookup Job result for D&B data.
      properties:
        statistics:
          $ref: '#/components/schemas/DnbLookupJobStatistics'
    DnbLookupJobStatistics:
      type: object
      description: >-
        Contains statistics about a DNB lookup job like number of records,
        number of failed records, etc.
      properties:
        numberOfRecords:
          type: integer
          format: int64
          description: Number of records in the input storage.
          example: '10'
        numberOfFailed:
          type: integer
          format: int64
          description: Number of records updates / retrieves fails.
          example: '0'
        numberOfInserts:
          type: integer
          format: int64
          description: Number of successfully retrieved data.
          example: '10'
        numberOfQuotaExceeded:
          type: integer
          format: int64
          description: Number of not processed records which exceeded defined quota limit.
          example: '10'
        numberOfUnknown:
          type: integer
          format: int64
          description: Number of non-retrieved records from DNB service.
          example: '0'
    DnbLookupJobFeature:
      type: string
      description: Modifies behavior of a D&B Lookup Job.
      example: INCREMENT
      enum:
        - INCREMENT
        - ENABLE_PARTIAL_QUOTA_CONSUMPTION
        - ACTIVATE_MASTER_DATA_EXTENDED
        - SKIP_DNB_IMPORT
        - ENRICH_COMMERCIAL_ULTIMATE
      x-enumDescriptions:
        INCREMENT: >-
          Continue processing after the last processed result with a goal to run
          on newly created business partners from a storage.
        ENABLE_PARTIAL_QUOTA_CONSUMPTION: >-
          Enables to run import job on a remaining quota when full quota not
          available.
        ACTIVATE_MASTER_DATA_EXTENDED: >-
          Enables to use data blocks instead of cmplek when fetching data from
          DNB.
        SKIP_DNB_IMPORT: >-
          If it is not used, all DUNS will be fetched from DNB. Should be used
          in combination with ENRICH_COMMERCIAL_ULTIMATE to only load what is
          needed for commercial ultimate calculation.
        ENRICH_COMMERCIAL_ULTIMATE: Calculate commercial ultimate for each business partner in storage.
    DnbLookupJobRequest:
      type: object
      description: Parameters for a D&B Lookup Job.
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dnbUser:
          type: string
          description: >-
            Optional if credentials are available in user or organization
            settings.
          example: myDnbUser
        dnbPassword:
          type: string
          description: >-
            Optional if credentials are available in user or organization
            settings.
          example: myDnbPassword
        mode:
          type: string
          description: >-
            MATCH contains just the match results while EXTENDED_MATCH also
            includes D&B products (attention increased costs)
          example: EXTENDED_MATCH
          enum:
            - EXTENDED_MATCH
            - MATCH
          x-enumDEscriptions:
            EXTENDED_MATCH: >-
              MATCH contains just the match results while EXTENDED_MATCH also
              includes D&B products (attention increased costs)
            MATCH: >-
              MATCH contains just the match results while EXTENDED_MATCH also
              includes D&B products (attention increased costs)
        featuresOn:
          type: array
          description: List of features to be activated in the lookup.
          items:
            $ref: '#/components/schemas/DnbLookupJobFeature'
        featuresOff:
          type: array
          description: List of features to be deactivated in the lookup.
          items:
            $ref: '#/components/schemas/DnbLookupJobFeature'
        dnbDataSource:
          type: string
          description: D&B name of the product to be used in the job.
          example: DNB_MASTER_DATA_EXTENDED
          default: DNB
          enum:
            - DNB
            - DNB_MASTER_DATA_BASIC
            - DNB_MASTER_DATA_MGMT
            - DNB_MASTER_DATA_LINKAGE
            - DNB_MASTER_DATA_EXTENDED
            - DNB_LINKAGE_LNKELI
          x-enumDescriptions:
            DNB: D&B Master Data
            DNB_MASTER_DATA_BASIC: D&B Master Data Basic
            DNB_MASTER_DATA_PLUS_MGMT: D&B Master Data Plus Management
            DNB_MASTER_DATA_PLUS_LINKAGE: D&B Master Data Plus Linkage
            DNB_MASTER_DATA_EXTENDED: D&B Master Data Extended
            DNB_LINKAGE_LNKELI: D&B Linkage LNKELI
        dataSources:
          $ref: '#/components/schemas/DataSources'
    KeyValueItem:
      type: object
      description: Containing key/value information
      properties:
        key:
          type: string
          description: Key in the key/value pair.
          example: key
        value:
          type: string
          description: Value in the key/value pair.
          example: value
    AdministrativeAreaResult:
      type: object
      description: A top-level geographical or political area division in a country.
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        shortName:
          $ref: '#/components/schemas/AdministrativeAreaShortName'
        type:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    DnbFetchResult:
      type: object
      description: The result of a D&B fetch.
      properties:
        cmpelkV2:
          $ref: '#/components/schemas/CmpelkV2'
        dataBlock:
          $ref: '#/components/schemas/DataBlock'
        lnkeli:
          $ref: '#/components/schemas/CmpelkV2'
        commercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
        cdqRecord:
          $ref: '#/components/schemas/schemas-BusinessPartner'
        cdqCommercialUltimate:
          $ref: '#/components/schemas/schemas-BusinessPartner'
        legalEntity:
          $ref: '#/components/schemas/DataBlock'
        status:
          type: string
          description: |
            status:
              * `OK` - Service returned a correct response
              * `FAILED` - Call to external service failed
              * `INVALID_INPUT` - Given input parameter is invalid or entry not found
              * `AUTHORIZATION_FAILED` - Authorization to external service does not succeed
              * `EXTERNAL_QUOTA_EXCEEDED` - External service quota is exceeded. Not applies to CDQ quota.
          example: OK
        message:
          type: string
          description: >-
            Message providing additional information about the status of the D&B
            fetch.
          example: Service returned a correct response
        relations:
          type: array
          description: >-
            Contains relations with branch companies, only present when using
            tradeUp option.
          items:
            $ref: '#/components/schemas/BranchRelation'
    BranchRelation:
      type: string
      description: DUNS number.
      example: '123456789'
    DnbFetchRequest:
      type: object
      description: Parameters for D&B Business Partner Fetch.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/DnbFetchFeature'
        featuresOff:
          type: array
          description: List of features to be deactivated.
          items:
            $ref: '#/components/schemas/DnbFetchFeature'
    DnbFetchFeature:
      type: string
      description: Feature to be used in D&B Business Partner Fetch.
      example: ACTIVATE_MASTER_DATA_BASIC
      enum:
        - ACTIVATE_MASTER_DATA_BASIC
        - ACTIVATE_MASTER_DATA_EXTENDED
        - ACTIVATE_MASTER_DATA_MGMT
        - ACTIVATE_MASTER_DATA_LNKG
        - ACTIVATE_LINKAGE_LNKELI
        - ACTIVATE_DATASOURCE_DNB_STORAGE
        - ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY
        - ENRICH_COMMERCIAL_ULTIMATE
        - ENABLE_SETTINGS
        - SHOW_CDQ_RECORD
        - DETECT_LEGAL_ENTITY
        - ENRICH_DOMESTIC_COMMERCIAL_ULTIMATE
      x-enumDescriptions:
        ACTIVATE_MASTER_DATA_BASIC: Use basic set of datablocks to fetch data.
        ACTIVATE_MASTER_DATA_EXTENDED: Use extended set of datablocks to fetch data.
        ACTIVATE_MASTER_DATA_MGMT: Use management set of datablocks to fetch data.
        ACTIVATE_MASTER_DATA_LNKG: Use linkage set of datablocks to fetch data.
        ACTIVATE_LINKAGE_LNKELI: Fetch LNKELI data.
        ACTIVATE_DATASOURCE_DNB_STORAGE: Checks storage and skips call to D&B if results were found.
        ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY: Skips call to D&B entirely and only checks storage for results.
        ENRICH_COMMERCIAL_ULTIMATE: >-
          Uses additional cmpelk calls to load whole organization hierarchy and
          detect global ultimate.
        ENABLE_SETTINGS: Apply rules stored in organizational settings during curation.
        SHOW_CDQ_RECORD: Return also Dnb record mapped to cdq model.
        DETECT_LEGAL_ENTITY: Finds out whether requested DUNS is a branch or headquarter.
        ENRICH_DOMESTIC_COMMERCIAL_ULTIMATE: Calculates Domestic Ultimate hierarchy.
    SupplierGatewayFetchResult:
      type: object
      description: The result of a supplier gateway fetch.
      properties:
        cdqId:
          type: string
          description: The CDQ ID of the supplier gateway.
          example: VIES:DE119267630
        supplierGateway:
          $ref: '#/components/schemas/SupplierGateway'
        minorityIndicator:
          $ref: '#/components/schemas/MinorityIndicator'
    SupplierGateway:
      type: object
      description: |
        A gateway for a supplier. 

        Provides information such as: 
        * status, 
        * contact details, 
        * certifications, 
        * bank information,
        * business categories.
      properties:
        Code:
          type: string
          description: Code representing the status of the supplier gateway.
          example: '200'
        Message:
          type: string
          description: >-
            Message providing additional information about the status of the
            supplier gateway.
          example: Supplier gateway successfully created
        Supplier:
          type: object
          description: Containing details about the supplier.
          properties:
            SupplierNumber:
              type: string
              description: Unique identifier for the supplier.
              example: SUP12345
            TaxID:
              type: string
              description: Tax identification number of the supplier.
              example: 12-3456789
            CompanyName:
              type: string
              description: Name of the supplier company.
              example: Acme Corporation
            ContactName:
              type: string
              description: Name of the contact person at the supplier company.
              example: John Doe
            Address:
              type: string
              description: Address of the supplier company.
              example: 123 Main St, Springfield, IL
            City:
              type: string
              description: City where the supplier company is located.
              example: Springfield
            State:
              type: string
              description: State where the supplier company is located.
              example: IL
            Country:
              type: string
              description: Country where the supplier company is located.
              example: USA
            Zip:
              type: string
              description: Zip code of the supplier company's location.
              example: '62701'
            ZipPlus:
              type: string
              description: Extended Zip code of the supplier company's location.
              example: 62701-1234
            Phone:
              type: string
              description: Contact phone number of the supplier company.
              example: (123) 456-7890
            Fax:
              type: string
              description: Fax number of the supplier company.
              example: (123) 456-7891
            Email:
              type: string
              description: Contact email of the supplier company.
              example: contact@acme.com
            Web:
              type: string
              description: Website of the supplier company.
              example: https://www.acme.com
            Duns:
              type: string
              description: D-U-N-S Number of the supplier company.
              example: 15-048-3782
            yearEstablished:
              type: string
              description: Year when the supplier's company was established.
              example: '2000'
            NumberOfEmployee:
              type: string
              description: Number of employees in the supplier's company.
              example: '100'
            Capability:
              type: string
              description: Capabilities of the supplier's company.
              example: Manufacturing, Distribution
            Status:
              type: string
              description: Current status of the supplier company.
              example: Active
            Acct:
              type: string
              description: Account information of the supplier company.
              example: ACC12345
            LastAct:
              type: string
              description: Last activity recorded for the supplier company.
              example: '2025-10-07T05:40:40Z'
            SBASDB:
              type: string
              description: >-
                Small Business Administration Small Disadvantaged Business
                information for the supplier company.
              example: 'Yes'
            Hub:
              type: string
              description: >-
                Historically Underutilized Business Zones (HUBZone) information
                for the supplier company.
              example: 'Yes'
            HubExp:
              type: string
              description: Expiration date of the HUBZone status for the supplier company.
              example: '2025-10-07T05:40:40Z'
            Validated:
              type: string
              description: Validation status of the supplier company.
              example: 'Yes'
            Preg:
              type: string
              description: Preg information of the supplier company.
              example: PREG12345
            PregStart:
              type: string
              description: Start date of the Preg status for the supplier company.
              example: '2025-10-07T05:40:40Z'
            PregComp:
              type: string
              description: Completion date of the Preg status for the supplier company.
              example: '2025-10-07T05:40:40Z'
            PregStat:
              type: string
              description: Status of the Preg for the supplier company.
              example: Completed
            Mospnd18:
              type: string
              description: Mospnd18 information of the supplier company.
              example: MOSPND12345
            Moamt18:
              type: string
              description: Moamt18 information of the supplier company.
              example: MOAMT12345
            MasterSupplierNo:
              type: string
              description: Master supplier number of the supplier company.
              example: MSUP12345
            Tier2Required:
              type: string
              description: Tier 2 requirements status of the supplier company.
              example: 'Yes'
            Categories:
              type: array
              description: Categories of business the supplier company is involved in.
              items:
                type: object
                description: Details of the category.
                properties:
                  Name:
                    type: string
                    description: Name of the category.
                    example: Manufacturing
                  Abbreviation:
                    type: string
                    description: Abbreviation of the category.
                    example: MFG
            Ethnicities:
              type: array
              description: Ethnicities associated with the supplier company.
              items:
                type: object
                description: Ethnicity object
                properties:
                  Name:
                    type: string
                    description: Name of the ethnicity.
                    example: Hispanic
                  Abbreviation:
                    type: string
                    description: Abbreviation of the ethnicity.
                    example: HISP
            Certifications:
              type: array
              description: Certifications obtained by the supplier company.
              items:
                type: object
                description: Details of the certification.
                properties:
                  Name:
                    type: string
                    description: Name of the certification.
                    example: ISO 9001
                  Abbreviation:
                    type: string
                    description: Abbreviation of the certification.
                    example: ISO9K
                  CertDate:
                    type: string
                    description: Date when the certification was obtained.
                    example: '2025-10-07T05:40:40Z'
                  ExpDate:
                    type: string
                    description: Expiration date of the certification.
                    example: '2025-10-07T05:40:40Z'
                  CertNo:
                    type: string
                    description: Certification number.
                    example: CERT12345
            Banks:
              type: array
              description: Banks associated with the supplier company.
              items:
                type: object
                description: Details of the bank.
                properties:
                  BankName:
                    type: string
                    description: Name of the bank.
                    example: Bank of Springfield
                  AccountType:
                    type: string
                    description: Type of account held at the bank.
                    example: Business Checking
                  AccountNumber:
                    type: string
                    description: Account number at the bank.
                    example: '123456789'
                  RouteNumber:
                    type: string
                    description: Routing number of the bank.
                    example: '987654321'
                  Address:
                    type: string
                    description: Address of the bank.
                    example: 456 Market St, Springfield, IL
                  CityRegion:
                    type: string
                    description: City or region where the bank is located.
                    example: Springfield
                  StateProvince:
                    type: string
                    description: State or province where the bank is located.
                    example: IL
                  PostalCode:
                    type: string
                    description: Postal code of the bank's location.
                    example: '62702'
                  Country:
                    type: string
                    description: Country where the bank is located.
                    example: USA
    SupplierGatewayCreate:
      type: object
      description: |
        Create a record for a supplier gateway.
        Includes details such as: 
        * company name, 
        * address, 
        * contact information, 
        * certifications, 
        * offered products or services.
      properties:
        supplierGateway:
          $ref: '#/components/schemas/SupplierGatewayCreateBody'
    SupplierGatewayCreateBody:
      type: object
      description: Complete body of the Supplier Gateway Record.
      properties:
        CompanyName:
          type: string
          description: Company Name of the Supplier Gateway Record.
          example: Acme Corporation
        EIN:
          type: string
          description: >-
            Employer Identification Number of the Supplier Gateway Record. A
            unique nine-digit number assigned by the Internal Revenue Service.
          example: 12-3456789
        SupplierNumber:
          type: string
          description: Unique number assigned to the supplier.
          example: SUP12345
        Address:
          type: string
          description: Primary address of the supplier.
          example: 123 Main St
        Address2:
          type: string
          description: Secondary address of the supplier.
          example: Suite 100
        City:
          type: string
          description: City of the supplier's address.
          example: Springfield
        State:
          type: string
          description: State of the supplier's address.
          example: IL
        Country:
          type: string
          description: Country of the supplier's address.
          example: USA
        Zip:
          type: string
          description: Zip code of the supplier's address.
          example: '62701'
        ZipPlus:
          type: string
          description: Extended Zip code of the supplier's address.
          example: 62701-1234
        Phone:
          type: string
          description: Contact phone number of the supplier.
          example: (123) 456-7890
        Category:
          type: string
          description: Category of the supplier's business.
          example: Manufacturing
        Ethnicity:
          type: string
          description: Ethnicity classification of the supplier.
          example: Not disclosed
        ContactFirstName:
          type: string
          description: First name of the supplier's contact person.
          example: John
        ContactLastName:
          type: string
          description: Last name of the supplier's contact person.
          example: Doe
        ContactEmail:
          type: string
          description: Email address of the supplier's contact person.
          example: johndoe@example.com
        RequiredtoReport:
          type: string
          description: Indicates if the supplier is required to report certain data.
          example: 'Yes'
        YearEstablished:
          type: string
          description: Year when the supplier's company was established.
          example: '2000'
        NumberOfEmployee:
          type: string
          description: Number of employees in the supplier's company.
          example: '100'
        Capabilities:
          type: string
          description: Capabilities of the supplier's company.
          example: Manufacturing, Distribution
        Duns:
          type: string
          description: D-U-N-S Number of the supplier's company.
          example: 15-048-3782
        Naics:
          type: string
          description: >-
            North American Industry Classification System (NAICS) code of the
            supplier's company.
          example: '541511'
        ProductListing:
          type: string
          description: List of products offered by the supplier's company.
          example: Product A, Product B
        ServiceListing:
          type: string
          description: List of services offered by the supplier's company.
          example: Service X, Service Y
        Certificates:
          type: array
          description: Array of certificates related to the supplier
          items:
            type: object
            description: Certificate object containing details about a specific certificate
            properties:
              CertID:
                type: string
                description: Unique identifier of the certificate
                example: CERT12345
              CertNo:
                type: string
                description: Certificate number
                example: '12345'
              CertifiedDate:
                type: string
                description: Date when the certificate was issued
                example: '2025-10-07T05:40:40Z'
              ExpirationDate:
                type: string
                description: Date when the certificate will expire
                example: '2025-10-07T05:40:40Z'
              Attachments:
                type: object
                description: Attachments related to the certificate
                properties:
                  Title:
                    type: string
                    description: Title of the attachment
                    example: Certificate Document
                  Url:
                    type: string
                    description: URL where the attachment can be accessed
                    example: https://example.com/certificate.pdf
    SupplierGatewayFetchRequest:
      type: object
      description: Parameters for Fetch Supplier Gateway Record.
      properties:
        cdqId:
          type: string
          description: CDQ ID of the supplier gateway record to fetch.
          example: VIES:DE119267630
        supplierNumber:
          type: string
          description: Supplier Number to fetch the Record.
          example: SUP12345
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            type: string
            description: Feature to be activated.
            example: ENRICH_MINORITY_INDICATOR
            enum:
              - ENRICH_MINORITY_INDICATOR
            x-enumDescriptions:
              ENRICH_MINORITY_INDICATOR: Enrich the supplier gateway record with the minority indicator.
    LookupJobId:
      type: string
      deprecated: true
      description: >-
        Use lookupJobId inside reportsConfiguration.lookup.jobId. When provided
        value is copied to reportsConfiguration.lookup.jobId.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    Job:
      type: object
      description: Task executed based on set frequency (bi-weekly, monthly, quartarely).
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        status:
          $ref: '#/components/schemas/schemas-JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        user:
          $ref: '#/components/schemas/JobUser'
        progress:
          $ref: '#/components/schemas/JobProgress'
        attachments:
          type: array
          description: List of attachments for the job.
          items:
            $ref: '#/components/schemas/FileResource'
    FileResource:
      type: object
      description: File resource which can be uploaded or downloaded.
      properties:
        url:
          $ref: '#/components/schemas/FileResourceUrl'
        tags:
          $ref: '#/components/schemas/FileResourceTags'
    FileResourceTags:
      type: array
      description: List of tags for the file resource.
      items:
        $ref: '#/components/schemas/FileResourceTag'
    FileResourceTag:
      type: string
      description: String describing and identifying a resource.
      example: Reporting
    DnbModel:
      type: object
      description: Details of Business Partner in D&B Model.
      properties:
        displaySequence:
          type: integer
          description: >-
            The order in which the entity appears in the result set. The lower
            the number the better the probability of the match.
          example: '1'
        organization:
          type: object
          description: The details of the entity.
          properties:
            duns:
              type: string
              description: >-
                The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                identification number that uniquely identifies the entity in
                accordance with the Data Universal Numbering System (D-U-N-S).
              example: '804735132'
            dunsControlStatus:
              type: object
              description: >-
                The details of the entity established to provide products and/or
                services in the marketplace or to the community.
              properties:
                operatingStatus:
                  type: object
                  description: >-
                    The details of the entity's functional state or trading
                    status.
                  properties:
                    description:
                      type: string
                      description: >-
                        The entity''s functional state or trading status (e.g.,
                        active, out of business).
                      example: Active
                    dnbCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the entity's functional state or trading status.
                      example: '9074'
                isMailUndeliverable:
                  type: boolean
                  description: >-
                    Indicates whether it is possible to deliver mail to the
                    address of this entity.<br/><br/>- If true, it is not
                    possible to deliver mail to the address.<br/>- If false, it
                    is possible to deliver mail to the address.
                  example: 'false'
            primaryName:
              type: string
              description: >-
                The single name by which the entity is primarily known or
                identified.
              example: GORMAN MANUFACTURING COMPANY, INC.
            tradeStyleNames:
              type: array
              description: >-
                The details of the names that the entity trades under for
                commercial purposes although its registered legal name used for
                contracts and other formal situations may be another name.
              items:
                type: object
                description: Item details.
                properties:
                  name:
                    type: string
                    description: >-
                      The name that the entity trades under for commercial
                      purposes  although its registered legal name used for
                      contracts and other formal situations may be another name.
                    example: Alternate Company Name
                  priority:
                    type: integer
                    description: >-
                      The sequence in which the entity mostly uses this
                      tradestyle name.
                    example: '1'
            telephone:
              type: array
              description: >-
                The details of the telephone information used for voice
                communication with the entity.
              items:
                type: object
                description: Item details.
                properties:
                  telephoneNumber:
                    type: string
                    description: >-
                      A sequence of digits used for voice communication with the
                      entity.<br/>This sequence of digits includes the area code
                      or city code and domestic dialing code.
                    example: '6505550000'
                  isUnreachable:
                    type: boolean
                    description: >-
                      Indicates whether the telephone number can be connected to
                      successfully.<br/><br/>- If true, connection to the 
                      telephone number is unsuccessful.<br/>- If false,
                      connection to the  telephone number is successful.
                    example: 'false'
            websiteAddress:
              type: array
              description: >-
                The details of the internet URLs used for online information and
                communication with the entity.
              items:
                type: object
                description: Item details.
                properties:
                  url:
                    type: string
                    description: >-
                      The Internet URL (Uniform Resource Locator) that uniquely
                      identifies the proprietary website of the entity or the
                      website preferred by the entity that gives more
                      information on the entity.
                    example: http://www.gorman.com
                  domainName:
                    type: string
                    description: >-
                      A unique name used to identify the website of the entity
                      that serves as an address to access that website.
                    example: gorman.com
            primaryAddress:
              type: object
              description: >-
                The details of the single primary or physical address at which
                the entity is located.
              properties:
                addressCountry:
                  type: object
                  description: The details of the country in which this address is located.
                  properties:
                    isoAlpha2Code:
                      type: string
                      description: >-
                        The two-letter country code, defined by the
                        International Organization for Standardization (ISO) ISO
                        3166-1 scheme identifying the country in which this
                        address is located.
                      example: US
                    name:
                      type: string
                      description: >-
                        The name of the country in which this address is
                        located.
                      example: United States
                addressLocality:
                  type: object
                  description: >-
                    The details of the city, town, township, village, borough,
                    etc. in which this address is located.
                  properties:
                    name:
                      type: string
                      description: >-
                        The name of the city, town, township, village, borough,
                        etc. in which this address is located.
                      example: SAN FRANCISCO
                addressRegion:
                  type: object
                  description: >-
                    The details of the locally governed area that forms part of
                    a centrally governed nation to identify where this address
                    is located.
                  properties:
                    abbreviatedName:
                      type: string
                      description: >-
                        The shortened name of the locally governed area that
                        forms part of a centrally governed nation. For example
                        'NJ' for the US State New Jersey within Country United
                        States.
                      example: CA
                postalCode:
                  type: string
                  description: >-
                    An identifier used by the local country's postal authority
                    to identify where this address is located.
                  example: '941109999'
                postalCodeExtension:
                  type: string
                  description: >-
                    An extension to the postal code that identifies a street or
                    building within the geographic area covered by the Postal
                    Code.
                  example: '9999'
                streetAddress:
                  type: object
                  description: >-
                    The details of the street address where the entity is
                    located.
                  properties:
                    line1:
                      type: string
                      description: >-
                        The first line of the address where the entity is
                        located.<br/><br/>For example, &quot;41 Central
                        Chambers&quot; in the address <br/>41 Central
                        Chambers<br/>Dame Court<br/>Dublin 2.
                      example: 492 KOLLER ST
                    line2:
                      type: string
                      description: >-
                        The second line of the address where the entity is
                        located.<br/><br/>For example, &quot;Dame Court&quot; in
                        the address <br/>41 Central Chambers<br/>Dame
                        Court<br/>Dublin 2.
                      example: Suite 100
            mailingAddress:
              type: object
              example: ''
              description: >-
                The details of the address used by the entity for mailing
                purposes.
              properties:
                addressCountry:
                  type: object
                  description: The details of the country in which this address is located.
                  properties:
                    isoAlpha2Code:
                      type: string
                      description: >-
                        The two-letter country code, defined by the
                        International Organization for Standardization (ISO) ISO
                        3166-1 scheme identifying the country in which this
                        address is located.
                      example: US
                    name:
                      type: string
                      description: >-
                        The name of the country in which this address is
                        located.
                      example: United States
                addressLocality:
                  type: object
                  description: >-
                    The details of the city, town, township, village, borough,
                    etc. in which this address is located.
                  properties:
                    name:
                      type: string
                      description: >-
                        The name of the city, town, township, village, borough,
                        etc. in which this address is located.
                      example: SAN FRANCISCO
                addressRegion:
                  type: object
                  description: >-
                    The details of the locally governed area that forms part of
                    a centrally governed nation to identify where this address
                    is located.
                  properties:
                    abbreviatedName:
                      type: string
                      description: >-
                        The shortened name of the locally governed area that
                        forms part of a centrally governed nation. For example
                        'NJ' for the US State New Jersey within Country United
                        States.
                      example: CA
                postalCode:
                  type: string
                  description: >-
                    An identifier used by the local country's postal authority
                    to identify where this address is located.
                  example: '941109999'
                postalCodeExtension:
                  type: string
                  description: >-
                    An extension to the postal code that identifies a street or
                    building within the geographic area covered by the Postal
                    Code.
                  example: '9999'
                streetAddress:
                  type: object
                  description: >-
                    The details of the street address where the entity is
                    located.
                  properties:
                    line1:
                      type: string
                      description: >-
                        The first line of the address where the entity is
                        located.<br/><br/>For example, &quot;41 Central
                        Chambers&quot; in the address <br/>41 Central
                        Chambers<br/>Dame Court<br/>Dublin 2.
                      example: 492 KOLLER ST
            registrationNumbers:
              type: array
              description: >-
                The details of the numbers assigned by an external body or by
                Dun & Bradstreet that either uniquely identifies or helps to
                identify the entity.
              items:
                type: object
                description: Item details.
                properties:
                  registrationNumber:
                    type: string
                    description: >-
                      The number assigned by an external body or by Dun &
                      Bradstreet that either uniquely identifies or helps to
                      identify the entity.
                    example: 12-3456789
                  typeDescription:
                    type: string
                    description: >-
                      The type of registration (e.g., Chamber of Commerce
                      Number, Value Added Tax Number, Federal Taxpayer
                      Identification Number, Companies Registry Office Number).
                    example: Federal Taxpayer Identification Number (US)
                  typeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      type of registration number.
                    example: '6863'
            mostSeniorPrincipals:
              type: array
              description: The  details of the most important principals.
              items:
                type: object
                description: Item details.
                properties:
                  fullName:
                    type: string
                    description: The complete name of the principal.
                    example: Leslie Ann Smith
            isStandalone:
              type: boolean
              description: >-
                Indicates if the entity is a member of a legal family tree.
                <br/><br/>- If true, indicates that the entity is not a member
                of a legal family tree.  This means it cannot play any family
                tree role and corporateLinkage will not be present.<br/>- If
                false, indicates that the entity is a member of a legal family
                tree.  The roles it plays is indicated by Family Tree Member
                Roles played.
              example: 'false'
            corporateLinkage:
              type: object
              description: >-
                The details of the relationship between the entity and other
                entities in the legal family tree.
              properties:
                familytreeRolesPlayed:
                  type: array
                  description: >-
                    The details of the roles the entity plays as a member of an
                    ownership structured family tree.
                  items:
                    type: object
                    description: Item details.
                    properties:
                      description:
                        type: string
                        description: >-
                          The role the entity plays as a member of an ownership
                          structured family tree (e.g., a branch, division, a
                          parent, headquarters, subsidiary, global ultimate,
                          domestic ultimate).
                        example: Parent/Headquarters
                      dnbCode:
                        type: integer
                        description: >-
                          A unique code assigned by Dun & Bradstreet to identify
                          describing family tree role.
                        example: '9141'
        matchQualityInformation:
          type: object
          description: >-
            The details of the parameters and components assessed by the Match
            engine.
          properties:
            confidenceCode:
              type: integer
              description: >-
                A numeric value from 1 (low) up to 10 (high) indicating the
                level of certainty at which this possible candidate was included
                in this result set.
              example: '6'
            matchGrade:
              type: string
              description: >-
                The compound rating that comprises one rating per type of data
                scored by a match engine.  <br/><br/>For example, in AABZBAAAFBZ
                the &quot;A&quot; in the 1st position means that the Name scored
                between 80-100 and the &quot;A&quot; in the 2nd position means
                that the Street Number had to score exactly 100.<br/><br/>For
                more details, please see the Identity Resolution guide.
              example: AZZZZZZZFZZ
            matchGradeComponentsCount:
              type: integer
              description: >-
                The number of constituent parts that were used in the
                calculation of the Match Grade.
              example: '11'
            matchGradeComponents:
              type: array
              description: The details of the components measured by the match engine.
              items:
                type: object
                description: Item details.
                properties:
                  componentType:
                    type: string
                    description: >-
                      The component (e.g., Name, Street Number) of the Match
                      Grade that was measured by the match engine.
                    example: Name
                  componentRating:
                    type: string
                    description: >-
                      The quality of the match result on this component.  The
                      rating is based on a scoring system.
                    example: A
            matchDataProfile:
              type: string
              description: >-
                The information that the matching process used to arrive at a
                match in addition to the application''s business rules and
                parameters specified by the requestor. <br/><br/>This is a
                28-byte string consisting of 14 components of 2 bytes each.
                <br/><br/>The 14 components are, in order, Name, Street Number,
                Street Name, Town Name, Territory Name, P.O. Box, Telephone,
                Post Code, D-U-N-S Number, Industry Code, Geographical Density,
                Location Uniqueness, Registration Number and URL.
              example: '0000000000989800000000009898'
            matchDataProfileComponentsCount:
              type: integer
              description: >-
                The number of constituent parts (e.g., Name, Street Number) that
                were used in the calculation of the Match Data Profile.
              example: '14'
            matchDataProfileComponents:
              type: array
              description: >-
                The details of the constituent parts (e.g., Name, Street Number)
                that were used in the calculation of the Match Data Profile.
              items:
                type: object
                description: Item details.
                properties:
                  componentType:
                    type: string
                    description: The specific component type used.
                    example: Name
                  componentValue:
                    type: string
                    description: >-
                      The value of the component described in Match Data Profile
                      Component Type.
                    example: '0'
            nameMatchScore:
              type: number
              description: >-
                A number from -1 to 100 (including decimals) that indicates the
                detailed level of match on the name of the matched
                candidate.<br/><br/>- 0 indicates no match.<br/>- 100 indicates
                most accurate match.
              example: '85.5'
    LookupFeatureSearchResult:
      type: object
      description: Lookup feature.
      properties:
        technicalKey:
          $ref: '#/components/schemas/LookupFeatureTechnicalKey'
    LookupFeatureTechnicalKey:
      type: string
      description: A feature for lookup.
      example: FORCE_EXTERNAL_CALL
    PageSize:
      type: integer
      description: Number of items per page. Default 10.
      example: '10'
      minimum: 1
      maximum: 1000
    FetchFeatureSearchResult:
      type: object
      description: Fetch feature.
      properties:
        technicalKey:
          $ref: '#/components/schemas/FetchFeatureTechnicalKey'
    FetchFeatureTechnicalKey:
      type: string
      description: A feature for fetch.
      example: FORCE_EXTERNAL_CALL
    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
    ConfigurationId:
      type: string
      description: Uniquely identifies a configuration.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    ConfigurationName:
      type: string
      description: Display name for a configuration.
      example: Client configuration.
    CreatedAt:
      type: string
      description: Date of creation (ISO 8601-compliant).
      example: '2025-10-07T05:40:40Z'
    ModifiedAt:
      type: string
      description: Date of modification (ISO 8601-compliant).
      example: '2025-10-07T05:40:40Z'
    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
    BusinessPartnerStorageDataSourceId:
      type: string
      description: Unique identifier for a Data Source of the Storage.
      example: 648824a691d8d2503d65103e
    CountryShortName:
      type: string
      description: Country code (ISO 3166-1 alpha-2).
      example: CH
    BusinessPartnerStorageId:
      type: string
      description: Unique identifier of the Storage.
      example: 72d6900fce6b326088f5d9d91049e3e6
    LanguageTechnicalKey:
      type: string
      description: ISO 639-1 two-letter code of languages.
      example: DE
    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
    LanguageName:
      type: string
      description: ISO 639-1 name of language.
      example: German
    AddressIdentifyingNameValue:
      type: string
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      example: John Doe
    AddressExternalId:
      type: string
      description: >-
        ID the address has in the external system where the record originates
        from.
      example: '1'
    ProvenanceName:
      type: string
      description: Display Name of the Provenance Name.
      example: VIES
    ProvenanceUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the Provenance
        Name.
      example: >-
        https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=
    ProvenanceTechnicalKey:
      type: string
      description: Technical Key of the Provenance Name.
      example: VIES
    ProvenanceCdqId:
      type: string
      description: The ID provided for a linkage with the source by CDQ.
      example: VIES:PL8660001429
    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.
    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
    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
    AdministrativeAreaTypeName:
      type: string
      description: Display label for the Administrative Area Type.
      example: COUNTY
    AdministrativeAreaTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative
        Area](https://meta.cdq.com/Address/administrative_area/type).
      example: https://meta.cdq.com/Address/administrative_area/type
    AdministrativeAreaTypeTechnicalKey:
      type: string
      description: Technical key of the Administrative Area.
      example: COUNTY
    PostCodeValue:
      type: string
      description: Effective [post code](https://meta.cdq.com/Address/post_code).
      example: '9000'
    PostCodeTypeName:
      type: string
      description: Display label for the Post Code Type.
      example: Regular
    PostCodeTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative Area](https://meta.cdq.com/Address/post_code/type).
      example: https://meta.cdq.com/Address/post_code/type
    PostCodeTypeTechnicalKey:
      type: string
      description: Technical key of the Post Code.
      example: REGULAR
    LocalityTypeName:
      type: string
      description: Display label for the Locality Type.
      example: City
    LocalityTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Locality
        Type](https://meta.cdq.com/Address/locality/type).
      example: https://meta.cdq.com/Address/locality/type
    LocalityTypeTechnicalKey:
      type: string
      description: Technical Key of the Locality Type.
      example: CITY
    LocalityShortName:
      type: string
      description: Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
      example: St. Gallen
    LocalityValue:
      type: string
      description: Name of the [Locality](https://meta.cdq.com/Address/locality).
      example: Sankt Gallen
    ThoroughfareTypeName:
      type: string
      description: Display label for the Thoroughfare Type Name.
      example: Industrial zone
    ThoroughfareTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type).
      example: https://meta.cdq.com/Address/thoroughfare/type
    ThoroughfareTypeTechnicalKey:
      type: string
      description: Technical key of the Thoroughfare Type.
      example: INDUSTRIAL_ZONE
    ThoroughfareShortName:
      type: string
      description: >-
        Abbreviation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: Lukasstr. 4
    ThoroughfareNumber:
      type: string
      description: Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: '4'
    ThoroughfareValue:
      type: string
      description: >-
        Comprehensive designation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the
        thoroughfare type such as Street, or Rue.
      example: Lukasstraße 4
    ThoroughfareName:
      type: string
      description: >-
        Pure name of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising
        the thoroughfare type such as Street, or Rue.
      example: Lukasstraße
    ThoroughfareDirection:
      type: string
      description: >-
        Direction of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: 221-bis Baker Street, North
    PremiseValue:
      type: string
      description: The actual value of a Premise in the language of the address.
      example: Lukasstraße 4
    PremiseShortName:
      type: string
      description: Abbreviation of the Premise.
      example: Lukasstr. 4
    PremiseNumber:
      type: string
      description: Number of the Premise.
      example: '4'
    PremiseTypeName:
      type: string
      description: Display label for the Premise Type.
      example: Factory
    PremiseTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Premise
        Type](https://meta.cdq.com/Address/premise/type).
      example: https://meta.cdq.com/Address/premise/type
    schemas-PremiseTypeTechnicalKey:
      type: string
      description: Technical key of the Premise Type.
      example: FACTORY
    PostalDeliveryPointTypeName:
      type: string
      description: Display label for the Postal Delivery Point Type.
      example: Mailbox
    PostalDeliveryPointTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Postal
        Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type)
      example: https://meta.cdq.com/Address/postal_delivery_point/type
    schemas-PostalDeliveryPointTypeTechnicalKey:
      type: string
      description: Technical key of the Postal Delivery Point.
      example: MAILBOX
    PostalDeliveryPointShortName:
      type: string
      description: >-
        Stort name of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: St Gallen, Postfach 460
    PostalDeliveryPointNumber:
      type: string
      description: >-
        Number of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: '460'
    PostalDeliveryPointValue:
      type: string
      description: >-
        Value of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: Postfach
    GeographicCoordinatesLatitude:
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
      type: number
      format: double
    GeographicCoordinatesLongitude:
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
      type: number
      format: double
    AddressTypeName:
      type: string
      description: Display label for the Address Type.
      example: Legal Address
    AddressTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Address
        Type](https://meta.cdq.com/Address/type).
      example: https://meta.cdq.com/Address/type
    AddressTypeTechnicalKey:
      type: string
      description: Technical key of the Address Type.
      example: LEGAL_ADDRESS
    FormattedAddressCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedAddressAdministrativeArea:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedAddressRegion:
      type: string
      description: Top level subdivision of a country.
      example: Sankt Gallen
    FormattedAddressRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedAddressLocality:
      type: string
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
      example: Sankt Gallen
    FormattedAddressDistrict:
      type: string
      description: >-
        Type of administrative division that, in some countries, is managed by
        local government. Across the world, areas known as "districts" vary
        greatly in size, spanning regions or counties, several municipalities,
        subdivisions of municipalities, school district, or political district.
      example: City center
    FormattedAddressPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedAddressThoroughfare:
      type: string
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue.
      example: Lukassstrasse
    FormattedAddressPremise:
      type: string
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      example: Lukasstraße 4, Building 2, Floor 3, Room 4
    FormattedAddressInterurbanDeliveryPoint:
      type: string
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
    FormattedAddressMailbox:
      type: string
      description: A location at an address where the post is delivered to.
      example: Postfach 460
    FormattedAddressPostOfficeBox:
      type: string
      description: >-
        A uniquely addressable lockable box located on the premises of a post
        office station.
      example: Postfach 460
    schemas-FormattedAddress:
      type: object
      description: A formatted address is a structured address of VIES data source.
      properties:
        country:
          $ref: '#/components/schemas/FormattedAddressCountry'
        administrativeArea:
          $ref: '#/components/schemas/FormattedAddressAdministrativeArea'
        region:
          $ref: '#/components/schemas/FormattedAddressRegion'
        regionCode:
          $ref: '#/components/schemas/FormattedAddressRegionCode'
        locality:
          $ref: '#/components/schemas/FormattedAddressLocality'
        district:
          $ref: '#/components/schemas/FormattedAddressDistrict'
        postalCode:
          $ref: '#/components/schemas/FormattedAddressPostalCode'
        thoroughfare:
          $ref: '#/components/schemas/FormattedAddressThoroughfare'
        premise:
          $ref: '#/components/schemas/FormattedAddressPremise'
        interurbanDeliveryPoint:
          $ref: '#/components/schemas/FormattedAddressInterurbanDeliveryPoint'
        mailbox:
          $ref: '#/components/schemas/FormattedAddressMailbox'
        postOfficeBox:
          $ref: '#/components/schemas/FormattedAddressPostOfficeBox'
    ApiErrorTimestamp:
      type: string
      deprecated: true
      description: ISO 8601 representation of the timestamp.
      example: '2025-10-07T05:40:40Z'
    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
    HttpStatus:
      type: integer
      description: RFC 7231 status code for this error.
      example: '400'
      deprecated: true
    HttpPath:
      type: string
      description: Requested path which caused this error.
      example: /v2/businesspartners/lookup
    ExternalServiceResponseStatus:
      type: string
      description: External service call status.
      example: OK
    BusinessPartnerStorageDataSourceName:
      type: string
      description: Name of a data source of a storage.
      example: Internal customers
    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
    schemas-NameTypeTechnicalKey:
      type: string
      description: Technical Keys of the Name Type.
      example: LOCAL
    NameValue:
      type: string
      description: The actual name.
      example: Corporate Data Quality AG
    NameDetailValue:
      type: string
      description: >-
        Value of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: Corporate Data Quality AG - Marketing Department
    NameDetailTypeName:
      type: string
      description: >-
        Name Detail Type Name of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: Legal Entity
    NameDetailTypeUrl:
      type: string
      description: >-
        Name Detail Type Url of additional information to a [Business Partner
        Name](https://meta.cdq.com/Business_partner/name).
      example: https://meta.cdq.com/Business_partner/type
    NameDetailTypeTechnicalKey:
      type: string
      description: >-
        Name Detail Type Technical Key of additional information to a [Business
        Partner Name](https://meta.cdq.com/Business_partner/name).
      example: LEGAL_ENTITY
    LegalFormName:
      type: string
      description: Display of the Legal Form.
      example: Aktiengesellschaft
    LegalFormUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of [Legal
        Form](https://meta.cdq.com/Business_partner/legal_form).
      example: https://meta.cdq.com/Business_partner/legal_form
    LegalFormMainAbbreviation:
      type: string
      description: >-
        The primary abbreviation of a legal form, i.e. the most commonly used
        abbreviation in a country.
      example: AG
    LegalFormCdlElfCode:
      deprecated: true
      type: string
      description: An unique identifier for CDL managed Legal Forms.
      example: AG
    LegalFormCategoryName:
      type: string
      maxLength: 40
      description: Descriptive display name of the Legal Form Category.
      example: Limited Liability Company
    LegalFormCategoryUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: >-
        https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001
    LegalFormCategoryShortName:
      type: string
      maxLength: 15
      description: Short display name of the Legal Form Category.
      example: LLC
    LegalFormCategoryTechnicalKey:
      type: string
      description: >-
        Technical Key of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: LIMITED
    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
    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
    IdentifierValue:
      type: string
      description: Value of the identifier.
      example: CHE-218.608.886 HR/MWST
    IssuingBodyShortName:
      type: string
      description: Preferred short display label for an Issuing Body.
      maxLength: 50
      example: Amtsgericht Aachen
    IssuingBodyName:
      type: string
      description: Preferred display label for an Issuing Body.
      example: Amtsgericht Aachen
    schemas-NameType:
      type: object
      description: >-
        The type of the name, e.g. a locally used name or an international
        version.
      properties:
        url:
          $ref: '#/components/schemas/NameTypeUrl'
        name:
          $ref: '#/components/schemas/NameTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-NameTypeTechnicalKey'
    schemas-Name:
      type: object
      description: The name of a business partner.
      properties:
        shortName:
          $ref: '#/components/schemas/NameShortName'
        type:
          $ref: '#/components/schemas/schemas-NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        language:
          $ref: '#/components/schemas/Language'
    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
    IdentifierStatusName:
      type: string
      description: Display label for the Identifier Status Name.
      example: ACTIVE
    IdentifierStatusTechnicalKey:
      type: string
      description: Technical key of the Identifier Status.
      example: ACTIVE
    BusinessPartnerCategoryName:
      type: string
      description: Display name of the Business Partner Category Name.
      example: Hotel
    BusinessPartnerCategoryUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Business
        Partner Category](https://meta.cdq.com/Business_partner/category).
      example: https://meta.cdq.com/Business_partner/category
    BusinessPartnerCategoryTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Category.
      example: HOTEL
    BusinessPartnerStatusTypeName:
      type: string
      description: Display name of the Business Partner Status.
      example: In Liquidation
    BusinessPartnerStatusTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Business
        Partner Status](https://meta.cdq.com/Business_partner/status/type).
      example: https://meta.cdq.com/Business_partner/status/type
    BusinessPartnerStatusTypeTechnicalKey:
      type: string
      description: Technical Key of the Business Parter Status.
      example: IN_LIQUIDATION
    BusinessPartnerStatusOfficialDenotation:
      type: string
      description: The status as provided by an official register.
      example: Good Standing
    BusinessPartnerStatusValidFrom:
      type: string
      description: >-
        Describes since when a business partner turned or will turn into the
        provided status. If no official date is known, the date of changing the
        status in the CDQ Community Data Pool or an external data source is
        provided.
      example: '2025-10-07T05:40:40Z'
    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:40Z'
    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.
    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
    ClassificationTypeName:
      type: string
      description: Display label for the Classification Type.
      example: NAF 2003
    ClassificationTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Classification
        Type](https://meta.cdq.com/Business_partner/partner_profile/classification/type)
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/classification/type
    PhoneNumberCountryPrefix:
      type: string
      description: The country prefix of a phone number.
      example: '+41'
    PhoneNumberNumber:
      type: string
      description: The complete phone number without any country prefixes.
      example: 71 571 10 40
    PhoneNumberTypeName:
      type: string
      description: Display label for a Phone Number Type Name.
      example: FAX
    PhoneNumberTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Phone
        Number
        Type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      example: https://meta.cdq.com/Business_partner/partner_profile/phone_number/type
    PhoneNumberValue:
      type: string
      description: The actual complete phone number incl. country prefix.
      example: +41 71 571 10 40
    WebsiteUrl:
      type: string
      description: The actual company website URL.
      example: https://cdq.com
    WebsiteTypeName:
      type: string
      description: Display label for a Website Type Name
      example: Corporate Website
    WebsiteTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes [Website Type
        Name](https://meta.cdq.com/Business_Partner/partner_profile/website/type).
      example: https://meta.cdq.com/Business_Partner/partner_profile/website/type
    WebsiteTypeTechnicalKey:
      type: string
      description: Technical Keys of the Website Type Name.
      example: WEBSITE_TYPE_CORPORATE
    ContactEmailValue:
      type: string
      description: Value of the email address of the Business Partner.
      example: developer-portal@cdq.com
    VatPayerStatusPublicationDate:
      type: string
      description: Date of publication
      example: '2025-10-07T05:40:40Z'
    PayerStatusName:
      type: string
      description: Name of Vat payer status. Available values RELIABLE and UNRELIABLE
      example: RELIABLE
    PayerStatusTechnicalKey:
      type: string
      description: Technical key of Vat payer status
      example: VAT_PAYER_STATUS
    RegistrationAuthorityId:
      type: string
      description: >-
        The reference code of the registration authority, taken from the
        Registration Authorities Code List maintained by GLEIF.
      example: RA000009
    RegistrationAuthorityEntityId:
      type: string
      description: The identifier of the Entity at the indicated registration authority.
      example: RA000009
    OtherRegistrationAuthorityId:
      type: string
      description: A legacy / historical reference code of a registration authority.
      example: RA000009
    ProfessionTypeName:
      type: string
      description: Name of the profession type.
      example: Doctor
    ProfessionTypeUrl:
      type: string
      description: URL to the documentation of the Profession Type Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key
    ProfessionTypeTechnicalKey:
      type: string
      description: Technical key of the profession type.
      example: DOCTOR
    LicenseStatusName:
      type: string
      description: Name of the license status.
      example: Granted
    LicenseStatusUrl:
      type: string
      description: URL to the documentation of the License Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key
    LicenseStatusTechnicalKey:
      type: string
      description: Technical key of the license status.
      example: GRANTED
    PermissionStatusName:
      type: string
      description: Name of the permission status.
      example: Granted
    PermissionStatusUrl:
      type: string
      description: URL to the documentation of the Permission Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url
    PermissionStatusTechnicalKey:
      type: string
      description: Technical key of the permission status.
      example: GRANTED
    ActivityStatusName:
      type: string
      description: |
        Name of the activity status.
        Possible values: 
        * Active - The operational permission is active.
        * Inactive - The operational permission is inactive.
      example: Inactive
    ActivityStatusUrl:
      type: string
      description: URL to the documentation of the Activity Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url
    ActivityStatusTechnicalKey:
      type: string
      description: Technical key of the activity status.
      example: INACTIVE
    SelfDispensationStatusName:
      type: string
      description: Name of the self-dispensation status.
      example: 'No'
    SelfDispensationStatusUrl:
      type: string
      description: URL to the documentation of the Self Dispensation Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/self_dispensation_status/url
    SelfDispensationStatusTechnicalKey:
      type: string
      description: Technical key of the self-dispensation status.
      example: 'NO'
    ControlledSubstancePurchasePermissionName:
      type: string
      description: Name of the controlled substance purchase permission.
      example: 'Yes'
    ControlledSubstancePurchasePermissionUrl:
      type: string
      description: >-
        URL to the documentation of the Controlled Substance Purchase Permission
        Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/controlled_substance_purchase_permission/url
    ControlledSubstancePurchasePermissionTechnicalKey:
      type: string
      description: Technical key of the controlled substance purchase permission.
      example: 'YES'
    FormattedSapRecordName1:
      type: string
      description: A name1 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName2:
      type: string
      description: A name2 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName3:
      type: string
      description: A name3 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName4:
      type: string
      description: A name4 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordNameCo:
      type: string
      description: The legal form name of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalEntity:
      type: string
      description: The legal entity of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalForm:
      type: string
      description: The legal form of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordIndSector:
      type: string
      description: >-
        A business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      example: NAF
    FormattedSapRecordIndSectorCode:
      type: string
      description: >-
        A code of business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      example: NAF
    FormattedSapRecordEmailAddress:
      type: string
      description: Email address of the Business Partner.
      example: bp@gmail.com
    FormattedSapRecordNarp:
      type: string
      description: >-
        An individual person, i.e. not an organization. An individual has no
        identifiers and has no legal form in its name.
      example: Friedrich Nietzsche
    FormattedSapRecordStceg:
      type: string
      description: VAT registration number.
      example: CHE-218.608.88
    FormattedSapRecordStcd1:
      type: string
      description: Standard tax number field1.
      example: CHE-218.608.88
    FormattedSapRecordStcd2:
      type: string
      description: Standard tax number field2.
      example: CHE-218.608.88
    FormattedSapRecordStcd3:
      type: string
      description: Standard tax number field3.
      example: CHE-218.608.88
    FormattedSapRecordStcd4:
      type: string
      description: Standard tax number field4.
      example: CHE-218.608.88
    FormattedSapRecordStcd5:
      type: string
      description: Standard tax number field5.
      example: CHE-218.608.88
    FormattedSapRecordUrl:
      type: string
      description: >-
        Webpages related to the business partner, e.g. the main corporate
        website as also provided by some company registers.
      example: www.cdq.com
    FormattedSapRecordTelNumber:
      type: string
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarter.
      example: +41 71 571 10 40
    FormattedSapRecordCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedSapRecordCountryCode:
      type: string
      description: Country code (ISO 3166-1 alpha-2)
      example: CH
    FormattedSapRecordRegion:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordRegionCodeSap:
      type: string
      description: A Region specific code for a certain address.
      example: '9004'
    FormattedSapRecordRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCounty:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordCountyCode:
      type: string
      description: A county specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordTownship:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordTownshipCode:
      type: string
      description: A township specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCity:
      type: string
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an [administrative
        area](https://meta.cdq.com/Address/administrative_area). A locality can
        also have several levels of sub localities.
      example: Sankt Gallen
    FormattedSapRecordDistrict:
      type: string
      description: Area of a country or city.
      example: St. Georgen
    FormattedSapRecordPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordPostalCode3:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordStreet1:
      type: string
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      example: Lukasstraße 4
    FormattedSapRecordStreet2:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordStreet5:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordHouseNum:
      type: string
      description: Number of the Thoroughfare.
      example: '4'
    FormattedSapRecordHouseNum2:
      type: string
      description: Additional number filed.
      example: '4'
    FormattedSapRecordBuilding:
      type: string
      description: >-
        A structure (such as a house, hospital, school, etc.) with a roof and
        walls that is used as a place for people to live, work, do activities,
        store things, etc.
      example: Office 2
    FormattedSapRecordFloor:
      type: string
      description: The floor/story of the building.
      example: '2'
    FormattedSapRecordRoomnumber:
      type: string
      description: A distinct room in a building.
      example: '123'
    FormattedSapRecordPoBoxCountry:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxCity:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxPostalCode:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBox:
      type: string
      description: Des
      example: '9000'
    FormattedSapRecordLatitude:
      type: string
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
    FormattedSapRecordLongitude:
      type: string
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
    FormattedSapRecord:
      description: >-
        Provides business partner and address information in a data structure
        similar to SAP Business Partner table BUT000 and SAP Business Address
        Services table ADRC. Field names are equal or very similar to SAP field
        names in order to simplify field mapping. Data for name and street
        fields is already split into chunks of max. 35 characters.
      type: object
      properties:
        name1:
          $ref: '#/components/schemas/FormattedSapRecordName1'
        name2:
          $ref: '#/components/schemas/FormattedSapRecordName2'
        name3:
          $ref: '#/components/schemas/FormattedSapRecordName3'
        name4:
          $ref: '#/components/schemas/FormattedSapRecordName4'
        nameCo:
          $ref: '#/components/schemas/FormattedSapRecordNameCo'
        legalEntity:
          $ref: '#/components/schemas/FormattedSapRecordLegalEntity'
        legalForm:
          $ref: '#/components/schemas/FormattedSapRecordLegalForm'
        indSector:
          $ref: '#/components/schemas/FormattedSapRecordIndSector'
        indSectorCode:
          $ref: '#/components/schemas/FormattedSapRecordIndSectorCode'
        emailAddress:
          $ref: '#/components/schemas/FormattedSapRecordEmailAddress'
        narp:
          $ref: '#/components/schemas/FormattedSapRecordNarp'
        stceg:
          $ref: '#/components/schemas/FormattedSapRecordStceg'
        stcd1:
          $ref: '#/components/schemas/FormattedSapRecordStcd1'
        stcd2:
          $ref: '#/components/schemas/FormattedSapRecordStcd2'
        stcd3:
          $ref: '#/components/schemas/FormattedSapRecordStcd3'
        stcd4:
          $ref: '#/components/schemas/FormattedSapRecordStcd4'
        stcd5:
          $ref: '#/components/schemas/FormattedSapRecordStcd5'
        url:
          $ref: '#/components/schemas/FormattedSapRecordUrl'
        telNumber:
          $ref: '#/components/schemas/FormattedSapRecordTelNumber'
        country:
          $ref: '#/components/schemas/FormattedSapRecordCountry'
        countryCode:
          $ref: '#/components/schemas/FormattedSapRecordCountryCode'
        region:
          $ref: '#/components/schemas/FormattedSapRecordRegion'
        regionCodeSap:
          $ref: '#/components/schemas/FormattedSapRecordRegionCodeSap'
        regionCode:
          $ref: '#/components/schemas/FormattedSapRecordRegionCode'
        county:
          $ref: '#/components/schemas/FormattedSapRecordCounty'
        countyCode:
          $ref: '#/components/schemas/FormattedSapRecordCountyCode'
        township:
          $ref: '#/components/schemas/FormattedSapRecordTownship'
        townshipCode:
          $ref: '#/components/schemas/FormattedSapRecordTownshipCode'
        city:
          $ref: '#/components/schemas/FormattedSapRecordCity'
        district:
          $ref: '#/components/schemas/FormattedSapRecordDistrict'
        postalCode:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode'
        postalCode3:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode3'
        street1:
          $ref: '#/components/schemas/FormattedSapRecordStreet1'
        street2:
          $ref: '#/components/schemas/FormattedSapRecordStreet2'
        street5:
          $ref: '#/components/schemas/FormattedSapRecordStreet5'
        houseNum:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum'
        houseNum2:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum2'
        building:
          $ref: '#/components/schemas/FormattedSapRecordBuilding'
        floor:
          $ref: '#/components/schemas/FormattedSapRecordFloor'
        roomnumber:
          $ref: '#/components/schemas/FormattedSapRecordRoomnumber'
        poBoxCountry:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCountry'
        poBoxCity:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCity'
        poBoxPostalCode:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxPostalCode'
        poBox:
          $ref: '#/components/schemas/FormattedSapRecordPoBox'
        latitude:
          $ref: '#/components/schemas/FormattedSapRecordLatitude'
        longitude:
          $ref: '#/components/schemas/FormattedSapRecordLongitude'
    BusinessPartnerRelationStartedAt:
      type: string
      description: Describe when this relationship was first established.
      example: '2025-10-07T05:40:40Z'
    BusinessPartnerRelationEndedAt:
      type: string
      description: Describe when this relationship ended.
      example: '2025-10-07T05:40:40Z'
    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
    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'
    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
    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'
    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
    schemas-BusinessPartnerRelation:
      type: object
      description: >-
        Business Partner hierarchy, or any other kind of relation between two
        Business Partner entities. The data about relationships between
        companies come from official, external data sources.
      properties:
        startedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationStartedAt'
        endedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationEndedAt'
        type:
          $ref: '#/components/schemas/BusinessPartnerRelationType'
        class:
          $ref: '#/components/schemas/BusinessPartnerRelationClass'
        startNode:
          $ref: '#/components/schemas/BusinessPartnerRelationStartNode'
        endNode:
          $ref: '#/components/schemas/BusinessPartnerRelationEndNode'
    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
    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'
    BankAccountCountryCode:
      type: string
      description: ISO code to identify the country a bank account is registered in.
      example: DE
    BankAccountIdentifier:
      type: string
      description: Identifier of a bank account in a national or international context.
      example: CH8800781619278412000
    ExternalIdValue:
      type: string
      description: Value of the ExternalId of the business partner.
      example: '123'
    schemas-CharacterSet:
      type: object
      description: Character set.
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    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
    ConceptTechnicalKey:
      type: string
      description: Technical key of the Concept.
      example: ADDRESS
    Concept:
      type: object
      description: >-
        The Concept is a part of the CDQ data model. For example Address is a
        concept of the Business Partner and have many subconcepts as Locality,
        Thoroughfare, Administrative Area etc.
      properties:
        name:
          $ref: '#/components/schemas/ConceptName'
        url:
          $ref: '#/components/schemas/ConceptUrl'
        technicalKey:
          $ref: '#/components/schemas/ConceptTechnicalKey'
    ExternalId:
      type: object
      description: >-
        Arbitrary identifier type to mark customer IDs which are "external" from
        CDQ's perspective. This is the identifier a customer provides to
        identify her records, e.g. the ID she manages in her SAP systems.
      properties:
        externalId:
          $ref: '#/components/schemas/ExternalIdValue'
        dataSourceId:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        id:
          type: string
          description: Unique identifier of the external ID.
          example: '123'
        characterSet:
          $ref: '#/components/schemas/schemas-CharacterSet'
        language:
          $ref: '#/components/schemas/Language'
        concept:
          $ref: '#/components/schemas/Concept'
    PropertyName:
      type: string
      description: Name of the property.
      example: Minority Indicator Value
    PropertyTechnicalKey:
      type: string
      description: Technical key of the property.
      example: MINORITY_INDICATOR_VALUE
    PropertyUrl:
      type: string
      description: External documentation URL for this property.
      example: http://meta.cdq.com/Business_Partner/Identifier_Value
    Property:
      type: object
      description: Part of a concept. It describes a single attribute of a concept.
      properties:
        parentConcept:
          $ref: '#/components/schemas/Concept'
        name:
          $ref: '#/components/schemas/PropertyName'
        technicalKey:
          $ref: '#/components/schemas/PropertyTechnicalKey'
        url:
          $ref: '#/components/schemas/PropertyUrl'
    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
    PropertyContentInstanceSelectorKey:
      type: string
      description: >-
        JSON subpath to the property allowing to select concrete instance of a
        property in the provided JSON object.
      example: type.technicalKey
    PropertyContentInstanceSelectorValue:
      type: string
      description: >-
        Value of a JSON subpath to the property allowing to select concrete
        instance of a property in the provided JSON object.
      example: CH_UID
    PropertyContentInstanceSelector:
      type: object
      description: Contains JSON paths allowing to select specific instance of a property.
      properties:
        key:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorKey'
        value:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorValue'
    PropertyValue:
      type: object
      description: >-
        In the context of updates property informs for which concept there was a
        change provided.
      allOf:
        - $ref: '#/components/schemas/Property'
        - type: object
          description: Part of a concept. It describes a single attribute of a concept.
          properties:
            content:
              $ref: '#/components/schemas/PropertyContent'
            contentSelector:
              $ref: '#/components/schemas/PropertyContentSelector'
            instanceSelectors:
              type: array
              items:
                $ref: '#/components/schemas/PropertyContentInstanceSelector'
    PropertyNewContent:
      type: string
      example: AAB
      description: New value after change
    PropertyPreviousContent:
      type: string
      example: AAB
      description: Value before change
    schemas-Provenance:
      type: object
      description: >-
        The source of the change or update. Could be the reference data source
        as VIES or Organization.
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        url:
          $ref: '#/components/schemas/ProvenanceUrl'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    PropertyChangeTypeTechnicalKey:
      type: string
      description: Technical Key of the Property Change Type.
      example: MODIFIED
    PropertyChangeClassification:
      type: string
      example: MAJOR
      description: >
        Gives a user an indicator how "much" the attribute was changed OR how
        important the change was. Allowed values are:
         * `TRIVIAL` - Trivial change
         * `MINOR` - Minor change
         * `MAJOR` - Major change
         * `CRITICAL` - Critical change
    PropertyChangeConfidenceScore:
      type: number
      description: >-
        Confidence score which shows how confident CDQ is about enrichment of
        that property. Calculation dependes on property type, see here for a
        complete description.
      example: '0.0'
      minimum: 0
    PropertyChangeMaxConfidenceScore:
      type: number
      description: >-
        Maximum confidence score which is achievable for this property type.
        Note that the max value will change over time depending on the
        udnerlying algorithm which will be continously improved.
      example: '1.0'
    PropertyChange:
      type: object
      description: >-
        Describes how a property has been changed and how confident we are that
        the change was a good improvement
      properties:
        externalIds:
          type: array
          items:
            $ref: '#/components/schemas/ExternalId'
        property:
          $ref: '#/components/schemas/PropertyValue'
        newContent:
          $ref: '#/components/schemas/PropertyNewContent'
        previousContent:
          $ref: '#/components/schemas/PropertyPreviousContent'
        provenance:
          $ref: '#/components/schemas/schemas-Provenance'
        changeType:
          $ref: '#/components/schemas/PropertyChangeTypeTechnicalKey'
        changeClassification:
          $ref: '#/components/schemas/PropertyChangeClassification'
        confidenceScore:
          $ref: '#/components/schemas/PropertyChangeConfidenceScore'
        maxConfidenceScore:
          $ref: '#/components/schemas/PropertyChangeMaxConfidenceScore'
    DataMatchingThreshold:
      type: number
      description: The threshold for the data matching.
      example: '0.5'
      format: double
      default: 0
      minimum: 0
      maximum: 1
    DnBAddress:
      type: object
      description: >-
        The details of the single primary or physical address at which the
        entity is located.
      properties:
        language:
          type: object
          description: The details of the language in which this address was recorded.
          properties:
            description:
              type: string
              description: The name of the language in which this address was recorded.
              example: English
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                language in which this address was recorded.
              example: '39'
        addressCountry:
          type: object
          description: The details of the country in which this address is located.
          properties:
            name:
              type: string
              description: The name of the country in which this address is located.
              example: United States
            isoAlpha2Code:
              type: string
              description: >-
                The two-letter country code, defined by the International
                Organization for Standardization (ISO) ISO 3166-1 scheme
                identifying the country in which this address is located.
              example: US
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the country in which this address is located.
              example: US
        continentalRegion:
          type: object
          description: >-
            The details of the continental region in which this address is
            located.
          properties:
            name:
              type: string
              description: >-
                The name of the continental region for this
                address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                Pacific<br/>- Europe<br/>- Latin America<br/>- Middle East<br/>-
                North America.
              example: North America
        addressLocality:
          type: object
          description: >-
            The details of the city, town, township, village, borough, etc. in
            which this address is located.
          properties:
            name:
              type: string
              description: >-
                The name of the city, town, township, village, borough, etc. in
                which this address is located.
              example: SAN FRANCISCO
        minorTownName:
          type: string
          description: >-
            The name of the village, town or suburb when it is not a Primary
            Town or City (e.g., the Booker in Booker, High Wycombe).
          example: Booker
        addressRegion:
          type: object
          description: >-
            The details of the locally governed area that forms part of a
            centrally governed nation to identify where this address is located.
          properties:
            name:
              type: string
              description: >-
                The name of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              example: California
            abbreviatedName:
              type: string
              description: >-
                The shortened name of the locally governed area that forms part
                of a centrally governed nation. For example 'NJ' for the US
                State New Jersey within Country United States.
              example: CA
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the region in which this address is located.
              example: '06'
        addressCounty:
          type: object
          description: The details of the county in which this address is located.
          properties:
            name:
              type: string
              description: The name of the county in which this address is located.
              example: SAN MATEO
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the county in which this address is located.
              example: '81'
        postalCode:
          type: string
          description: >-
            An identifier used by the local country's postal authority to
            identify where this address is located.
          example: '941109999'
        postalCodePosition:
          type: object
          description: >-
            The details of the position of the Postal Code when presenting the
            address.
          properties:
            description:
              type: string
              description: >-
                The position of the Postal Code when presenting the address
                (e.g., before the Primary Town/City).
              example: Post code presented before Town/City name
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                position of the Postal Code when presenting the address.
              example: '1009'
        streetNumber:
          type: string
          description: >-
            The number part of the street address where the entity is located.
            <br/><br/>This may be a single number, a number with an appendix, or
            a range of street numbers. <br/><br/>For example, the &quot;51 -
            59C&quot; in the address 51 - 59C Wall Street.
          example: '492'
        streetName:
          type: string
          example: KOLLER ST
          description: >-
            The name of the street where the entity is located. <br/><br/>For
            example, &quot;Wall Street&quot; in the address 51 - 59C Wall
            Street.
        streetAddress:
          type: object
          description: The details of the street address where the entity is located.
          properties:
            line1:
              type: string
              description: >-
                The first line of the address where the entity is
                located.<br/><br/>For example, &quot;41 Central Chambers&quot;
                in the address <br/>41 Central Chambers<br/>Dame
                Court<br/>Dublin 2.
              example: 492 KOLLER ST
            line2:
              type: string
              description: >-
                The second line of the address where the entity is
                located.<br/><br/>For example, &quot;Dame Court&quot; in the
                address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2.
              example: Suite 100
        postOfficeBox:
          type: object
          description: >-
            The details of the identifier issued to the entity by a private or
            public Postal Office for the purposes of collecting mail for the
            entity for subsequent collection or delivery.
          properties:
            postOfficeBoxNumber:
              type: string
              description: >-
                An identifier issued to the entity by a private or public postal
                office for the purposes of collecting mail for the entity for
                subsequent collection or delivery.<br/><br/>This includes only
                the identifying number (or text) and not the textual description
                of the PO Box type. For example the contents would be just the
                number 12 from &quot;PO Box 12&quot;, or just the number 57 from
                &quot;PMB 57&quot;.
              example: '5309'
            typeDescription:
              type: string
              description: The type of the PO Box (e.g., Post Office Box, PMB).
              example: Supplied by public Post Office authority
            typeDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of PO Box.
              example: '120'
        latitude:
          type: number
          description: >-
            The latitude component of the entity's location defined as the
            angular distance of the primary physical address north or south from
            the Earth's equator expressed in decimal numbers. <br/><br/>Positive
            numbers indicate degrees north. Negative numbers indicate degrees
            south.
          example: '37.777709'
        longitude:
          type: number
          description: >-
            The longitude component of the entity's location defined as the
            angular distance of the primary physical address east or west from
            an imaginary line (called the prime meridian) that goes from the
            North Pole to the South Pole expressed in decimal numbers.
            <br/><br/>Positive numbers indicate degrees east. Negative numbers
            indicate degrees west.
          example: '-122.404624'
        geographicalPrecision:
          type: object
          description: >-
            The details on how close the latitude and longitude coordinates for
            a location are to rooftop level.
          properties:
            description:
              type: string
              description: >-
                The description of how close the latitude and longitude
                coordinates for a location are to rooftop level.
              example: Street Segment Centroid
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify how close
                the latitude and longitude coordinates for a location are to
                &quot;rooftop&quot; level.
              example: '30256'
        isRegisteredAddress:
          type: boolean
          description: >-
            Indicates if the primary address is the same as the address of the
            entity as registered with a legal entity.  <br/>  <br/>- If true,
            the primary address is the same as the address of the entity as
            registered with a legal entity.<br/>- If false, the primary address
            is the not same as the address of the entity as registered with a
            legal entity.
          example: 'true'
        isResidentialAddress:
          type: boolean
          description: >-
            Indicates whether the Primary Address is classified as residential
            by the governing postal authority<br/><br/>- If true, the primary
            address is classified as residential.<br/>- If false, the primary
            address is not classified as residential.
          example: 'false'
        statisticalArea:
          type: object
          description: >-
            The details of the various statistical facts associated with this
            address.
          properties:
            cbsaName:
              type: string
              description: >-
                The name assigned to the 5-digit CBSA (Core Based Statistical
                Area) assigned by US Census board to denote a geographical
                region with a relatively high population density at its core and
                close economic ties throughout the area.
              example: San Francisco-Oakland-Hayward CA
            cbsaCode:
              type: string
              description: >-
                The 5-digit CBSA (Core Based Statistical Area) code assigned by
                US Census board to denote a geographical region with a
                relatively high population density at its core and close
                economic ties throughout the area.
              example: '41860'
            economicAreaOfInfluenceCode:
              type: string
              description: >-
                A code assigned by the U.S. Bureau of Economic Analysis to
                identify the entity's regional market that surrounds a
                metropolitan or micropolitan statistical area serving as a
                regional center of economic activity.
              example: '146'
            populationRank:
              type: object
              description: >-
                The details of the statistical facts about population based on
                region's rank.
              properties:
                rankNumber:
                  type: string
                  description: >-
                    A number classifying the geographic area in which the entity
                    is located based on the resident
                    population.<br/><br/>Values: 0 to 9<br/>0 denotes the lowest
                    population range; 9 denotes the highest.
                  example: '9'
                rankDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    population for the geographical area in which this address
                    is located.
                  example: '10961'
                rankDescription:
                  type: string
                  description: >-
                    A range of the population for the geographical area where
                    the entity is located.
                  example: 500,000 +
        locationOwnership:
          type: object
          description: >-
            The details of the terms under which the entity occupies the
            premises.
          properties:
            description:
              type: string
              description: >-
                Description of the terms under which the entity occupies the
                premises (e.g., owned, rented, leased).
              example: Rents
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the terms
                under which the entity occupies the premises.
              example: '1129'
        premisesArea:
          type: object
          description: The details of space the entity utilizes at this address.
          properties:
            measurement:
              type: number
              description: >-
                A number portion of the amount to of space the entity occupies
                at this address (e.g., the 2000 in 2000 square meters).
              example: '10034'
            unitDescription:
              type: string
              description: >-
                The measurement unit used to express the premises area
                measurement (e.g., acre, square meters, square feet).
              example: square foot
            unitDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                measurement unit used to express the premises area measurement.
              example: '3848'
            reliabilityDescription:
              type: string
              description: >-
                The accuracy of the measurement (e.g., actual, estimated,
                modeled).
              example: Actual
            reliabilityDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                accuracy of the measurement.
              example: '9092'
        isManufacturingLocation:
          type: boolean
          description: >-
            Indicates if manufacturing activity is performed at this facility by
            the entity.<br/><br/>- If true, the entity performs manufacturing
            activity at this facility.<br/>- If false, the entity does not
            perform manufacturing activity at this facility.
          example: 'true'
    IndustryCode:
      type: object
      description: >-
        The details of the business activities in which the organization is
        actively engaged using a standardized coding schemes such as European
        NACE and U.S. Standard Industry Classification (SIC).
      properties:
        code:
          type: string
          description: >-
            The code that identifies the business activity in which the entity
            is engaged. For example, 1611 represents the highway and street
            construction industry in the U.S. SIC (Standard Industrial
            Classification) system. Note: These are generally external codes
            created by an external authoritative body, like the U.S. Office of
            Management and Budget (OMB); however, Dun & Bradstreet may have
            created extensions to more precisely define an activity, as in the
            case of the SIC 2+2 (the last 4 digits of an 8-digit SIC).
          example: '1611'
        priority:
          type: number
          description: >-
            A number identifying the order in which this industry code should be
            presented relative to other industry codes of the same type where
            the lower the number the earlier the data is presented.
          example: '2'
    OperatingStatus:
      type: object
      description: The details of the entity's functional state or trading status.
      properties:
        dnbCode:
          type: number
          description: >-
            A unique code assigned by Dun & Bradstreet to identify the entity's
            functional state or trading status.
          example: '9074'
        description:
          type: string
          description: >-
            The entity's functional state or trading status (e.g., active, out
            of business).
          example: Active
    FamilytreeRole:
      type: object
      description: >-
        The details of the role the entity plays as a member of an ownership
        structured family tree.
      properties:
        dnbCode:
          type: number
          description: >-
            A unique code assigned by Dun & Bradstreet to identify describing
            family tree role.
          example: '9141'
        description:
          type: string
          description: >-
            The role the entity plays as a member of an ownership structured
            family tree (e.g., a branch, division, a parent, headquarters,
            subsidiary, global ultimate, domestic ultimate).
          example: Parent/Headquarter
    CommercialUltimatePathRawData:
      type: object
      description: Raw data from D&B for decisioning data for each company in the path.
      properties:
        relevantIndustryCodes:
          type: array
          description: List of industry codes for the company.
          items:
            $ref: '#/components/schemas/IndustryCode'
        operatingStatus:
          $ref: '#/components/schemas/OperatingStatus'
        isStandalone:
          type: boolean
          description: Flag if the company is considered as a standalone company.
          example: 'false'
        hierarchyLevel:
          type: number
          description: >-
            Hierarchy-Level measured from the top (Global Ultimate) to the
            bottom (the requested company). If Hierarchy Level is 1 in the
            requested company, no CU may be calculated as a GU has been
            requested
          example: '6'
        globalUltimateFamilyTreeMembersCount:
          type: number
          description: Number of Entities inside the D&B Family Tree.
          example: '12368'
        familytreeRolesPlayed:
          type: array
          description: List of roles played by the company in the D&B Family Tree.
          items:
            $ref: '#/components/schemas/FamilytreeRole'
    CommercialUltimatePath:
      type: object
      description: >-
        Node on the path in the company hierarchy from the root entity the last
        entity analyzed to determine the commercial ultimate.
      properties:
        duns:
          type: string
          description: >-
            The D-U-N-S Number, assigned by Dun & Bradstreet, is an
            identification number that uniquely identifies the entity in
            accordance with the Data Universal Numbering System (D-U-N-S).
          example: '804735132'
        primaryName:
          type: string
          description: >-
            The single name by which the entity is primarily known or
            identified.
          example: GORMAN MANUFACTURING COMPANY, INC.
        parentDuns:
          type: string
          description: The D-U-N-S Number of parent company.
          example: '804735133'
        governmental:
          type: boolean
          description: Flag indicating whether company is a governmental.
          example: 'false'
        holding:
          type: boolean
          description: Flag indicating whether company is a holding.
          example: 'false'
        foundation:
          type: boolean
          description: Flag indicating whether company is a foundation.
          example: 'false'
        rawData:
          $ref: '#/components/schemas/CommercialUltimatePathRawData'
    CmpelkV2Organization:
      type: object
      description: The details of the entity's organization.
      properties:
        duns:
          type: string
          example: 804735132
          description: >-
            The D-U-N-S Number, assigned by Dun & Bradstreet, is an
            identification number that uniquely identifies the entity in
            accordance with the Data Universal Numbering System (D-U-N-S).
        dunsControlStatus:
          type: object
          description: >-
            The details of the entity established to provide products and/or
            services in the marketplace or to the community.
          properties:
            operatingStatus:
              type: object
              description: The details of the entity's functional state or trading status.
              properties:
                description:
                  type: string
                  example: Active
                  description: >-
                    The entity's functional state or trading status (e.g.,
                    active, out of business).
                dnbCode:
                  type: integer
                  example: 9074
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    entity's functional state or trading status.
            isMarketable:
              type: boolean
              example: 'true'
              description: >-
                Indicates whether the data on the entity satisfies Dun &
                Bradstreet's marketability rules for Sales & Marketing Solutions
                products. <br/><br/>- If true, the entity data satisfies the
                marketability rules.<br/>- If false, the entity data does not
                satisfy the marketability rules.
            isMailUndeliverable:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether it is possible to deliver mail to the address
                of this entity.<br/><br/>- If true, it is not possible to
                deliver mail to the address.<br/>- If false, it is possible to
                deliver mail to the address.
            isTelephoneDisconnected:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether the telephone number can be connected to
                successfully.<br/><br/>- If true, connection to the  telephone
                number is unsuccessful.<br/>- If false, connection to the 
                telephone number is successful.
            isDelisted:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether the entity has requested that they not be
                included in any Direct marketing lists (e.g., mailing,
                telephone).<br/><br/>- If true, the entity has objected to and
                MUST NOT receive direct marketing material.<br/>- If false, the
                entity has not objected to receiving direct marketing material.
            subjectHandlingDetails:
              type: array
              items:
                description: >-
                  The details of the manner in which the entity is to receive
                  special care being contacted. In many cases, this was
                  specifically requested by the entity.
                properties:
                  description:
                    type: string
                    example: Do not call
                    description: >-
                      The manner in which the entity is to receive special care
                      when being contacted (e.g., do not call or do not send
                      information requests). In many cases, this was
                      specifically requested by the entity.
                  dnbCode:
                    type: integer
                    example: 7974
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      manner in which the entity is to receive special care from
                      Dun & Bradstreet when it is being contacted.
                type: object
            fullReportDate:
              type: string
              example: '2025-10-07T05:40:40Z'
              description: >-
                The most recent date when a complete review of all business
                information data was completed.<br/><br/>Format: YYYY-MM-DD or
                YYYY-MM
        primaryName:
          type: string
          example: GORMAN MANUFACTURING COMPANY, INC.
          description: >-
            The single name by which the entity is primarily known or
            identified.
        tradeStyleNames:
          type: array
          items:
            description: >-
              The details of the names that the entity trades under for
              commercial purposes although its registered legal name used for
              contracts and other formal situations may be another name.
            properties:
              name:
                type: string
                example: Alternate Company Name
                description: >-
                  The name that the entity trades under for commercial purposes 
                  although its registered legal name used for contracts and
                  other formal situations may be another name.
              priority:
                type: integer
                example: 1
                description: >-
                  The sequence in which the entity mostly uses this tradestyle
                  name.
            type: object
        websiteAddress:
          type: array
          items:
            description: >-
              The details of the internet URLs used for online information and
              communication with the entity.
            properties:
              url:
                type: string
                example: http://www.gorman.com
                description: >-
                  The Internet URL (Uniform Resource Locator) that uniquely
                  identifies the proprietary website of the entity or the
                  website preferred by the entity that gives more information on
                  the entity.
              domainName:
                type: string
                example: gorman.com
                description: >-
                  A unique name used to identify the website of the entity that
                  serves as an address to access that website.
            type: object
        telephone:
          type: array
          items:
            description: >-
              The details of the telephone information used for voice
              communication with the entity.
            properties:
              telephoneNumber:
                type: string
                example: 6505550000
                description: >-
                  A sequence of digits used for voice communication with the
                  entity.<br/>This sequence of digits includes the area code or
                  city code and domestic dialing code.
              isdCode:
                type: string
                example: 1
                description: >-
                  The country calling code assigned by the International
                  Telecommunication Union (ITU) required to connect to this
                  telephone number when dialing from outside the entity's
                  country (e.g., '1' for the US, '44' for the UK, '91' for
                  India).
              isUnreachable:
                type: boolean
                example: 'false'
                description: >-
                  Indicates whether the telephone number can be connected to
                  successfully.<br/><br/>- If true, connection to the  telephone
                  number is unsuccessful.<br/>- If false, connection to the 
                  telephone number is successful.
            type: object
        fax:
          type: array
          items:
            description: >-
              The details of the facsimile information used for data
              communication with the entity.
            properties:
              faxNumber:
                type: string
                example: 6505550001
                description: >-
                  A sequence of digits used for facsimile communication with the
                  entity.<br/>This sequence of digits includes the area code or
                  city code and domestic dialing code.
              isdCode:
                type: string
                example: 1
                description: >-
                  The country calling code assigned by the International
                  Telecommunication Union (ITU) required to connect to this
                  facsimile number when dialing from outside the entity's
                  country (e.g., '1' for the US, '44' for the UK, '91' for
                  India).
            type: object
        primaryAddress:
          type: object
          description: >-
            The details of the single primary or physical address at which the
            entity is located.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
                fipsCode:
                  type: string
                  example: US
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the country in which this address is
                    located.
            continentalRegion:
              type: object
              description: >-
                The details of the continental region in which this address is
                located.
              properties:
                name:
                  type: string
                  example: North America
                  description: >-
                    The name of the continental region for this
                    address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                    Pacific<br/>- Europe<br/>- Latin America<br/>- Middle
                    East<br/>- North America
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
                isoSubDivisionName:
                  type: string
                  description: >-
                    The official name of a principal subdivision (e.g province
                    or state) of countries coded in ISO 3166-1.
                  example: Yamanashi
                isoSubDivisionCode:
                  type: string
                  description: >-
                    The code assigned by ISO that represents the name of a
                    principal subdivision (e.g province or state) of countries
                    coded in ISO 3166-1.  This code is based on the two-letter
                    code element from ISO 3166-1 followed by a separator and up
                    to three alphanumeric characters.
                  example: JP-19
                fipsCode:
                  type: string
                  example: '06'
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the region in which this address is
                    located.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
                fipsCode:
                  type: string
                  example: 81
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the county in which this address is
                    located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
            latitude:
              type: number
              example: 37.777709
              description: >-
                The latitude component of the entity's location defined as the
                angular distance of the primary physical address north or south
                from the Earth's equator expressed in decimal numbers.
                <br/><br/>Positive numbers indicate degrees north. Negative
                numbers indicate degrees south.
            longitude:
              type: number
              example: -122.404624
              description: >-
                The longitude component of the entity's location defined as the
                angular distance of the primary physical address east or west
                from an imaginary line (called the prime meridian) that goes
                from the North Pole to the South Pole expressed in decimal
                numbers. <br/><br/>Positive numbers indicate degrees east.
                Negative numbers indicate degrees west.
            geographicalPrecision:
              type: object
              description: >-
                The details on how close the latitude and longitude coordinates
                for a location are to rooftop level.
              properties:
                description:
                  type: string
                  example: Street Segment Centroid
                  description: >-
                    The description of how close the latitude and longitude
                    coordinates for a location are to rooftop level.
                dnbCode:
                  type: integer
                  example: 30256
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify how
                    close the latitude and longitude coordinates for a location
                    are to &quot;rooftop&quot; level.
            isRegisteredAddress:
              type: boolean
              example: 'true'
              description: >-
                Indicates if the primary address is the same as the address of
                the entity as registered with a legal entity.  <br/>  <br/>- If
                true, the primary address is the same as the address of the
                entity as registered with a legal entity.<br/>- If false, the
                primary address is the not same as the address of the entity as
                registered with a legal entity.
            isResidentialAddress:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether or not the Primary Address is classified as
                residential by the governing postal authority<br/><br/>- If
                true, the primary address is classified as residential.<br/>- If
                false, the primary address is not classified as residential.
            statisticalArea:
              type: object
              description: >-
                The details of the various statistical facts associated with
                this address.
              properties:
                cbsaName:
                  type: string
                  example: San Francisco-Oakland-Hayward CA
                  description: >-
                    The name assigned to the 5-digit CBSA (Core Based
                    Statistical Area) assigned by US Census board to denote a
                    geographical region with a relatively high population
                    density at its core and close economic ties throughout the
                    area.
                cbsaCode:
                  type: string
                  example: 41860
                  description: >-
                    The 5-digit CBSA (Core Based Statistical Area) code assigned
                    by US Census board to denote a geographical region with a
                    relatively high population density at its core and close
                    economic ties throughout the area.
                economicAreaOfInfluenceCode:
                  type: string
                  example: 146
                  description: >-
                    A code assigned by the U.S Bureau of Economic Analysis to
                    identify the entity's regional market that surrounds a
                    metropolitan or micropolitan statistical area serving as a
                    regional center of economic activity.
                populationRank:
                  type: object
                  description: >-
                    The details of the statistical facts about population based
                    on region's rank.
                  properties:
                    rankNumber:
                      type: string
                      example: 9
                      description: >-
                        A number classifying the geographic area in which the
                        entity is located based on the resident
                        population.<br/><br/>Values: 0 to 9<br/>0 denotes the
                        lowest population range; 9 denotes the highest.
                    rankDnBCode:
                      type: integer
                      example: 10961
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the population for the geographical area in which this
                        address is located.
                    rankDescription:
                      type: string
                      example: 500,000 +
                      description: >-
                        A range of the population for the geographical area
                        where the entity is located.
            locationOwnership:
              type: object
              description: >-
                The details of the terms under which the entity occupies the
                premises.
              properties:
                description:
                  type: string
                  example: Rents
                  description: >-
                    Description of the terms under which the entity occupies the
                    premises (e.g., owned, rented, leased).
                dnbCode:
                  type: integer
                  example: 1129
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    terms under which the entity occupies the premises.
            premisesArea:
              type: object
              description: The details of space the entity utilizes at this address.
              properties:
                measurement:
                  type: number
                  example: 10034
                  description: >-
                    A number portion of the amount to of space the entity
                    occupies at this address (e.g., the 2000 in 2000 square
                    meters).
                unitDescription:
                  type: string
                  example: square foot
                  description: >-
                    The measurement unit used to express the premises area
                    measurement (e.g., acre, square meters, square feet).
                unitDnBCode:
                  type: integer
                  example: 3848
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    measurement unit used to express the premises area
                    measurement.
                reliabilityDescription:
                  type: string
                  example: Actual
                  description: >-
                    The accuracy of the measurement (e.g., actual, estimated,
                    modeled).
                reliabilityDnBCode:
                  type: integer
                  example: 9092
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    accuracy of the measurement.
            isManufacturingLocation:
              type: boolean
              example: 'true'
              description: >-
                Indicates if manufacturing activity is performed at this
                facility by the entity.<br/><br/>- If true, the entity performs
                manufacturing activity at this facility.<br/>- If false, the
                entity does not performs manufacturing activity at this
                facility.
        registeredAddress:
          type: object
          description: >-
            The details of the official address of the entity as registered with
            a local or national registry to which all official correspondence
            must be sent.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
                line3:
                  type: string
                  example: Address line 3
                  description: The third line of the address where the entity is located.
                line4:
                  type: string
                  example: Address line 4
                  description: The forth line of the address where the entity is located.
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
        mailingAddress:
          type: object
          description: The details of the address used by the entity for mailing purposes.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
            continentalRegion:
              type: object
              description: >-
                The details of the continental region in which this address is
                located.
              properties:
                name:
                  type: string
                  example: North America
                  description: >-
                    The name of the continental region for this
                    address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                    Pacific<br/>- Europe<br/>- Latin America<br/>- Middle
                    East<br/>- North America
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            postalRoute:
              type: string
              example: route 3B
              description: >-
                A code assigned by the local postal authority that sorts mail
                pieces to the individual carrier routes within a postal code.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
        stockExchanges:
          type: array
          items:
            description: >-
              The details of the Stock Exchanges on which the entity's shares
              are traded.
            properties:
              tickerName:
                type: string
                example: NYSE:DNB
                description: >-
                  Text by which the entity is identified on this Stock Exchange
                  for share trading purposes.
              exchangeName:
                type: object
                description: >-
                  The details of the name of the Stock Exchange on which the
                  entity's shares are traded.
                properties:
                  description:
                    type: string
                    example: NYSE
                    description: The name the Stock Exchange.
              exchangeCountry:
                type: object
                description: The details of the country of the Stock Exchange.
                properties:
                  isoAlpha2Code:
                    type: string
                    example: US
                    description: >-
                      The two-letter country code, defined by the International
                      Organization for Standardization (ISO) ISO 3166-1 scheme
                      identifying the country of the Stock Exchange.
              isPrimary:
                type: boolean
                example: 'true'
                description: >-
                  Indicates if this is the most important stock exchange among
                  all the stock exchange where the entity's shares are traded.
                  <br/><br/>- If true, indicates that this is the most important
                  Stock Exchange.<br/>- If false, indicates that this is not the
                  most important Stock Exchange.
            type: object
        thirdPartyAssessment:
          type: array
          items:
            description: >-
              The details of the appraisal or opinion assigned to the entity by
              an organization other than the Dun & Bradstreet Worldwide Network
              (WWN).
            properties:
              description:
                type: string
                example: Fortune 500 Revenue Rank
                description: >-
                  The kind of appraisal, opinion, or rank that was assigned to
                  the entity by the third party (e.g., Moody's Long Term
                  Obligation Rating, FICO score, Vantage Score).
              dnbCode:
                type: integer
                example: 23290
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of assessment.
              assessmentDate:
                type: string
                example: 2017
                description: >-
                  The date on which the assessment value was assigned by the
                  third party.
              value:
                type: string
                example: 31
                description: >-
                  The value for the appraisal, opinion, or rank that was
                  assigned by the third party.
            type: object
        registrationNumbers:
          type: array
          items:
            description: >-
              The details of the numbers assigned by an external body or by Dun
              & Bradstreet that either uniquely identifies or helps to identify
              the entity.
            properties:
              registrationNumber:
                type: string
                example: 12-3456789
                description: >-
                  The number assigned by an external body or by Dun & Bradstreet
                  that either uniquely identifies or helps to identify the
                  entity.
              typeDescription:
                type: string
                example: Federal Taxpayer Identification Number (US)
                description: >-
                  The type of registration (e.g., Chamber of Commerce Number,
                  Value Added Tax Number, Federal Taxpayer Identification
                  Number, Companies Registry Office Number).
              typeDnBCode:
                type: integer
                example: 6863
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of registration number.
            type: object
        industryCodes:
          type: array
          items:
            description: >-
              The details of the business activities in which the entity is
              actively engaged using standardized coding schemes such as
              European NACE and U.S. Standard Industry Classifications (SIC).
            properties:
              code:
                type: string
                example: 323111
                description: >-
                  The code that identifies the business activity in which the
                  entity is engaged.  <br/><br/>For example, 1611 represents the
                  highway and street construction industry in the U.S. SIC
                  (Standard Industrial Classification) system.<br/><br/>Note:
                  These are generally external codes created by an external
                  authoritative body, like the U.S. Office of Management and
                  Budget (OMB); however, Dun & Bradstreet may have created
                  extensions to more precisely define an activity, as in the
                  case of the SIC 2+2 (the last 4 digits of an 8-digit SIC).
              description:
                type: string
                example: 'Commercial Printing '
                description: >-
                  The business activity description as assigned by the coding
                  scheme used.
              typeDescription:
                type: string
                example: North American Industry Classification System 2012
                description: >-
                  The industry coding scheme used for this Industry Code (e.g.,
                  U.S. Standard Industrial Classification (SIC) 1987, Standard
                  Industry Code - 8 digit, North American Industry
                  Classification System (NAICS), Nomenclature Generale des
                  Activites Economiques dans L`Union Europeenne (NACE)).
              typeDnBCode:
                type: integer
                example: 24664
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  industry coding scheme.
              priority:
                type: integer
                example: 1
                description: >-
                  A number identifying the order in which this industry code
                  should be presented relative to other industry codes of the
                  same type where the lower the number the earlier the data is
                  presented.
            type: object
        businessEntityType:
          type: object
          description: >-
            The details of the legal form or structure of the entity as
            registered with government authorities.
          properties:
            description:
              type: string
              example: Corporation
              description: >-
                The name of the legal form or structure of the entity as
                registered with government authorities (e.g., partnership,
                corporation, private limited company, government department,
                proprietorship).
            dnbCode:
              type: integer
              example: 451
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the legal
                form or structure of the entity as registered with government
                authorities.
        controlOwnershipDate:
          type: string
          example: 1985
          description: The date when the current owners took over the entity.
        startDate:
          type: string
          example: 1985
          description: >-
            The date the entity chooses to claim as its established date.
            <br/><br/>Note: This date may be different from the Operations Start
            Date.
        controlOwnershipType:
          type: object
          description: The details of the type of controlling ownership.
          properties:
            description:
              type: string
              example: Privately owned
              description: >-
                The name for the type of controlling ownership (e.g., publicly
                owned, privately owned, state owned).   <br/><br/>Note:  For
                some countries, controlling ownership can be derived from the
                legal form.
            dnbCode:
              type: integer
              example: 9058
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of controlling ownership.
        isAgent:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity acts as an agent promoting the goods or
            services of another entity (e.g., Sales Agent, Purchasing Agent).
            <br/><br/>- If true, the entity acts as an agent.<br/>- If false,
            the entity does not act as an agent.
        isImporter:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is an importer.<br/><br/>- If true, the
            entity imports a quantity of goods from other countries.<br/>- If
            false, the entity does not import a quantity of goods from other
            countries.
        isExporter:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is an exporter.<br/><br/>- If true, the
            entity exports a quantity of goods to other countries.<br/>- If
            false, the entity does not export a quantity of goods to other
            countries.
        numberOfEmployees:
          type: array
          items:
            description: >-
              The details of the people engaged by the entity to perform its
              operations.
            properties:
              value:
                type: integer
                example: 1234
                description: >-
                  The total number of people engaged by the entity to perform
                  its operations.  The scope of this employee figure is
                  identified in informationScopeDescription.
              informationScopeDescription:
                type: string
                example: Consolidated
                description: >-
                  The scope of Number of Employees value (e.g., Consolidated,
                  Individual, HQ only).
              informationScopeDnBCode:
                type: integer
                example: 9067
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  scope of Number of Employees.
              reliabilityDescription:
                type: string
                example: Actual
                description: >-
                  The integrity of the employee figures (e.g., audited, actual,
                  estimated, or modeled).
              reliabilityDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the employee figures.
              employeeCategories:
                type: array
                items:
                  description: >-
                    The details of the employee figures for the different
                    function levels of the entity.
                  properties:
                    employmentBasisDescription:
                      type: string
                      example: Principals
                      description: >-
                        The type of employees that have been included in the
                        calculation of the number of employees on the basis of
                        their employment contract (e.g., Principals, Part Time
                        Workers).
                    employmentBasisDnBCode:
                      type: integer
                      example: 9064
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the employment basis description.
                  type: object
              trend:
                type: array
                items:
                  description: The details of the employee growth  history.
                  properties:
                    timePeriod:
                      type: object
                      description: >-
                        The details of timeframe for which this data is
                        recorded.
                      properties:
                        description:
                          type: string
                          example: 1 - 5 years
                          description: The timeframe for which this data is recorded.
                        dnbCode:
                          type: integer
                          example: 13721
                          description: >-
                            A unique code assigned by Dun & Bradstreet to
                            identify the timeframe for which this data is
                            recorded.
                    growthRate:
                      type: number
                      example: -7
                      description: >-
                        The percentage of change in number of employees from
                        base year compared to the trend year.
                  type: object
            type: object
        financials:
          type: array
          items:
            description: >-
              The details of the standardized view of the financial results of
              the entity; this is usually extracted from a set of accounts.
            properties:
              financialStatementToDate:
                type: string
                example: '2025-10-07T05:40:40Z'
                description: >-
                  The date when the accounting period ended.  If the Reliability
                  Code denotes the figures are projected (future), then this is
                  the date when the accounting period will end.<br/><br/>Format:
                  YYYY-MM-DD or YYYY-MM
              financialStatementDuration:
                type: string
                example: Annual
                description: >-
                  The period of the financial statement expressed as a time
                  interval.
              informationScopeDescription:
                type: string
                example: Actual
                description: >-
                  The organizational scope of the financial summary (e.g.,
                  Individual (Organization including any branches), Consolidated
                  (Organization including any branches and subsidiaries)).
              informationScopeDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the financial summary.
              reliabilityDescription:
                type: string
                example: Actual
                description: >-
                  The integrity of the financial figures (e.g., audited, actual,
                  estimated, or modeled).
              reliabilityDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the financial figures.
              unitCode:
                type: string
                example: Single Units
                description: >-
                  The unit of size in which the financial summary figures are
                  provided (e.g., in 1,000s; in 1,000,000s)
              accountantName:
                type: string
                example: Johnson, Jordan & Jones CPAs
                description: The name of either an individual or an accounting firm.
              yearlyRevenue:
                type: array
                items:
                  description: >-
                    The details of the income received from customers from the
                    sale of the entity''s goods and/or services. This is the
                    gross sales minus any returns, rebates/discounts, allowances
                    for damages or shortages, shipping expenses passed on to the
                    customer, and amounts due where there is not a reasonable
                    expectation of collection.
                  properties:
                    value:
                      type: number
                      example: 19945238
                      description: >-
                        The monetary value of income received from customers
                        from the sale of the entity's goods and/or services. 
                        This is the gross sales minus any returns,
                        rebates/discounts, allowances for damages or shortages,
                        shipping expenses passed on to the customer.
                    currency:
                      type: string
                      example: USD
                      description: >-
                        The three-letter currency code, defined in the ISO
                        3166-1 scheme published by International Organization
                        for Standardization (ISO) identifying the type of money
                        in which this amount is expressed (e.g. USD, CAD, GBP,
                        EUR).
                    trend:
                      type: array
                      items:
                        description: >-
                          The details of the percentage of change of this item
                          as of base year compared to the trend year.
                        properties:
                          timePeriod:
                            type: object
                            description: >-
                              The details of the timeframe for which this data
                              is recorded.
                            properties:
                              description:
                                type: string
                                example: 1-5 years
                                description: The timeframe for which this data is recorded.
                              dnbCode:
                                type: integer
                                example: 13721
                                description: >-
                                  A unique code assigned by Dun & Bradstreet to
                                  identify the timeframe in which this data is
                                  recorded.
                          growthRate:
                            type: number
                            example: 2
                            description: >-
                              The percentage of change of this item as of base
                              year compared to the trend year.
                        type: object
                  type: object
            type: object
        mostSeniorPrincipals:
          type: array
          items:
            description: The  details of the most important principals.
            properties:
              givenName:
                type: string
                example: Leslie
                description: The given name of the principal.
              familyName:
                type: string
                example: Smith
                description: The family name of the principal.
              fullName:
                type: string
                example: Leslie Ann Smith
                description: The complete name of the principal.
              namePrefix:
                type: string
                example: Dr.
                description: >-
                  The correct form of address for the principal (e.g., Dr.,
                  Professor, Lord).
              nameSuffix:
                type: string
                example: PhD
                description: The familial or professional suffix to the principal's name.
              gender:
                type: string
                example: Female
                description: The gender of this individual.
              jobTitles:
                type: array
                items:
                  description: The details of the positions held by this individual.
                  properties:
                    title:
                      type: string
                      example: President
                      description: The position held by this individual.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  description: >-
                    The details of the current business functions of the entity
                    represented as a standard Management Responsibility Code
                    (MRC).
                  properties:
                    description:
                      type: string
                      example: President
                      description: >-
                        Name of the business function of the entity derived from
                        a standard Management Responsibility Code (MRC).
                    mrcCode:
                      type: string
                      example: A1A6
                      description: >-
                        A unique code identifying the business function of the
                        entity derived from a standard Management Responsibility
                        Code (MRC).
                  type: object
            type: object
        currentPrincipals:
          type: array
          items:
            description: >-
              The details of the principals that are actively associated with
              the entity.
            properties:
              givenName:
                type: string
                example: Leslie
                description: The given name of the principal.
              familyName:
                type: string
                example: Smith
                description: The family name of the principal.
              fullName:
                type: string
                example: Leslie Ann Smith
                description: The complete name of the principal.
              namePrefix:
                type: string
                example: Dr.
                description: >-
                  The correct form of address for the principal (e.g., Dr.,
                  Professor, Lord).
              nameSuffix:
                type: string
                example: PhD
                description: The familial or professional suffix to the principal's name.
              gender:
                type: string
                example: Female
                description: The gender of this individual.
              jobTitles:
                type: array
                items:
                  description: The details of the positions held by this individual.
                  properties:
                    title:
                      type: string
                      example: President
                      description: The position held by this individual.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  description: >-
                    The details of the current business functions of the entity
                    represented as a standard Management Responsibility Code
                    (MRC).
                  properties:
                    description:
                      type: string
                      example: President
                      description: >-
                        Name of the business function of the entity derived from
                        a standard Management Responsibility Code (MRC).
                    mrcCode:
                      type: string
                      example: A1A6
                      description: >-
                        A unique code identifying the business function of the
                        entity derived from a standard Management Responsibility
                        Code (MRC).
                  type: object
            type: object
        socioEconomicInformation:
          type: object
          description: >-
            The details of the categorization of the entity in Socio Economic or
            Statistical groups.
          properties:
            isMinorityOwned:
              type: boolean
              example: 'false'
              description: >-
                Indicates if the entity is minority owned.  Minority owned means
                it is certified as an entity that is greater than 50% owned by
                and whose management and daily operations are controlled by one
                or more minority group members<br/><br/>- If true, indicates
                that this is a minority-owned entity.<br/>- If false, indicates
                that this is not a minority-owned entity.
            isSmallBusiness:
              type: boolean
              example: 'false'
              description: >-
                Indicates if the business qualifies as small business, eligible
                for assistance from SBA, with a place of business located in the
                United States. It must operate primarily within the United
                States or make a significant contribution to the U.S. economy
                through payment of taxes or use of American products, materials
                or labor. Together with its affiliates, it must meet the
                numerical size standards as defined in the Small Business Size
                Regulations 13 CFR 121.<br/><br/>- If true, indicates that this
                is a small business.<br/>- If false, indicates that this is not
                a small business.
        isStandalone:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is a member of a legal family tree.
            <br/><br/>- If true, indicates that the entity is not a member of a
            legal family tree.  This means it cannot play any family tree role
            and corporateLinkage will not be present.<br/>- If false, indicates
            that the entity is a member of a legal family tree.  The roles it
            plays is indicated by Family Tree Member Roles played.
        corporateLinkage:
          type: object
          description: >-
            The details of the relationship between the entity and other
            entities in the legal family tree.
          properties:
            familytreeRolesPlayed:
              type: array
              items:
                description: >-
                  The details of the roles the entity plays as a member of an
                  ownership structured family tree.
                properties:
                  description:
                    type: string
                    example: Parent/Headquarters
                    description: >-
                      The role the entity plays as a member of an ownership
                      structured family tree (e.g., a branch, division, a
                      parent, headquarters, subsidiary, global ultimate,
                      domestic ultimate).
                  dnbCode:
                    type: integer
                    example: 9141
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify
                      describing family tree role.
                type: object
            hierarchyLevel:
              type: integer
              example: 1
              description: >-
                The number of family-tree levels below the global ultimate the
                entity is in its corporate hierarchy. The hierarchy level value
                of the global ultimate will always be 1. Each subsidiary level
                below the global ultimate is incremented by 1. Branch locations
                in a family tree will have the same hierarchy code as its
                associated headquarter.
            globalUltimateFamilyTreeMembersCount:
              type: integer
              description: >-
                The total number of entities in the entity's Family tree
                starting from Global Ultimate.
              example: '4'
            globalUltimate:
              type: object
              description: >-
                The details of the top most entity in the family tree, tracing
                each parent up to its own parent.  <br/><br/>For example,
                Company-A is based in the US and has Company-B as its parent
                also in the US. In turn Company-B is owned by Company-C, also in
                the US, which is owned by Company-D which is in the UK. Thus,
                the Global Ultimate of this family tree (and therefore of each
                member of the family tree) is Company-D.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            domesticUltimate:
              type: object
              description: >-
                The details of the Domestic Ultimate which is the last entity in
                the tree, when reviewing upwards, that is in the same country as
                the entity. <br/><br/>For example, Company-A is based in the US
                and has Company-B as its parent also in the US. In turn
                Company-B is owned by Company-C, also in the US, which is owned
                by Company-D which is in the UK. Thus, the Domestic Ultimate of
                Company-A is actually Company-C as this is the last entity in
                the parent chain that is in the US.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      example: ''
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            parent:
              type: object
              description: >-
                The details of the entity that owns more than 50% of the subject
                entity.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            headQuarter:
              type: object
              description: >-
                The details of the office that serves as the administrative
                center for the entity.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
        shareOwnership:
          type: array
          items:
            description: >-
              The details of the recording of the individual, organization or
              entity that owns stock or common stock of the subject
              organization.
            properties:
              duns:
                type: string
                example: '804735132'
                description: >-
                  When a shareholder is a business, Dun & Bradstreet may assign
                  a D-U-N-S Number to the company that owns stock or common
                  stock of the subject entity.  The D-U-N-S Number is an
                  identification number that uniquely identifies the
                  organization in accordance with the Data Universe Numbering
                  System (D-U-N-S).  Presence of a D-U-N-S Number is not a
                  requirement to be a shareholder.
              primaryName:
                type: string
                example: GORMAN MANUFACTURING COMPANY, INC.
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
              primaryAddress:
                type: object
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
                properties:
                  addressCountry:
                    type: object
                    description: >-
                      The details of the country or region where the address of
                      the organization is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: United States
                        description: >-
                          The Country or Region where the organization's Primary
                          Address is located or conducts operations .
                      isoAlpha2Code:
                        type: string
                        example: US
                        description: >-
                          The 2 letter alpha country code assigned by the
                          International Organization for Standardization (ISO)
                          identifying the Country/Region where the
                          organization's Primary address is located or conducts
                          operations .
                  continentalRegion:
                    type: object
                    description: >-
                      The details of the Continent in which the Primary Address
                      of the organisation is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: North America
                        description: >-
                          The name of the continent where the Primary Address of
                          the organization is located or conducts
                          operations.<br/>Possible values <br/>Africa<br/>Asia
                          Pacific<br/>Europe<br/>North America<br/>Middle
                          East<br/>South America
                  addressLocality:
                    type: object
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                    properties:
                      name:
                        type: string
                        example: SAN FRANCISCO
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                  addressRegion:
                    type: object
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                    properties:
                      name:
                        type: string
                        example: California
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                      abbreviatedName:
                        type: string
                        example: CA
                        description: >-
                          The shortened name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations For example NJ for the US State New Jersey
                          within Country United States.
                  postalCode:
                    type: string
                    example: '941109999'
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                  streetAddress:
                    type: object
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                    properties:
                      line1:
                        type: string
                        example: 492 KOLLER ST
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                      line2:
                        type: string
                        example: Suite 100
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
              ownershipPercentage:
                type: number
                example: 8.56
                description: >-
                  The total percent of the subject organization's stock or
                  common stock owned by either an individual, organization with
                  DUNS or direct entity shareholder.
            type: object
        affiliates:
          type: array
          items:
            description: >-
              The details of other entities relationships to the subject entity
              typically identified when the affiliated entity has no legal
              obligation for the debts of the subject entity (e.g., Franchises,
              agents, dealers, associations, healthcare networks).
            properties:
              duns:
                type: string
                example: '804735132'
                description: >-
                  The D-U-N-S Number, a proprietary organizational identifier
                  owned and managed by Dun & Bradstreet Inc, provides unique
                  identification of a subject organization, in accordance with
                  the Data Universal Numbering System (D-U-N-S).
              primaryName:
                type: string
                example: GORMAN MANUFACTURING COMPANY, INC.
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
              primaryAddress:
                type: object
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
                properties:
                  addressCountry:
                    type: object
                    description: >-
                      The details of the country or region where the address of
                      the organization is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: United States
                        description: >-
                          The Country or Region where the organization's Primary
                          Address is located or conducts operations .
                      isoAlpha2Code:
                        type: string
                        example: US
                        description: >-
                          The 2 letter alpha country code assigned by the
                          International Organization for Standardization (ISO)
                          identifying the Country/Region where the
                          organization's Primary address is located or conducts
                          operations .
                  continentalRegion:
                    type: object
                    description: >-
                      The details of the Continent in which the Primary Address
                      of the organisation is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: North America
                        description: >-
                          The name of the continent where the Primary Address of
                          the organization is located or conducts
                          operations.<br/>Possible values <br/>Africa<br/>Asia
                          Pacific<br/>Europe<br/>North America<br/>Middle
                          East<br/>South America
                  addressLocality:
                    type: object
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                    properties:
                      name:
                        type: string
                        example: SAN FRANCISCO
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                  addressRegion:
                    type: object
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                    properties:
                      name:
                        type: string
                        example: California
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                      abbreviatedName:
                        type: string
                        example: CA
                        description: >-
                          The shortened name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations For example NJ for the US State New Jersey
                          within Country United States.
                  postalCode:
                    type: string
                    example: '941109999'
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                  streetAddress:
                    type: object
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                    properties:
                      line1:
                        type: string
                        example: 492 KOLLER ST
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                      line2:
                        type: string
                        example: Suite 100
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
              associationType:
                type: object
                description: >-
                  The details of the nature of association of this entity with
                  subject entity.
                properties:
                  dnbCode:
                    type: integer
                    example: 30488
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      nature of association of this entity with subject
                      entity.<br/>Refer to Reference code table "511
                      [Affiliation Type]" for all possible values.
                  description:
                    type: string
                    example: Dealer Alternate Linkage
                    description: >-
                      The nature of association of this entity with subject
                      entity (e.g., Franchise, Agent).
              franchiseName:
                type: string
                example: Franchise
                description: The franchising branch.
              franchiseID:
                type: string
                example: '1058890509'
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify a
                  franchising brand.
            type: object
        extendedLinkageInsight:
          type: object
          description: >-
            Records data collected from a Dun & Bradstreet Artificial
            Intelligence-driven hierarchy solution that utilizes Machine
            Learning to link businesses as a linkage expert would and capture a
            wide spectrum of potential relationship including majority
            ownership, minority ownership, franchise, dealership and much more.
          properties:
            brandName:
              type: string
              example: DUN&BRADSTREET
              description: >-
                The brand name of DUNS extracted by Extended Linkage algorithm.
                For example, if the Business Name is "The Dun & Bradstreet
                Corporation", then Brand Name will be "DUN&BRADSTREET".
            familyTreeCount:
              type: integer
              example: 145
              description: >-
                The total number of Extended Linkage Family members (i.e. The
                number of records in whole database with the same Extended
                Linkage Global Ultimate DUNS Number as the current records.)
            globalUltimate:
              type: object
              description: >-
                Records details of the Global Ultimate that is within the
                Extended Linkage Family.
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The Duns number of the Global Ultimate that is within the
                    Extended Linkage Family.
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Global Ultimate that is within the
                    Extended Linkage Family.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    global ultimate within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            domesticUltimate:
              type: object
              description: >-
                Records details of the Domestic Ultimate that is within the
                Extended Linkage Family.
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The Duns number of the Domestic Ultimate that is within the
                    Extended Linkage Family.
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Domestic Ultimate that is within
                    the Extended Linkage Family.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    domestic ultimate within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            parent:
              type: object
              description: >-
                Records details of the Parent that is within the Extended
                Linkage Family
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The DUNS number of the Parent that is within the Extended
                    Linkage Family
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Parent that is within the Extended
                    Linkage Family
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    parent company within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            linkageSourceCategory:
              type: integer
              example: 6
              description: >-
                This code indicates the source of linkage:<br/>Code "9" is
                assigned when majority ownership linkage is present.<br/>Code
                "8" is assigned when a local market linkage is present.<br/>Code
                "7" is assigned when an alternative linkage is
                present.<br/>Codes "3" to "6" are assigned whenever a modeled
                relationship is present.            Note: The source codes of 3
                - 6 are correlated with ELI Name Evidence, SIC Evidence, Brand
                Evidence, Phone Evidence, CEO Evidence and etc. The more
                evidences we've seen in those scores, the higher the source code
                will be.
            associationType:
              type: object
              description: >-
                Records the type of association and that is intended to provide
                insights into the nature of the relationship between the
                entities. it is sourced from alternative linkage when
                alternative linkage is present. When alternative linkage is not
                present, type is inferred by the model based on the brand name
                extracted and the childs line of business.
              properties:
                description:
                  type: string
                  example: Agent Alternate Linkage
                  description: >-
                    Text that indicates the type of association and that is
                    intended to provide insights into the nature of the
                    relationship between the entities. it is sourced from
                    alternative linkage when alternative linkage is present.
                dnbCode:
                  type: integer
                  example: 30487
                  description: >-
                    A unique code assigned by Dun & Bradstreet that indicates
                    the type of association and that is intended to provide
                    insights into the nature of the relationship between the
                    entities. it is sourced from alternative linkage when
                    alternative linkage is present.<br/>Refer to Reference code
                    table "511 [Affiliation Type]" for all possible values.
            nameEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using name.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using name.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using name.<br/>Refer to Reference code
                    table "354 [Range Position]" for all possible values.
            brandEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using brand name.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using brand name.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using brand name.<br/>Refer to Reference
                    code table "354 [Range Position]" for all possible values.
            industryEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using industry code.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using industry code.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using industry code.<br/>Refer to
                    Reference code table "354 [Range Position]" for all possible
                    values.
            locationEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using address.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using address.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using address.<br/>Refer to Reference
                    code table "354 [Range Position]" for all possible values.
            ceoEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using most senior principal data.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using most senior
                    principal data.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using most senior principal
                    data.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            principalNameEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using current principal data.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using current principal
                    data.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using current principal data.<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            telephoneEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using telephone information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using telephone
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using telephone information.<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            webDomainEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using website domain information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using website domain
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using website domain
                    information.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            webPageEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using website home page information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using website home page
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using website home page
                    information..<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            financialReportEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using financial statements.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using financial
                    statements.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using financial statements..<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            wikipediaEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using company's Wikipedia web page.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using company's
                    Wikipedia web page.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using company's Wikipedia web
                    page.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            feedbackEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using D&B internal expert or customer
                feedback.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using D&B internal
                    expert or customer feedback.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using D&B internal expert or customer
                    feedback.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
    CmpelkV2:
      type: object
      description: The details of the entity.
      properties:
        transactionDetail:
          type: object
          description: The information used to process this request.
          properties:
            transactionID:
              description: >-
                A value assigned by the Dun & Bradstreet application to uniquely
                identify this request.
              type: string
              example: rlh-hi9puyoijk-jop8u-kd-d-1
            transactionTimestamp:
              description: >-
                The date and time, in ISO 8601 UTC Z standard, when this
                response was created.
              type: string
              example: '2025-10-07T05:40:40Z'
            inLanguage:
              description: >-
                An IETF BCP 47 code value that defines the language in which
                this product was rendered.
              type: string
              example: en-US
            productID:
              description: The ID of the product used to create the response.
              type: string
              example: PRODID
            productVersion:
              description: The version of the product used to create the response.
              type: string
              example: 1
        inquiryDetail:
          type: object
          description: The criteria used to process this request.
          properties:
            duns:
              type: string
              example: 804735132
              description: The D-U-N-S number provided in the request.
            productID:
              type: string
              example: PRODID
              description: The ID of the product used to produce the response.
            productVersion:
              type: string
              example: v1
              description: The product version number provided in the request.
            tradeUp:
              type: string
              example: hq
              description: The value of the tradeUp parameter provided in the request.
            customerReference:
              type: string
              example: Some text to describe the request.
              description: >-
                A reference string provided by the customer to be linked to the
                product in order to support subsequent order reconciliation.
        organization:
          $ref: '#/components/schemas/CmpelkV2Organization'
    DataBlockOrganization:
      type: object
      properties:
        duns:
          type: string
          description: >-
            The D-U-N-S Number, a proprietary organizational identifier owned
            and managed by Dun & Bradstreet Inc, provides unique identification
            of a subject organization, in accordance with the Data Universal
            Numbering System (D-U-N-S).
          example: '804735132'
        countryISOAlpha2Code:
          type: string
          description: >-
            The two-letter country code, defined by the International
            Organization for Standardization (ISO) ISO 3166-1 scheme,
            identifying the country in which the entity is located.
          example: US
        primaryName:
          type: string
          description: >-
            Single name by which the organization is primarily known or
            identified.
          example: GORMAN MANUFACTURING COMPANY, INC.
        dunsControlStatus:
          type: object
          properties:
            operatingStatus:
              type: object
              description: >-
                The high level categorization of the entity's functional state
                or trading status.
              properties:
                description:
                  type: string
                  description: >-
                    The entity's functional state or trading status summarized
                    into either active or out of business.
                  example: Active
                dnbCode:
                  type: integer
                  description: |
                    A unique code assigned by Dun & Bradstreet
                    to identify the entity''s functional state or trading
                    status.`<br/>Possible values: <br/>9074 [Active]<br/>403
                    [Out of Business]<br/>` Refer to Reference code table
                    "166 [Operating Status]" for all possible values.
                  example: '9074'
                startDate:
                  type: string
                  description: >-
                    A date identifying the beginning of the time period in which
                    this Operating Status is or was applicable.
                  example: '2025-10-07T05:40:40Z'
            operatingSubStatus:
              type: object
              description: Records the specific status of the subject company.
              properties:
                description:
                  type: string
                  description: Textual description of the specific status of the company.
                  example: Out of business - Favourable
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet denoting the
                    specific status of the company.<br/>Refer to Reference code
                    table "166 [Operating Status]" for all possible values.
                  example: '9077'
                startDate:
                  type: string
                  description: >-
                    The date when this specific status of the company was
                    recorded.
                  example: '2025-10-07T05:40:40Z'
            detailedOperatingStatus:
              type: object
              description: >-
                Records the further low level status of the subject company, in
                terms of its operations.
              properties:
                description:
                  type: string
                  description: >-
                    Textual description of the detailed operating status of the
                    company.
                  example: Operationally Active
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet denoting the
                    detailed operating status of the company.<br/>Refer to
                    Reference code table "732 [Detailed Operating Status]" for
                    all possible values.
                  example: '29929'
            isMarketable:
              type: boolean
              description: >-
                Indicates whether the data on the entity satisfies Dun &
                Bradstreet's marketability rules for Sales & Marketing Solutions
                products. <br/><br/>- If true, the entity data satisfies the
                marketability rules.<br/>- If false, the entity data does not
                satisfy the marketability rules.
              example: 'true'
            isMailUndeliverable:
              type: boolean
              description: "Indicates whether it is possible to deliver mail to the address of this entity.\r<br/>\r<br/>- If true, it is not possible to deliver mail to at least one of the addresses listed for this DUNS (Primary, Mailing or Registered).<br/>- If false, it is possible to deliver mail to the address."
              example: 'false'
            isTelephoneDisconnected:
              type: boolean
              description: >-
                Indicates whether the telephone number can be connected to
                successfully.<br/><br/>- If true, connection to the telephone
                number is unsuccessful.<br/>- If false, connection to the
                telephone number is successful.
              example: 'false'
            isDelisted:
              type: boolean
              description: >-
                Indicates whether the entity has requested that they not be
                included in any Direct marketing lists (e.g., mailing,
                telephone).<br/><br/>- If true, the entity has objected to and
                MUST NOT receive direct marketing material.<br/>- If false, the
                entity has not objected to receiving direct marketing material.
              example: 'false'
            subjectHandlingDetails:
              type: array
              items:
                type: object
                description: >-
                  The details of the manner in which the entity is to receive
                  special care being contacted. In many cases, this was
                  specifically requested by the entity.
                properties:
                  description:
                    type: string
                    description: >-
                      The manner in which the entity is to receive special care
                      when being contacted (e.g., do not call or do not send
                      information requests). In many cases, this was
                      specifically requested by the entity.
                    example: Do not call.
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      manner in which the entity is to receive special care from
                      Dun & Bradstreet when it is being contacted.<br/>Refer to
                      Reference code table "199 [Subject Handling]" for all
                      possible values.
                    example: '7974'
            firstReportDate:
              type: string
              description: >-
                The date when the first complete review of all Business
                Information Report data was updated about the business.
              example: '2025-10-07T05:40:40Z'
            recordClass:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text denoting the classification of the company data
                    maintained in the D&B database.
                  example: Full DMI record
                dnbCode:
                  type: integer
                  description: >-
                    A unique identifier assigned by D&B to denote the
                    classification of the company data maintained in the D&B
                    database.<br/>Refer to Reference code table "240 [Record
                    Class]" for all possible values.
                  example: 10928
              description: >-
                Records the classification of the company data maintained in the
                D&B database.
            isSelfRequestedDUNS:
              type: boolean
              description: >-
                When turned ON (Set to TRUE), it indicates that the D-U-N-S
                Number for this subject was created at the request of the
                subject.<br/><br/>When turned OFF (Set to FALSE), it indicates
                that the D-U-N-S Number for this subject was not created at the
                request of the <br/>subject.; however as this is the assumed
                condition there is no requirement to create this tag to
                represent this fact.
              example: true
            selfRequestDate:
              type: string
              description: The date when the subject requested a D-U-N-S number for itself.
              example: '2025-10-07T05:40:40Z'
          description: >-
            The details of the organization's functional state and controls that
            impact its suitability for various usage purposes.
        registeredName:
          type: string
          description: >-
            The legally recognized name by which the organizationis registered
            with a local or national Registry.
          example: GORMAN MANUFACTURING COMPANY, INC.
        multilingualPrimaryName:
          type: array
          items:
            type: object
            description: >-
              The details of the name by which the entity is primarily known or
              identified presented in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 39
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: The name by which the entity is primarily known or identified.
                example: GORMAN
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        multilingualRegisteredNames:
          type: array
          items:
            type: object
            description: >-
              Records the name of the company as recorded in the official
              registry, if available in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 39
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
                example: GORMAN MANUFACTURING COMPANY, INC.
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        tradeStyleNames:
          type: array
          items:
            type: object
            description: >-
              The details of the names the organization trades under for
              commercial purposes<br/>A 'trading style' or 'trading as name' is
              a name a business chooses to use which is different from their
              registered company name. <br/>For example D&B is a trading style
              of Dun & Bradstreet Ltd. It is what the business chooses to call
              itself for marketing purposes.
            properties:
              name:
                type: string
                description: >-
                  The names the organization trades under for commercial
                  purposes<br/>A 'trading style' or 'trading as name' is a name
                  a business chooses to use which is different from their
                  registered company name.<br/>For example D&B is a trading
                  style of Dun & Bradstreet Ltd. It is what the business chooses
                  to call itself for marketing purposes.
                example: Alternate Company Name
              priority:
                type: integer
                description: >-
                  A numeric value used to identify the relative importance of a
                  Trade Style Name compared to other Trade Style Names.  The
                  lower the numeric value the earlier the data is displayed
                  (i.e. 1 indicates the most important name, 2 the second most
                  important etc...)
                example: 1
        multilingualTradestyleNames:
          type: array
          items:
            type: object
            description: >-
              The details of the names, in multiple languages, that the entity
              trades under for commercial purposes although its registered legal
              name used for contracts and other formal situations may be another
              name.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The name of the language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet to denote the
                      language in which this name was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: >-
                  The name that the entity trades under for commercial purposes
                  although its registered legal name used for contracts and
                  other formal situations may be another name.
                example: GORMAN
              priority:
                type: integer
                description: >-
                  The sequence in which the entity mostly uses this trade style
                  name.
                example: 1
        defaultCurrency:
          type: string
          description: >-
            The three-letter currency code, defined in the ISO 4217 scheme
            published by International Organization for Standardization (ISO)
            identifying the type of money that this entity uses by default.
          example: USD
        websiteAddress:
          type: array
          items:
            type: object
            description: >-
              The details of the internet URLs used for online information and
              communication with the Organization.
            properties:
              url:
                type: string
                description: >-
                  The Internet URL (Uniform Resource Locator) that uniquely
                  identifies the proprietary website of the Organization or the
                  website preferred by the Organization that gives more
                  information on the entity.
                example: http://www.gorman.com
              domainName:
                type: string
                description: >-
                  A unique name used to identify the website of the Organization
                  that serves as an address to access that website.
                example: gorman.com
        email:
          type: array
          items:
            type: object
            description: The details of the email address used to contact the entity.
            properties:
              address:
                type: string
                description: The email address for the entity.
                example: someone@company.com
        telephone:
          type: array
          items:
            type: object
            description: >-
              The details of the Telephone contact information used for voice
              communication with the organization.
            properties:
              telephoneNumber:
                type: string
                description: >-
                  The primary voice telephone number for the business, when
                  dialing domestically. The National Telephone Number is created
                  by combining the Domestic Area Code and the Local
                  Number.<br/><br/>A Domestic Area Code is a series of numbers
                  that must be prefixed before dialing a telephone number in
                  another local area. National telecommunication authorities use
                  various formats and dialing rules for area codes. Also known
                  as City Code.<br/><br/>A Local Number is a series of numbers
                  that represents a specific telephone line.
                example: '6505550000'
              isdCode:
                type: string
                description: >-
                  A series of numbers that must be prefixed before dialing a
                  telephone number in another Country, it is comprised of an
                  International Dialing Prefix followed by the Country Code.
                  These are also referred to as Country Calling Code or Country
                  Dial-In Code.
                example: '1'
        primaryAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: The name of the language in which this address was recorded.
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.<br/>Refer to
                    Reference code table "3 [Language]" for all possible values.
                  example: 39
              description: The details of the language in which this address was recorded.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The Country or Region where the organization's Primary
                    Address is located or conducts operations .
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the Country/Region where the organization's
                    Primary address is located or conducts operations .
                  example: US
              description: >-
                The details of the country or region where the address of the
                organization is located or conducts operations.
            continentalRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the continent where the Primary Address of the
                    organization is located or conducts operations.<br/>Possible
                    values <br/>Africa<br/>Asia Pacific<br/>Europe<br/>North
                    America<br/>Middle East<br/>South America
                  example: North America
              description: >-
                The details of the Continent in which the Primary Address of the
                organisation is located or conducts operations.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's Primary
                    Address is located or conducts operations. Locality defined
                    as a district population cluster. City, town, township,
                    village, borough etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's Primary
                Address is located or conducts operations. Locality defined as a
                district population cluster. City, town, township, village,
                borough etc.
            minorTownName:
              type: string
              description: >-
                The name of the  village, town or suburb where the
                organization's Primary Address is located or conducts
                operations.<br/>For example Booker in  Booker, High Wycombe.
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's Primary Address is located or conducts
                    operations For example NJ for the US State New Jersey within
                    Country United States.
                  example: CA
                isoSubDivisionName:
                  type: string
                  description: >-
                    The official name of a principal subdivision (e.g province
                    or state) of countries coded in ISO 3166-1.
                  example: Yamanashi
                isoSubDivisionCode:
                  type: string
                  description: >-
                    The code assigned by ISO that represents the name of a
                    principal subdivision (e.g province or state) of countries
                    coded in ISO 3166-1.  This code is based on the two-letter
                    code element from ISO 3166-1 followed by a separator and up
                    to three alphanumeric characters.
                  example: JP-19
              description: >-
                Details of the type of geographical area where the
                organization's Primary Address is located or conducts
                operations.<br/>Different markets have their own way of
                subdividing the country into smaller parts.
                <br/>Examples:<br/>Departments (France)<br/>States
                (USA)<br/>Provinces (Netherlands)<br/>Counties
                (UK)<br/>Bundeslander (Germany)<br/>Provinces and Territories
                (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a Country or Region
                    where the organization's address is located or conducts
                    operations.<br/><br/>Countries subdivide their geography
                    into smaller sub divisions. County is an example of a
                    commonly used subdivision, oftenfound in the UK.
                  example: SAN MATEO
              description: >-
                The details of the geographical area of a Country or Region
                where the organization's Primary Address is located or conducts
                operations. Countries divide their geography into smaller sub
                divisions.<br/><br/>County is an example of a commonly used
                subdivision. Often found in UK.
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>The first line of the Primary Address
                    where the organization is located or conducts operations.
                    For example The Point in the address<br/><br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: 492 KOLLER ST
                line2:
                  type: string
                  description: >-
                    The second line of the Primary Address where the
                    organization is located or conducts operations<br/>For
                    example 37 North Wharf Road in the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: Suite 100
              description: >-
                The details of the street address where the organization's
                Primary Address is located.
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Primary
                Address.<br/><br/>Also known locally in various English-speaking
                countries throughout the world as a postcode, post code,
                Eircode, PIN or ZIP Code) is a series of letters or digits or
                both, sometimes including spaces or punctuation, included in a
                postal address for the purpose of sorting mail. The code is used
                by the country&#39;s postal authority to identify the address
                where the organization is located or conducts operations .
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the Primary
                    Address where the organization is located or conducts
                    operations (e.g. before or after the address Town/City).
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify the
                    position of the postal code when presenting the Primary
                    Address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "210 [Postal
                    Code Position]" for all possible values.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the Primary Address where the organization is located or
                conducts operations.
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's Primary Address is located or conducts
                operations.<br/>This may be a single number, a number with an
                appendix, or a range of street numbers.<br/>For example 37 in
                the address<br/>The Point<br/>37 North Wharf
                Road<br/>London<br/>W2 1AF
              example: '492'
            streetName:
              type: string
              description: >-
                The name of the street where the organization's Primary address
                is located or conducts operations. For example North Wharf Road
                in the address<br/>The Point<br/>37 North
                Wharf<br/>London<br/>W2 1AF
              example: KOLLER ST
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique dentifier issued to the organizationby a private or
                    public postal office where the organizationrequests to have
                    mail delivered for its Primary Address.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from PO Box 12 not PO
                    Box or just the number 57 from PMB 57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have mail
                    delivered for its Primary Address.<br/>Refer to Reference
                    code table "208 [Postal Box Type]" for all possible values.
                  example: 120
              description: >-
                The details of the location  issued by a private or public
                Postal Office where the organization requests to have mail
                delivered for its Primary Address.
            standardAddressCodes:
              type: array
              items:
                type: object
                description: >-
                  Records identifiers that uniquely identifies an entire address
                  as opposed to an individual component of an address (such as a
                  street). For example, a NIKE Address Identifier, a Japan
                  Postal Barcode.
                properties:
                  addressCode:
                    type: string
                    description: >-
                      An identifier that uniquely identifies an entire address
                      as opposed to an individual component of an address (such
                      as a street). For example, a NIKE Address Identifier, a
                      Japan Postal Barcode.
                    example: ZV12467A
                  codeType:
                    type: object
                    properties:
                      description:
                        type: string
                        description: >-
                          Text that denotes the type of the standard address
                          code.
                        example: DK standard address code
                      dnbCode:
                        type: integer
                        description: >-
                          A unique code assigned by Dun&Bradstreet to identify
                          the type of the standard address code.
                        example: 487
                    description: Records the type of the standard address code.
            isRegisteredAddress:
              type: boolean
              description: >-
                Indicates if the address is the same as the organization's
                Registered Address<br/>if TRUE the primary/main address is the
                same as the organization's RegisteredAddress.<br/><br/>if FALSE
                The address is not the same as the organization's Registered
                Address.
              example: true
            latitude:
              type: number
              description: >-
                The geographic coordinate that specifies the north-south
                position of the Primary  Address where the organisation is
                located or conducts operations .
              example: 37.777709
            longitude:
              type: number
              description: >-
                The geographic coordinate that specifies the  east-west position
                of the Primary Address where the organisation is located or
                conducts operations .
              example: -122.404624
            geographicalPrecision:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    A description of  how close the latitude and longitude
                    coordinates are to the geographical position of the address
                    where the organization  is located or conducts operations.
                  example: Street Segment Centroid
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify how
                    close the latitude and longitude coordinates are for the
                    address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "231
                    [Geographical Precision]" for all possible values.
                  example: 30256
              description: >-
                The details on how close the latitude and longitude coordinates
                are to the geographical position of the address where the
                organization  is located or conducts operations .
            statisticalArea:
              type: object
              properties:
                economicAreaOfInfluenceCode:
                  type: string
                  description: >-
                    A code assigned by the U.S Bureau of Economic Analysis to
                    identify the entity's regional market that surrounds a
                    metropolitan or micropolitan statistical area serving as a
                    regional center of economic activity.
                  example: '146'
              description: >-
                The details of the various statistical facts associated with
                this address.
            isManufacturingLocation:
              type: boolean
              description: >-
                Indicates if manufacturing activity is performed at this
                facility by the entity.<br/><br/>- If true, the entity performs
                manufacturing activity at this facility.<br/>- If false, the
                entity does not performs manufacturing activity at this
                facility.
              example: true
          description: >-
            The details of the Primary Address at which the organization is
            located or conducts operations.
        multilingualPrimaryAddress:
          type: array
          items:
            type: object
            description: >-
              The details of the primary or physical address at which the entity
              is located presented in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      The name of the language in which this address was
                      recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: >-
                  The details of the language in which this address was
                  recorded.
              addressCountry:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the country/market in which this address is
                      located.
                    example: Japan
                  isoAlpha2Code:
                    type: string
                    description: >-
                      The two-letter country code, defined by the International
                      Organization for Standardization (ISO) ISO 3166-1 scheme
                      identifying the country/market in which this address is
                      located
                    example: JP
                description: >-
                  The details of the country/market in which this address is
                  located.
              continentalRegion:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the continental region for this address.
                      Possible values: - Africa - Asia Pacific - Europe - Latin
                      America - Middle East - North America.
                    example: Asia Pacific
                description: >-
                  The details of the continental region in which this address is
                  located.
              addressLocality:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the city, town, township, village, borough,
                      etc. in which this address is located.
                    example: SAN FRANCISCO
                description: >-
                  The details of the city, town, township, village, borough,
                  etc. in which this address is located.
              minorTownName:
                type: string
                description: >-
                  The name of the village, town or suburb when it is not a
                  Primary Town or City (e.g., the Booker in Booker, High
                  Wycombe).
                example: Booker
              addressRegion:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the locally governed area that forms part of a
                      centrally governed nation to identify where this address
                      is located.
                    example: California
                description: >-
                  The details of the locally governed area that forms part of a
                  centrally governed nation to identify where this address is
                  located.
              addressCounty:
                type: object
                properties:
                  name:
                    type: string
                    description: The name of the county in which this address is located.
                    example: SAN MATEO
                description: The details of the county in which this address is located.
              postalCode:
                type: string
                description: >-
                  An identifier used by the local country's postal authority to
                  identify where this address is located.
                example: '941109999'
              streetNumber:
                type: string
                description: >-
                  The number part of the street address where the entity is
                  located. This may be a single number, a number with an
                  appendix, or a range of street numbers. For example, the "51 -
                  59C" in the address 51 - 59C Wall Street.
                example: '2'
              streetName:
                type: string
                description: >-
                  The name of the street where the entity is located. For
                  example, "Wall Street" in the address 51 - 59C Wall Street.
                example: Wall Street
              streetAddress:
                type: object
                properties:
                  line1:
                    type: string
                    description: >-
                      The first line of the address where the entity is located.
                      For example, "41 Central Chambers" in the address 41
                      Central Chambers Dame Court Dublin 2
                    example: The Point
                  line2:
                    type: string
                    description: >-
                      The second line of the address where the entity is
                      located. For example, "Dame Court" in the address 41
                      Central Chambers Dame Court Dublin 2
                    example: 37 North Wharf Road
                description: The details of the street address where the entity is located.
        registeredAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    A description of the language in which the organization's
                    official address is presented .
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this organization's official address  is
                    presented
                  example: 39
              description: >-
                The details of the language in which the organization's official
                address is presented.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the country/region where the organization's
                    official address is located
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the country/region where the organization's
                    official address is located.
                  example: US
              description: >-
                The details of the Country or Region where the organization's
                official address is located.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's official
                    address is located. <br/>Locality defined as a district
                    population cluster. City, Town, Township, Village, Borough
                    etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's official
                address is located.
            minorTownName:
              type: string
              description: >-
                The name of the village, town or suburb where the organization's
                official address is located .<br/>E.g. Booker in Booker High
                Wycombe
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    official address is located . <br/>Example:<br/>New Jersey
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's official address is located.<br/>For example
                    NJ for the US State New Jersey within Country United States.
                  example: CA
              description: >-
                Details of the type of geographical area where the
                organization's official address is located.<br/><br/>Different
                markets have their own way of subdividing the country into
                smaller parts. <br/>Examples:<br/>Departments
                (France)<br/>States (USA)<br/>Provinces
                (Netherlands)<br/>Bundeslnder (Germany)<br/>Provinces and
                Territories (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a country or region
                    where the organization's official address is
                    located.<br/><br/>Countries subdivide their geography into
                    smaller areas; the UK county is a typical example.
                  example: SAN MATEO
              description: >-
                The details of the geographical  area of a country or region
                where the organization's official address is
                located.<br/>Countries subdivide their  geography into smaller
                areas. County is an example of commonly used area often found in
                UK
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Registered Address. Also
                known locally in various English-speaking countries throughout
                the world as a postcode, post code, Eircode, PIN or ZIP Code.
                Itis a series of letters or digits or both, sometimes including
                spaces or punctuation, included in a postal address for the
                purpose of sorting mail.
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the
                    organization's official address (e.g. before or after the
                    address Town/City)
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A  unique code assigned by Dun and Bradstreet to identify
                    the position of the postal code when presenting the
                    organization's official address.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the address where the organization's official correspondence is
                delivered .
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's official address is located. This may be a single
                number, a number with an appendix, or a range of street
                numbers.<br/><br/><br/>For example, 51 - 59C for the address 51
                - 59C Wall Street.
              example: 51 - 59C
            streetName:
              type: string
              description: >-
                The name of the street where the organization's official address
                is located. <br/>For example; Wall Street for the address 51 -
                59C Wall Street.
              example: Wall Street
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the organization's official address. For
                    example The Point In the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: The Point
                line2:
                  type: string
                  description: >-
                    The second line of the organization's official address. For
                    example 37 North Wharf Road In the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London
                  example: 37 North Wharf Road
                line3:
                  type: string
                  description: >-
                    The third line of the organization's official address. For
                    example  London in the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: Address line 3
                line4:
                  type: string
                  description: >-
                    The  fourth line of the organization's official address. For
                    example W2 1AF in the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: Address line 4
              description: >-
                The details of the street address where the organization's
                official address is located.
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique identifier issued to the organisation by a private
                    or public postal office where all official correspondence is
                    delivered.<br/><br/>This includes only the identifying
                    number (or text) and not the textual description of the PO
                    Box type. For example the contents would be just the number
                    12 from PO Box 12 not PO Box or just the number 57 from PMB
                    57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: >-
                    A description of the type of post office box e.g.Post Office
                    Box or Private Mail Box PMB<br/>A post office box (commonly
                    abbreviated as P.O. box, or also known as a postal box) is a
                    uniquely addressable lockable box located on the premises of
                    a post office station where the organisation requests to
                    have official correspondence delivered. <br/>A Private Mail
                    box  (commonly abbreviated as PMB provides a real street
                    address and can accept delivery of packages as well as mail.
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have
                    official correspondence delivered.
                  example: 120
              description: >-
                A description of the language in which the organization's
                official address is presented.
          description: >-
            The details of the organization's official address as recorded with
            an external authority to which all official correspondence must be
            sent<br/>Example<br/>Companies House for the UK.
        mailingAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: The name of the language in which this address was recorded.
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.<br/>Refer to
                    Reference code table "3 [Language]" for all possible values.
                  example: 39
              description: The details of the language in which this address was recorded.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The Country or Region where the organization's Primary
                    Address is located or conducts operations .
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the Country/Region where the organization's
                    Primary address is located or conducts operations .
                  example: US
              description: >-
                The details of the country or region where the address of the
                organization is located or conducts operations.
            continentalRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the continent where the Primary Address of the
                    organization is located or conducts operations.<br/>Possible
                    values <br/>Africa<br/>Asia Pacific<br/>Europe<br/>North
                    America<br/>Middle East<br/>South America
                  example: North America
              description: >-
                The details of the Continent in which the Primary Address of the
                organisation is located or conducts operations.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's Primary
                    Address is located or conducts operations. Locality defined
                    as a district population cluster. City, town, township,
                    village, borough etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's Primary
                Address is located or conducts operations. Locality defined as a
                district population cluster. City, town, township, village,
                borough etc.
            minorTownName:
              type: string
              description: >-
                The name of the  village, town or suburb where the
                organization's Primary Address is located or conducts
                operations.<br/>For example Booker in  Booker, High Wycombe.
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's Primary Address is located or conducts
                    operations For example NJ for the US State New Jersey within
                    Country United States.
                  example: CA
              description: >-
                Details of the type of geographical area where the
                organization's Primary Address is located or conducts
                operations.<br/>Different markets have their own way of
                subdividing the country into smaller parts.
                <br/>Examples:<br/>Departments (France)<br/>States
                (USA)<br/>Provinces (Netherlands)<br/>Counties
                (UK)<br/>Bundeslander (Germany)<br/>Provinces and Territories
                (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a Country or Region
                    where the organization's address is located or conducts
                    operations.<br/><br/>Countries subdivide their geography
                    into smaller sub divisions. County is an example of a
                    commonly used subdivision, oftenfound in the UK.
                  example: SAN MATEO
              description: >-
                The details of the geographical area of a Country or Region
                where the organization's Primary Address is located or conducts
                operations. Countries divide their geography into smaller sub
                divisions.<br/><br/>County is an example of a commonly used
                subdivision. Often found in UK.
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Primary
                Address.<br/><br/>Also known locally in various English-speaking
                countries throughout the world as a postcode, post code,
                Eircode, PIN or ZIP Code) is a series of letters or digits or
                both, sometimes including spaces or punctuation, included in a
                postal address for the purpose of sorting mail. The code is used
                by the country&#39;s postal authority to identify the address
                where the organization is located or conducts operations .
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the Primary
                    Address where the organization is located or conducts
                    operations (e.g. before or after the address Town/City).
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify the
                    position of the postal code when presenting the Primary
                    Address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "210 [Postal
                    Code Position]" for all possible values.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the Primary Address where the organization is located or
                conducts operations.
            postalRoute:
              type: string
              description: >-
                A code assigned by the local postal authority that sorts mail
                pieces to the individual carrier routes within a postal code.
              example: route 3B
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's Primary Address is located or conducts
                operations.<br/>This may be a single number, a number with an
                appendix, or a range of street numbers.<br/>For example 37 in
                the address<br/>The Point<br/>37 North Wharf
                Road<br/>London<br/>W2 1AF
              example: '492'
            streetName:
              type: string
              description: >-
                The name of the street where the organization's Primary address
                is located or conducts operations. For example North Wharf Road
                in the address<br/>The Point<br/>37 North
                Wharf<br/>London<br/>W2 1AF
              example: KOLLER ST
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>The first line of the Primary Address
                    where the organization is located or conducts operations.
                    For example The Point in the address<br/><br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: 492 KOLLER ST
                line2:
                  type: string
                  description: >-
                    The second line of the Primary Address where the
                    organization is located or conducts operations<br/>For
                    example 37 North Wharf Road in the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: Suite 100
              description: >-
                The details of the street address where the organization's
                Primary Address is located.
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique dentifier issued to the organizationby a private or
                    public postal office where the organizationrequests to have
                    mail delivered for its Primary Address.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from PO Box 12 not PO
                    Box or just the number 57 from PMB 57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have mail
                    delivered for its Primary Address.<br/>Refer to Reference
                    code table "208 [Postal Box Type]" for all possible values.
                  example: 120
              description: >-
                The details of the location  issued by a private or public
                Postal Office where the organization requests to have mail
                delivered for its Primary Address.
          description: The details of the address used by the entity for mailing purposes.
        stockExchanges:
          type: array
          items:
            type: object
            description: >-
              The details of the Stock Exchanges on which the entity's shares
              are traded.
            properties:
              tickerName:
                type: string
                description: >-
                  Text by which the entity is identified on this Stock Exchange
                  for share trading purposes.
                example: NYSE:DNB
              exchangeName:
                type: object
                properties:
                  description:
                    type: string
                    description: The name the Stock Exchange.
                    example: NYSE
                description: >-
                  The details of the name of the Stock Exchange on which the
                  entity's shares are traded.
              isPrimary:
                type: boolean
                description: >-
                  Indicates if this is the most important stock exchange among
                  all the stock exchange where the entity's shares are traded.
                  <br/><br/>- If true, indicates that this is the most important
                  Stock Exchange.<br/>- If false, indicates that this is not the
                  most important Stock Exchange.
                example: true
        standardizedStockExchanges:
          type: array
          items:
            type: object
            description: >-
              Records all the stock exchanges that the subject trades in
              represented using predefined finite values.
            properties:
              exchangeName:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text that denotes the standardized name of the stock
                      exchange.
                    example: Shanghai Stock Exchange
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet that denotes the
                      standardized name of the stock exchange.<br/>Refer to
                      Reference code table "178 [Stock Exchange]" for all
                      possible values.
                    example: 20666
                description: Records the standardized name of the stock exchange.
              sectionNames:
                type: array
                items:
                  type: object
                  description: >-
                    Records the different sections within a stock exchange in
                    different languages.
                  properties:
                    name:
                      type: string
                      description: >-
                        Records the name of the section within the stock
                        exchange, e.g., First section of the Tokyo Stock
                        Exchange, Second section of the Tokyo Stock Exchange,
                        JASDAQ, MOTHERS.
                      example: JASDAQ
                    language:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that records the language in which this
                            information was recorded.<br/>Refer to Reference
                            code table "3 [Language]" for all possible values.
                          example: Japanese
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet that
                            records the language in which this information was
                            recorded.
                          example: 3807
                      description: >-
                        Records the language in which this information was
                        recorded.
        isForbesLargestPrivateCompaniesListed:
          type: boolean
          description: >-
            Indicates whether the entity has ever been listed as one of the
            largest private companies in the United States on the annual list
            compiled and published by Forbes magazine<br/>.<br/><br/><br/>- If
            true, the entity has been listed.<br/>- If false, the entity has not
            been listed.
          example: false
        isFortune1000Listed:
          type: boolean
          description: >-
            Indicates whether the entity has ever been listed as one of the 1000
            largest American companies, ranked on revenues alone by the American
            business magazine Fortune.<br/><br/><br/>- If true, the entity has
            been listed.<br/>- If false, the entity has not been listed.
          example: false
        registrationNumbers:
          type: array
          items:
            type: object
            description: >-
              The details of the organization's identifiers issued by a
              recognized external authority to uniquely identify subjects. The
              issuing authority may be a Registration Authority, Government
              Department or Commercial Enterprise (e.g., Chamber of Commerce
              numbers, VAT numbers).
            properties:
              registrationNumber:
                type: string
                description: >-
                  The number or alphanumeric value assigned by a recognized
                  external authority that either uniquely identifies or helps to
                  identify the organization.
                example: 12-3456789
              typeDescription:
                type: string
                description: >-
                  The official name of the organization identifier assigned by a
                  recognized external authority (e.g.. Australian Company
                  Number, Federal Taxpayer Identification Number, Value Added
                  Tax Number).
                example: Federal Taxpayer Identification Number (US)
              typeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of organization identifier. For example, 2541 stands for
                  company number issued by the UK Companies House.<br/>Refer to
                  Reference code table "7 [Registration Number Type]" for all
                  possible values.
                example: 6863
              isPreferredRegistrationNumber:
                type: boolean
                description: >-
                  Indicates whether this is the preferred organization
                  identifier. When turned ON (set to TRUE), this organization
                  identifier is the one Dun & Bradstreet recommends for this
                  organization. When turned OFF (set to FALSE), this is not the
                  preferred organization identifier.
                example: true
        primaryIndustryCode:
          type: object
          properties:
            usSicV4:
              type: string
              description: >-
                The 4-digit code in the U.S. SIC (Standard Industrial
                Classification) 1987 system assigned to an organization
                categorizing the primary business activities performed at its
                location. For example, 1611 represents the highway and street
                construction industry.
              example: '5461'
            usSicV4Description:
              type: string
              description: >-
                The description of the business activities represented by the
                Primary US SIC Code. For example, 'highway and street
                construction' is the description of industry code 1611.
              example: Credit reporting services
          description: >-
            The details of the business activity in which the organisation is
            primarily engaged using standardised coding schemes such as European
            NACE and U.S Standard Industry Classification (SIC).
        industryCodes:
          type: array
          items:
            type: object
            description: >-
              The details of the business activities in which the organization
              is actively engaged using a standardized coding schemes such as
              European NACE and U.S. Standard Industry Classification (SIC).
            properties:
              code:
                type: string
                description: >-
                  An alphanumeric value assigned to an organization categorizing
                  the business activities performed at its location. Business
                  activities are coded using standardized coding schemes. For
                  example, 1611 represents the highway and street construction
                  industry in the U.S. SIC (Standard Industrial Classification)
                  1987 system.
                example: '323111'
              description:
                type: string
                description: >-
                  The description of the business activities represented by the
                  Industry Code as defined in the coding scheme identified by
                  the Industry Code Type Description. For example, 'highway and
                  street construction' is the description of industry code 1611
                  in the U.S. SIC 1987 system.
                example: 'Commercial Printing '
              typeDescription:
                type: string
                description: >-
                  The details of the standardized coding scheme used to classify
                  the business activities of an organization. This can be an
                  externally recognized coding scheme as for instance North
                  American Industry Classification System (NAICS) or a
                  proprietary scheme like D&B SIC-8.
                example: North American Industry Classification System 2012
              typeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  industry coding scheme.<br/>Industry schemes supported
                  currently:<br/>D&B Industry Code (3599)<br/>NAICS Code
                  (30832)<br/>US 1987 SIC Code (399)<br/>NACE Revision 2
                  (29104)<br/>D&B Hoovers Industry Code (25838)<br/>Major
                  Industry Category (24657)<br/>Local Activity Codes (specific
                  to markets)<br/>Refer to Reference code table "30 [Industry
                  Code Type]" for all possible values.
                example: 24664
              priority:
                type: integer
                description: >-
                  A number identifying the order in which this industry code
                  should be presented relative to other industry codes of the
                  same type. Priority is based on the importance of the business
                  activity to the organization.
                example: 1
        unspscCodes:
          type: array
          items:
            type: object
            description: >-
              The details of several products and services represented in the
              United Nations Standard Products and Services Code (UNSPSC)
              scheme; this scheme was jointly developed by the United Nations
              Development Programme (UNDP) and Dun & Bradstreet Corporation in
              1998.<br/><br/>The United Nations Standard Products and Services
              Code (UNSPSC) provides an open, global multi-sector standard for
              efficient, accurate classification of products and services. It is
              a 4-level hierarchy coded as an 8-digit number.<br/><br/>The
              UNSPSC for a given item is composed of four 2-digit identifiers,
              which together categorize the item into a five-level hierarchy.
              The five levels of the classification are Segment, Family, Class,
              and Commodity. Business Function is optional.
            properties:
              code:
                type: string
                description: >-
                  The UNSPSC code that identifies a product or service offered
                  by the entity.
                example: '31111617'
              description:
                type: string
                description: The description associated with the UNSPSC code.
                example: Zinc impact extrusions
              priority:
                type: integer
                description: >-
                  Identifies the order in which this UNSPSC code should be
                  presented relative to other UNSPSC codes.
                example: 1
        isNonClassifiedEstablishment:
          type: boolean
          description: >-
            When set to "true", it denotes that the Dun & Bradstreet is unable
            to classify the subject into a specific industry.<br/>When set to
            "false", it denotes that the Dun & Bradstreet is able to classify
            the subject into a specific industry.
          example: true
        activities:
          type: array
          items:
            type: object
            description: >-
              The details of the descriptions of operations in different
              languages.
            properties:
              description:
                type: string
                description: Description of operations continued by a business.
                example: Entity operation description
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      The name of the language in which this business activity
                      was recorded.
                    example: English
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this business activity was
                      recorded.<br/>Refer to Reference code table "3 [Language]"
                      for all possible values.
                    example: 39
                description: >-
                  The details of the language in which this business activity
                  was recorded.
        startDate:
          type: string
          description: >-
            The date the entity chooses to claim as its established date.<br/>
            <br/>Note: This date may be different from the Operations Start Date
            and adheres to ISO 8601 standard.The date an organization originally
            commenced operations. If the business was formed to acquire or
            continue the operations of a pre-existing business, then the Start
            Date may reflect that original start date. The Start Date is not
            necessarily the date that the subject was registered/incorporated.
            If a company registered on 25th August 1930 continues business
            activities established on 18th June 1815 then the start date is the
            1815 date.
          example: '2025-10-07T05:40:40Z'
        incorporatedDate:
          type: string
          description: >-
            The date on which a legal form was first registered with the
            appropriate Government body for this organization.
          example: '1987'
        businessEntityType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The text description of the unique code assigned by Dun &
                Bradstreet for the Legal Form Class.
              example: Corporation
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by D&B to identify the Legal Form Class.
                <br/>E.g. 451 is the Code for Corporation.<br/>Refer to
                Reference code table "197 [Business Entity Type]" for all
                possible values.
              example: 451
          description: >-
            A broad category of an organization structure into which all Legal
            Forms are grouped. These categories are created by Dun & Bradstreet
            for client use based on Legal Form association with one and only one
            Legal Form Class. Legal Form Class is limited to Corporation,
            Partnership, Proprietorship, National Government, Local Government,
            Joint Venture, Non Profit Organization, Co-operative / Mutual
            Organization and Foreign Company as well as a category for Legal
            Forms that do not fit into an existing Legal Form Class.
        legalForm:
          type: object
          properties:
            description:
              type: string
              description: >-
                The text description of the unique code assigned by Dun &
                Bradstreet for the Global Legal Form.
              example: Corporation
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by D&B for the Global Legal Form.
                <br/>For example 31145 is the Code for Government
                Agency<br/>Refer to Reference code table "750 [Global Legal
                Form]" for all possible values.
              example: 31217
            startDate:
              type: string
              description: >-
                The date on which the legal form was registered with the
                appropriate Government body or recognised by Dun and Bradstreet.
              example: '2025-10-07T05:40:40Z'
            registrationLocation:
              type: object
              properties:
                addressRegion:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
              description: The details of the address where the Legal Form is registered.
          description: >-
            The details of the structure of an organization, irrespective of the
            laws of the country or region in which it was formed. Commonly, this
            structure will be determined when registered with government
            authorities, however some entities are not required to register.
            This structure affects how much is paid in taxes, the ability to
            raise money, the requirements to register and the liability of
            proprietors. These structure types are universally standardized by
            Dun & Bradstreet for client use based on Legal Form association with
            one and only one Global Legal Form. Examples include Joint Stock
            Company and Limited Liability Company.
        controlOwnershipDate:
          type: string
          description: The date when the current owners took over the entity.
          example: '1985'
        controlOwnershipType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The name for the type of controlling ownership (e.g., publicly
                owned, privately owned, state owned). <br/><br/>Note: For some
                countries, controlling ownership can be derived from the legal
                form.
              example: Privately owned
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of controlling ownership.<br/>Refer to Reference code table "175
                [Control Type]" for all possible values.
              example: 9058
          description: The details of the type of controlling ownership.
        charterType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The nature of the document identifying the purpose of this
                entity and its rules of conduct (e.g., municipality charter,
                local public school charter, medical partnership charter, mutual
                surety company charter).
              example: Joint tenancy
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                entity's charter type.<br/>Refer to Reference code table "162
                [Charter Type]" for all possible values.
              example: 2110
          description: The details of the entity's charter type.
        isAgent:
          type: boolean
          description: >-
            Indicates if the entity acts as an agent promoting the goods or
            services of another entity (e.g., Sales Agent, Purchasing Agent).
            <br/><br/>- If true, the entity acts as an agent.<br/>- If false,
            the entity does not act as an agent.
          example: false
        isImporter:
          type: boolean
          description: >-
            Indicates if the entity is an importer.<br/><br/>- If true, the
            entity imports a quantity of goods from other countries.<br/>- If
            false, the entity does not import a quantity of goods from other
            countries.
          example: false
        isExporter:
          type: boolean
          description: >-
            Indicates if the entity is an exporter.<br/><br/>- If true, the
            entity exports a quantity of goods to other countries.<br/>- If
            false, the entity does not export a quantity of goods to other
            countries.
          example: false
        registeredDetails:
          type: object
          properties:
            legalForm:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The text description of the unique code assigned by D&B for
                    the Legal Form. <br/>For example Public Limited Liability
                    Company .
                  example: Corporation (US)
                dnbCode:
                  type: integer
                  description: >-
                    The  unique code assigned by D&B for the  Legal
                    Form.<br/>E.g. 1868 is the Code for Italian Public Limited
                    Liability Company<br/>Refer to Reference code table "4
                    [Legal Form]" for all possible values.
                  example: 7101
                registrationStatus:
                  type: object
                  properties:
                    description:
                      type: string
                      description: >-
                        Status description of the registration with respect to
                        this legal form.
                      example: Pending
                    dnbCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the status of the registration with respect to this
                        legal form.<br/>Refer to Reference code table "396
                        [Registration Status]" for all possible values.
                      example: 15626
                  description: >-
                    The details of the status of the registration with respect
                    to this legal form.
              description: >-
                The details of the structure of an organization according to the
                laws of the country or region in which it was formed. Commonly,
                this structure will be determined when registered with
                government authorities, however some organisations are not
                required to register. This structure affects how much is paid in
                taxes, the ability to raise money, the requirements to register
                and the liability of proprietors. These structure types are
                unique by country, as similar legal form types can have
                different interpretations by country or region. Also known as
                Legal Structure or Business Structure. Examples include Limited
                Liability Company (US), Private Unlimited Company Without Share
                Capital (GB) or Limited Responsibility Cooperative (BO).
          description: >-
            The details of the constitutional status of the entity as defined
            under the laws of a country (e.g., Limited Company, Partnership,
            co-operative Society) and the Stock Equity or share structure
            employed by the entity according to the legal form and rules of
            incorporation. The owners of the stock or shares are the owners of
            the business.
        numberOfEmployees:
          type: array
          items:
            type: object
            description: >-
              The details of the number of individuals engaged by a business for
              various purposes, e.g., to perform its business operations.
            properties:
              value:
                type: integer
                description: >-
                  The number of individuals engaged by a business to perform its
                  various purposes, e.g., business operations, and can include
                  directors, principals and full or part time employees.
                example: 1234
              employeeFiguresDate:
                type: string
                description: >-
                  The date for which the employee figure was reported by the
                  entity.
                example: '2025-10-07T05:40:40Z'
              informationScopeDescription:
                type: string
                description: >-
                  The organizational scope of the Employee Quantity Values.
                  Employees here means it represents a single organization
                  inclusive of any branches. Employees Total means it represents
                  an organization inclusive of any branches and any
                  subsidiaries.
                example: Consolidated
              informationScopeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the Employee Quantity value.<br/>Refer
                  to Reference code table "192 [Information Scope]" for all
                  possible values.
                example: 9067
              reliabilityDescription:
                type: string
                description: >-
                  The integrity of the Employee Quantity Value (e.g., actual,
                  estimated, or modeled).
                example: Actual
              reliabilityDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the Employee Quantity Values.<br/>Refer to
                  Reference code table "171 [Reliability]" for all possible
                  values.
                example: 9092
              employeeCategories:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the type of individuals included in the
                    calculation of the Employee Quantity Value.
                  properties:
                    employmentBasisDescription:
                      type: string
                      description: >-
                        The type of individuals that have been included in the
                        calculation of the Employee Quantity Value on the basis
                        of their employment contract (e.g., Directors,
                        Principals, Part Time Workers).
                      example: Principals
                    employmentBasisDnBCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the employment basis description.<br/>Refer to Reference
                        code table "77 [Employment Basis]" for all possible
                        values.
                      example: 9064
              trend:
                type: array
                items:
                  type: object
                  description: The details of the employee growth history.
                  properties:
                    timePeriod:
                      type: object
                      properties:
                        description:
                          type: string
                          description: The timeframe for which this data is recorded.
                          example: 1 - 5 years
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet to
                            identify the timeframe for which this data is
                            recorded.<br/>Refer to Reference code table "168
                            [Time Period]" for all possible values.
                          example: 13721
                      description: >-
                        The details of timeframe for which this data is
                        recorded.
                    growthRate:
                      type: number
                      description: >-
                        The percentage of change in number of employees from
                        base year compared to the trend year.
                      example: -7
                    value:
                      type: number
                      description: >-
                        The total number of people engaged by an entity to
                        perform its business operations. Several different
                        Employee Figures for the entity may be recorded (e.g.,
                        consolidated, individual entity, headquarters only).
                      example: 23.01
                    reliabilityDescription:
                      type: string
                      description: The integrity of the financial figures.
                      example: Audited
                    reliabilityDnBCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the integrity of the financial figures.<br/>Refer to
                        Reference code table "171 [Reliability]" for all
                        possible values.
                      example: 9092
        financials:
          type: array
          items:
            type: object
            description: >-
              The details of the standardized summary view of the financial
              results (actual or estimated) for the organization.
            properties:
              financialStatementToDate:
                type: string
                description: >-
                  The date associated with the financial results. When the
                  values are from a financial statement, it represents the date
                  the accounting period ended. When it is an estimated or
                  modeled value, it is the date on which the data was submitted.
                example: '2025-10-07T05:40:40Z'
              financialStatementDuration:
                type: string
                description: >-
                  The period of the financial statement expressed as a time
                  interval.
                example: Annual
              informationScopeDescription:
                type: string
                description: >-
                  The organizational scope of the values within the Summary
                  Financials section. Individual means it represents a single
                  organization inclusive of any branches. Consolidated means it
                  represents an organization inclusive of any branches and any
                  subsidiaries.
                example: Consolidated
              informationScopeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the Summary Financials
                  values.<br/>Refer to Reference code table "192 [Information
                  Scope]" for all possible values.
                example: 9067
              reliabilityDescription:
                type: string
                description: >-
                  The integrity of the financial figures present within the
                  Summary Financials section (e.g., actual, estimated, or
                  modeled).
                example: Actual
              reliabilityDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the financial figures present within the Summary
                  Financials section.<br/>Refer to Reference code table "171
                  [Reliability]" for all possible values.
                example: 9092
              unitCode:
                type: string
                description: >-
                  The magnitude in which the Summary Financials figures are
                  provided (e.g., in Single Units, Thousands, Millions).
                example: Single Units
              yearlyRevenue:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the total income attributable to product and
                    services sold by an organization annually.
                  properties:
                    value:
                      type: number
                      description: >-
                        The total income attributable to product and services
                        sold by an organization annually. It may be derived from
                        sales, gross revenue, commissions, billings or a
                        combination of any of these.
                      example: 19945238
                    currency:
                      type: string
                      description: >-
                        The three-letter currency code, defined in the ISO 4217
                        scheme published by the International Organization for
                        Standardization (ISO) identifying the type of money in
                        which this amount is expressed (e.g., USD, CAD, GBP,
                        EUR).
                      example: USD
        banks:
          type: array
          items:
            type: object
            description: >-
              The details of banks or other financial institutions at which the
              entity has an account.
            properties:
              name:
                type: string
                description: >-
                  The name of the bank or a financial institution at which the
                  entity has an account.
                example: Bank of My Country
              telephone:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the Telephone contact information used for
                    voice communication with the organization.
                  properties:
                    telephoneNumber:
                      type: string
                      description: >-
                        The primary voice telephone number for the business,
                        when dialing domestically. The National Telephone Number
                        is created by combining the Domestic Area Code and the
                        Local Number.<br/><br/>A Domestic Area Code is a series
                        of numbers that must be prefixed before dialing a
                        telephone number in another local area. National
                        telecommunication authorities use various formats and
                        dialing rules for area codes. Also known as City
                        Code.<br/><br/>A Local Number is a series of numbers
                        that represents a specific telephone line.
                      example: '6505550000'
              address:
                type: object
                properties:
                  addressLocality:
                    type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                        example: SAN FRANCISCO
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                  addressRegion:
                    type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                        example: California
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                  postalCode:
                    type: string
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                    example: '941109999'
                  streetAddress:
                    type: object
                    properties:
                      line1:
                        type: string
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                        example: 492 KOLLER ST
                      line2:
                        type: string
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                        example: Suite 100
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
              registrationNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the organization's identifiers issued by a
                    recognized external authority to uniquely identify subjects.
                    The issuing authority may be a Registration Authority,
                    Government Department or Commercial Enterprise (e.g.,
                    Chamber of Commerce numbers, VAT numbers).
                  properties:
                    registrationNumber:
                      type: string
                      description: >-
                        The number or alphanumeric value assigned by a
                        recognized external authority that either uniquely
                        identifies or helps to identify the organization.
                      example: 12-3456789
        isSmallBusiness:
          type: boolean
          description: >-
            Indicates if the business qualifies as small business, eligible for
            assistance from SBA, with a place of business located in the United
            States. It must operate primarily within the United States or make a
            significant contribution to the U.S. economy through payment of
            taxes or use of American products, materials or labor. Together with
            its affiliates, it must meet the numerical size standards as defined
            in the Small Business Size Regulations 13 CFR 121.<br/><br/>- If
            true, indicates that this is a small business.<br/>- If false,
            indicates that this is not a small business
          example: true
        isStandalone:
          type: boolean
          description: >-
            Indicates if the entity is a member of a legal family tree.
            <br/><br/>- If true, indicates that the entity is not a member of a
            legal family tree. This means it cannot play any family tree role
            and corporateLinkage will not be present.<br/>- If false, indicates
            that the entity is a member of a legal family tree. The roles it
            plays is indicated by Family Tree Member Roles played.
          example: false
        globalUltimate:
          type: object
          properties:
            numberOfEmployees:
              type: array
              items:
                type: object
                description: >-
                  The details of the number of individuals engaged by a business
                  for various purposes, e.g., to perform its business
                  operations.
                properties:
                  value:
                    type: integer
                    description: >-
                      The number of individuals engaged by a business to perform
                      its various purposes, e.g., business operations, and can
                      include directors, principals and full or part time
                      employees.
                    example: 1234
                  minimumValue:
                    type: integer
                    description: >-
                      The minimum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 700
                  maximumValue:
                    type: integer
                    description: >-
                      The maximum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 1500
                  employeeFiguresDate:
                    type: string
                    description: >-
                      The date for which the employee figure was reported by the
                      entity.
                    example: '2025-10-07T05:40:40Z'
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the Employee Quantity Values.
                      Employees here means it represents a single organization
                      inclusive of any branches. Employees Total means it
                      represents an organization inclusive of any branches and
                      any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Employee Quantity
                      value.<br/>Refer to Reference code table "192 [Information
                      Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the Employee Quantity Value (e.g.,
                      actual, estimated, or modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the Employee Quantity Values.<br/>Refer to
                      Reference code table "171 [Reliability]" for all possible
                      values.
                    example: 9092
            financials:
              type: array
              items:
                type: object
                description: >-
                  The details of the standardized summary view of the financial
                  results (actual or estimated) for the organization.
                properties:
                  yearlyRevenue:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the total income attributable to product
                        and services sold by an organization annually.
                      properties:
                        value:
                          type: number
                          description: >-
                            The total income attributable to product and
                            services sold by an organization annually. It may be
                            derived from sales, gross revenue, commissions,
                            billings or a combination of any of these.
                          example: 19945238
                        currency:
                          type: string
                          description: >-
                            The three-letter currency code, defined in the ISO
                            4217 scheme published by the International
                            Organization for Standardization (ISO) identifying
                            the type of money in which this amount is expressed
                            (e.g., USD, CAD, GBP, EUR).
                          example: USD
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the values within the Summary
                      Financials section. Individual means it represents a
                      single organization inclusive of any branches.
                      Consolidated means it represents an organization inclusive
                      of any branches and any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Summary Financials
                      values.<br/>Refer to Reference code table "192
                      [Information Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the financial figures present within the
                      Summary Financials section (e.g., actual, estimated, or
                      modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the financial figures present within the
                      Summary Financials section.<br/>Refer to Reference code
                      table "171 [Reliability]" for all possible values.
                    example: 9092
          description: Records the firmograhics information of the Global Ultimate company.
        domesticUltimate:
          type: object
          properties:
            numberOfEmployees:
              type: array
              items:
                type: object
                description: >-
                  The details of the number of individuals engaged by a business
                  for various purposes, e.g., to perform its business
                  operations.
                properties:
                  value:
                    type: integer
                    description: >-
                      The number of individuals engaged by a business to perform
                      its various purposes, e.g., business operations, and can
                      include directors, principals and full or part time
                      employees.
                    example: 1234
                  minimumValue:
                    type: integer
                    description: >-
                      The minimum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 700
                  maximumValue:
                    type: integer
                    description: >-
                      The maximum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 1500
                  employeeFiguresDate:
                    type: string
                    description: >-
                      The date for which the employee figure was reported by the
                      entity.
                    example: '2025-10-07T05:40:40Z'
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the Employee Quantity Values.
                      Employees here means it represents a single organization
                      inclusive of any branches. Employees Total means it
                      represents an organization inclusive of any branches and
                      any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Employee Quantity
                      value.<br/>Refer to Reference code table "192 [Information
                      Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the Employee Quantity Value (e.g.,
                      actual, estimated, or modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the Employee Quantity Values.<br/>Refer to
                      Reference code table "171 [Reliability]" for all possible
                      values.
                    example: 9092
            financials:
              type: array
              items:
                type: object
                description: >-
                  The details of the standardized summary view of the financial
                  results (actual or estimated) for the organization.
                properties:
                  yearlyRevenue:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the total income attributable to product
                        and services sold by an organization annually.
                      properties:
                        value:
                          type: number
                          description: >-
                            The total income attributable to product and
                            services sold by an organization annually. It may be
                            derived from sales, gross revenue, commissions,
                            billings or a combination of any of these.
                          example: 19945238
                        currency:
                          type: string
                          description: >-
                            The three-letter currency code, defined in the ISO
                            4217 scheme published by the International
                            Organization for Standardization (ISO) identifying
                            the type of money in which this amount is expressed
                            (e.g., USD, CAD, GBP, EUR).
                          example: USD
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the values within the Summary
                      Financials section. Individual means it represents a
                      single organization inclusive of any branches.
                      Consolidated means it represents an organization inclusive
                      of any branches and any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Summary Financials
                      values.<br/>Refer to Reference code table "192
                      [Information Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the financial figures present within the
                      Summary Financials section (e.g., actual, estimated, or
                      modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the financial figures present within the
                      Summary Financials section.<br/>Refer to Reference code
                      table "171 [Reliability]" for all possible values.
                    example: 9092
          description: >-
            Records the firmograhics information of the Domestic Ultimate
            company.
        organizationSizeCategory:
          type: object
          properties:
            description:
              type: string
              description: The description of the company size.
              example: Medium
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                company size.<br/>Refer to Reference code table "493
                [Organization Size Category]" for all possible values.
              example: 20548
          description: >-
            The details about the entity's size. The size of an entity is
            determined using factors such as the net worth, total employee
            quantity, and sales amount.
        employerDesignation:
          type: object
          properties:
            scoreDate:
              type: string
              description: The date when this score was calculated.
              example: '2025-10-07T05:40:40Z'
            indexScore:
              type: number
              description: >-
                Underlying score (0 to 1) that determines Employment
                Classification for Modeled Classification, where higher scores
                are assigned as Employers and lower scores assigned as
                Non-Employers.
              example: 0.3
            designation:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text that denotes the classification derived based on the
                    data available for this organization.
                  example: Employer
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun&Bradstreet that denotes the
                    classification derived based on the data available for this
                    organization.<br/>Refer to Reference code table "825
                    [Employer Designation]" for all possible values.
                  example: 36133
              description: >-
                Records the classification derived based on the data available
                for this organization.
            reliability:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text that records the reliability of employer designation
                    type; e.g., audited, actual, estimated, modeled.
                  example: Actual
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet that records the
                    reliability of employer designation type; e.g., audited,
                    actual, estimated, modeled.<br/>Refer to Reference code
                    table "171 [Reliability]" for all possible values.
                  example: 9092
              description: >-
                Records the reliability of this figure definition; e.g.,
                audited, actual, estimated, modeled.
          description: >-
            Three category classification of a business in relation to its
            employment status: Non-employers, Employers, and Holding Companies.
            Non-employers are businesses that have no paid employees, including
            self-employed individuals operating unincorporated business (sole
            proprietors). Non-employers constitute most active DUNS in the D&B
            Data Cloud. Employers are businesses that have paid employees. Some
            employers have complex corporate ownership structures, where some
            entities exist for the purpose of controlling companies or holding
            assets, such as real estate, patents, or stocks. These entities,
            classified as Holding Companies, have very few or no employees and
            does not conduct any operations or active tasks. This newly created
            classification provides D&B customers with improved targeting of
            businesses relevant to their use case.
        preferredLanguage:
          type: object
          properties:
            description:
              type: string
              description: >-
                Text defining the language in which the organization prefers to
                do business.
              example: English
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet, defining the
                language in which the organization prefers to do
                business.<br/>Refer to Reference code table "3 [Language]" for
                all possible values.
              example: 39
          description: >-
            Records the language in which the organization prefers to do
            business.
        multiLingualSearchNames:
          type: array
          items:
            type: object
            description: >-
              Records the names in different languages created by D&B to
              facilitate name matching.
            properties:
              name:
                type: string
                description: A name created by D&B to facilitate name matching.
                example: GORMAN
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text that records the language in which this information
                      was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet that records the
                      language in which this information was recorded.<br/>Refer
                      to Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: Records the language in which this information was recorded.
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        imperialCalendarStartYear:
          type: string
          description: >-
            This is the year in which the operations undertaken by the subject
            were first started, expressed in terms of Japanese Emperial calendar
            eg.Bunkyu 1st year
          example: 1861
        businessTrustIndex:
          type: object
          properties:
            scoreDate:
              type: string
              description: The date when this score was calculated.
              example: '2025-10-07T05:40:40Z'
            trustIndex:
              type: number
              description: >-
                Index ranging from 0 to 1 representing the likelihood of a
                business record being created to enable the company to continue
                doing business with the government while obfuscating a past
                violation, debarment, or novation fraud.  1 indicates the
                highest likelihood  and 0 indicates the lowest
              example: 0.4
            trustClass:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Textual description of the score representing likelihood of
                    a business record being created to enable the company to
                    continue doing business with the government while
                    obfuscating a past violation, debarment, or novation fraud.
                  example: Low
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun&Bradstreet, representing the
                    likelihood of a business record being created to enable the
                    company to continue doing business with the government while
                    obfuscating a past violation, debarment, or novation
                    fraud.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
                  example: 13693
              description: >-
                1 to 5 class score (Lowest Risk to Highest Risk) representing
                the likelihood of a business record being created to enable the
                company to continue doing business with the government while
                obfuscating a past violation, debarment, or novation
                fraud.<br/>13693 = 1 (Lowest Risk)<br/>13694 = 2 (Low
                Risk)<br/>13695 = 3 (Moderate Risk)<br/>13700 = 4 (High
                Risk)<br/>13702 = 5 (Higest Risk)
            nationalPercentile:
              type: number
              description: >-
                A numerical value between 1 to 100 as a percentile score
                representing likelihood of a business record being created to
                enable the company to continue doing business with the
                government while obfuscating a past violation, debarment, or
                novation fraud, where 100 indicates highest likelihood and 1
                indicates lowest.
              example: 75
            dataProvider:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Details on the data source from which the excluded business
                    was drawn from.
                  example: Debarment
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    data source from which the excluded business was drawn
                    from.<br/>36140 = DEBARMENT <br/>35904 = OFCCP <br/>24144 =
                    ERCR<br/>Refer to Reference code table "29 [Data Provider]"
                    for all possible values.
                  example: 36140
              description: Data source from which the excluded business was drawn from.
            scoreReasons:
              type: array
              items:
                type: object
                description: >-
                  The highest contributing factor to attach the Active DUNS to
                  the Excluded DUNS.
                properties:
                  description:
                    type: string
                    description: >-
                      Textual description of the highest contributing factor to
                      attach the Active DUNS to the Excluded DUNS.
                    example: >-
                      The subject's URL is found to have a similar match in
                      D&B's repository of high risk businesses.
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet, representing the
                      highest contributing factor to attach the Active DUNS to
                      the Excluded DUNS.<br/>11111 = TELEPHONE NUMBER<br/>22222
                      = URL<br/>33333 = BUSINESS NAME<br/>27677 = HIGH RISK
                      INDIVIDUAL<br/>27647 = HIGH_RISK_ADDRESS<br/>44444 =
                      CEO_NAME<br/>55555 = FIRST_EXECUTIVE_NAME<br/>66666 =
                      CEO_FE_NAME<br/>77777 = BUSINESS_ADDRESS<br/>88888 =
                      LAST_NAME<br/>99999 = LINKAGE<br/>Refer to Reference code
                      table "173 [Score Commentary]" for all possible values.
                    example: 11111
            excludedOrganization:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S Number of the debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS.
                  example: '804735132'
                name:
                  type: string
                  description: >-
                    Single name by which debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS
                    is primarily known or identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                address:
                  type: object
                  properties:
                    streetAddressLines:
                      type: array
                      items:
                        type: object
                        description: >-
                          Primary street address details of the debarred/high
                          risk business with highest value of Business Trust
                          Index with the scored DUNS.
                        properties:
                          line1:
                            type: string
                            description: >-
                              The first line of the Primary Address where the
                              organization is located or conducts operations.
                              For example The Point in the address<br/><br/>The
                              Point<br/>37 North Wharf Road<br/>London<br/>W2
                              1AF
                            example: The Point
                  description: >-
                    Primary address of the debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS.
              description: >-
                Business name of the debarred/high risk business with highest
                value of Business Trust Index with the scored DUNS.
          description: Records the likelihood of a business attempting evasion.
        securitiesReportID:
          type: string
          description: >-
            The reference identifier of the document that states the trade name
            of the company, financial conditions of the corporate group to which
            the company belongs and other important matters concerning the
            company's business.
          example: E04991
        corporateLinkage:
          type: object
          properties:
            familytreeRolesPlayed:
              type: array
              items:
                type: object
                description: >-
                  The details of the roles the entity plays as a member of an
                  ownership structured family tree.
                properties:
                  description:
                    type: string
                    description: >-
                      The role the entity plays as a member of an ownership
                      structured family tree (e.g., a branch, division, a
                      parent, headquarters, subsidiary, global ultimate,
                      domestic ultimate).
                    example: Parent/Headquarters
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify
                      describing family tree role.<br/>Refer to Reference code
                      table "202 [Family Tree Role]" for all possible values.
                    example: 9141
            hierarchyLevel:
              type: integer
              description: >-
                The number of family-tree levels below the global ultimate the
                entity is in its corporate hierarchy. The hierarchy level value
                of the global ultimate will always be 1. Each subsidiary level
                below the global ultimate is incremented by 1. Branch locations
                in a family tree will have the same hierarchy code as its
                associated headquarter.
              example: 1
            globalUltimateFamilyTreeMembersCount:
              type: integer
              description: >-
                The total number of entities in the entity's Family tree
                starting from Global Ultimate.
              example: 9000
            branchesCount:
              type: integer
              description: >-
                The total number of branch companies that report to the subject
                in the family tree.
              example: 27
            globalUltimate:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The unique identification number assigned by Dun and
                    Bradstreet identifying the top most organisation in the
                    family tree.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the top most organizationin the family tree,
                tracing each parent up to its own parent. For example,
                organizationA is based in the US and has organizationB as its
                parent also in the US. In turn organizationB is owned by
                organizationC, also in the US, which is owned by organizationD
                which is in the UK. Thus, the Global Ultimate of this family
                tree (and therefore of each member of the family tree) is
                organization D.
            domesticUltimate:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the highest ranking member of a family
                    tree within the same country/region within a limb of a
                    family tree.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the highest ranking member of a family tree
                within the same country/region within a limb of a
                family.<br/><br/><br/><br/>For example, Company A is based in
                the US and has Company B as its parent also in the US. In turn
                Company B is owned by Company C, also in the US, which is owned
                by Company D which is in the UK. Thus, the Domestic Ultimate of
                Company A is actually Company C as this is the last entity in
                the parent chain that is in the US.
            parent:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the organization that owns more than
                    50% of the subject organization.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the organization that owns more than 50% of the
                subject organization.
            headQuarter:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the Headquarters organization  that
                    serves as the administrative office for its branches.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the organization that serves as the
                administrative office for its branches.
            branches:
              type: array
              items:
                type: object
                description: >-
                  Records the entities with a valid linkage/association to a
                  business record which is its Headquarters.
                properties:
                  multiLingualNames:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the name by which the entity is primarily
                        known or identified presented in multiple languages.
                      properties:
                        name:
                          type: string
                          description: >-
                            The name by which the entity is primarily known or
                            identified.
                          example: GORMAN
                        language:
                          type: object
                          properties:
                            description:
                              type: string
                              description: The language in which this name was recorded.
                              example: Japanese
                            dnbCode:
                              type: integer
                              description: >-
                                A unique code assigned by Dun & Bradstreet to
                                identify the language in which this address was
                                recorded.<br/>Refer to Reference code table "3
                                [Language]" for all possible values.
                              example: 39
                          description: >-
                            The details of the language in which this name was
                            recorded.
          description: >-
            Details of organization to organization relationships based on
            majority ownership or control (>50%). There are two types of
            relationships, branch/division to Headquarter and Subsidiary to
            Parent.
        industrialPlantsCount:
          type: integer
          description: >-
            The number of facilities necessary for an industrial or
            manufacturing operation i.e. the equipment, including machinery,
            tools, instruments, and fixtures and the buildings containing them.
          example: 23
        principalsSummary:
          type: object
          properties:
            currentPrincipalsCount:
              type: integer
              description: >-
                The number of current principals that are associated with the
                entity.
              example: 10
            otherAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the active principals are
                associated with other companies currently or in the past.
              example: 4
            inactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the active principals are
                associated with other companies that are out of business.
              example: 7
            unfavorableInactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the principals are associated
                with other companies that was involved in an unfavorable
                bankruptcy event.
              example: 5
            favorableInactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the principals are associated
                with other companies that was involved in a favorable bankruptcy
                event.
              example: 2
            detrimentalPrincipalsCount:
              type: integer
              description: >-
                The number of principals that are associated with negative legal
                events.
              example: 2
            detrimentalPrincipalsPercentage:
              type: number
              description: >-
                The percentage of total active principals that are associated
                with negative legal events.
              example: 20
          description: >-
            The summary information for the principals associated with the
            entity.
        currentPrincipals:
          type: array
          items:
            type: object
            description: >-
              The detail of the person identified as a key stakeholder of the
              business or organization by the local registry or other official
              sources. The key stakeholder can be a natural person or an
              organization. Unless clearly defined as "former" or "most senior" 
              the definitions below refer to the current key stakeholder.
            properties:
              givenName:
                type: string
                description: >-
                  The given name of the key stakeholder who is an individual. In
                  western cultures this is usually presented first.
                example: Leslie
              middleName:
                type: string
                description: >-
                  Additional name associated to the key stakeholder to
                  distinguish them from other people with the same given name
                  and surname. In several cultures, the middle name is a portion
                  of a personal name that is written between the key
                  stakeholder's given name and their surname. In some countries
                  such as the US, a single letter can be populated in this
                  field.
                example: Ann
              familyName:
                type: string
                description: >-
                  The family or surname of the key stakeholder who is an
                  individual. In western cultures this is usually presented
                  last.
                example: Smith
              fullName:
                type: string
                description: >-
                  The key stakeholder's given and surname in addition to the
                  middle name and name suffix (when available) listed on one
                  field if the key stakeholder is an individual. This will be
                  submitted in the appropriate format for the local country. If
                  the key stakeholder is an organization, the name of the
                  organization will be populated in the full name field.
                example: Leslie Ann Smith
              namePrefix:
                type: string
                description: >-
                  The correct form of address for the key stakeholder (e.g.,
                  Dr., Professor, Lord).
                example: Dr.
              nameSuffix:
                type: string
                description: >-
                  Letters listed after the key stakeholder's last name to
                  provide additional details about the person's family
                  generation(e.g., Senior, Junior, III. ) or their
                  professional/qualification (e.g., MD, PhD etc.) Populated when
                  available.
                example: PhD
              associationStartDate:
                type: string
                description: >-
                  The date when this principal first became a principal of the
                  subject. This is not necessarily the date that the principal
                  first took up their current position.
                example: '2025-10-07T05:40:40Z'
              otherLanguageNames:
                type: array
                items:
                  type: object
                  description: Records the names of the principal in other languages.
                  properties:
                    givenName:
                      type: string
                      description: >-
                        Records the first name of the principal in other
                        languages.
                      example: Leslie
                    familyName:
                      type: string
                      description: >-
                        Records the last name of the principal in other
                        languages.
                      example: Smith
              gender:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text description of the binary classification or unknown
                      classification based on the key stakeholder's personal
                      identity when key stakeholder is an individual.
                    example: Female
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      male/female binary classification or unknown
                      classification when the key stakeholder is an
                      individual.<br/>Possible values:<br/>- 190: Male<br/>-
                      191: Female<br/>- 3581: not specified<br/>Refer to
                      Reference code table "18 [Gender]" for all possible
                      values.
                    example: 191
                description: >-
                  The detail of the binary classification or unknown
                  classification based on the key stakeholder's personal
                  identity when key stakeholder is an individual.
              jobTitles:
                type: array
                items:
                  type: object
                  description: >-
                    The detail of the text string that denotes a position held
                    by the key stakeholder in the organization or recording of
                    the title used by the organization to describe this person's
                    job e.g., Leader Global Communication, Manager National
                    Technical Support Center.
                  properties:
                    title:
                      type: string
                      description: >-
                        Text string that denotes a position held by the key
                        stakeholder in the organization or recording of the
                        title used by the organization to describe this person's
                        job e.g., Leader Global Communication, Manager National
                        Technical Support Center.
                      example: President
              managementResponsibilities:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the standardized alphanumeric classification
                    code generated by Dun & Bradstreet used to identify the
                    business function and hierarchical level of the key
                    stakeholder based on their professional job title.
                  properties:
                    description:
                      type: string
                      description: >-
                        A text description of the standardized alphanumeric
                        classification code generated by Dun & Bradstreet that
                        identifies the business function and hierarchical level
                        of the key stakeholder based on their professional job
                        title.<br/><br/>For example " Chief Executive Officer"
                        in<br/>A1A7 Chief Executive Officer
                      example: President
                    mrcCode:
                      type: string
                      description: >-
                        A standardized alphanumeric classification code
                        generated by Dun & Bradstreet that identifies the
                        business function of the key stakeholder based on the
                        associated job title data. This information is expressed
                        as a standard Management Responsibility Code
                        (MRC).<br/><br/>For example " A1A7" in<br/>A1A7 Chief
                        Executive Officer<br/>Refer to Reference code table
                        "27751[MRC]" for all possible values.
                      example: A1A6
              idNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the identification/registration numbers for
                    the key stakeholder of the business or organization.
                  properties:
                    idNumber:
                      type: string
                      description: >-
                        A number assigned by an external body or by Dun &
                        Bradstreet which either uniquely identifies or helps to
                        identify the key stakeholder of the business or
                        organization.
                      example: '11356097'
                    idType:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that identifies the type of "Principal
                            Identification Number", e.g., Social Security
                            Number.
                          example: Super Person ID
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet that
                            identifies the type of "Principal Identification
                            Number", e.g., Social Security Number.<br/>Refer to
                            Reference code table "7 [Registration Number Type]"
                            for all possible values.
                          example: 11694
                      description: >-
                        The details that identifies the type of key stakeholder
                        Identification Number, e.g., Social Security Number.
        mostSeniorPrincipals:
          type: array
          items:
            type: object
            description: >-
              The person identified as a highest ranking key stakeholder of a
              business or organization by the local registry or other official
              sources. A key stakeholder can be a natural person or an
              organization.
            properties:
              givenName:
                type: string
                description: >-
                  The given name of the highest ranking key stakeholder who is
                  an individual. In western cultures this is usually presented
                  first.
                example: Leslie
              middleName:
                type: string
                description: >-
                  Additional name associated to the highest ranking key
                  stakeholder to distinguish them from other people with the
                  same given name and surname. In several cultures, the middle
                  name is a portion of a personal name that is written between
                  the highest ranking key stakeholder's given name and their
                  surname. In some countries such as the US, a single letter can
                  be populated in this field.
                example: Ann
              familyName:
                type: string
                description: >-
                  The family or surname of the highest ranking key stakeholder
                  who is an individual. In western cultures this is usually
                  presented last.
                example: Smith
              fullName:
                type: string
                description: >-
                  The highest ranking key stakeholder's given and surname in
                  addition to the middle name and name suffix (when available)
                  listed on one field if the key stakeholder is an individual.
                  This will be submitted in the appropriate format for the local
                  country. If the highest ranking key stakeholder is an
                  organization, the name of the organization will be populated
                  in the full name field.
                example: Leslie Ann Smith
              namePrefix:
                type: string
                description: >-
                  The correct form of address for the highest ranking key
                  stakeholder (e.g., Dr., Professor, Lord).
                example: Dr.
              nameSuffix:
                type: string
                description: >-
                  Letters listed after the highest ranking key stakeholder's
                  last name to provide additional details about the person's
                  family generation(e.g., Senior, Junior, III. ) or their
                  professional/qualification (e.g., MD, PhD etc.) Populated when
                  available.
                example: PhD
              associationStartDate:
                type: string
                description: >-
                  The date when this principal first became a principal of the
                  subject. This is not necessarily the date that the principal
                  first took up their current position.
                example: '2025-10-07T05:40:40Z'
              otherLanguageNames:
                type: array
                items:
                  type: object
                  description: Records the names of the principal in other languages.
                  properties:
                    givenName:
                      type: string
                      description: >-
                        Records the first name of the principal in other
                        languages.
                      example: Leslie
                    familyName:
                      type: string
                      description: >-
                        Records the last name of the principal in other
                        languages.
                      example: Smith
                    fullName:
                      type: string
                      description: >-
                        The full name of the most senior principal in other
                        local languages.
                      example: Leslie Smith
                    language:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that records the language in which this
                            information was recorded.<br/>Refer to Reference
                            code table "3 [Language]" for all possible values.
                          example: Japanese
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet that
                            records the language in which this information was
                            recorded.<br/>Refer to Reference code table "3
                            [Language]" for all possible values.
                          example: 3807
                      description: >-
                        Records the language in which this information was
                        recorded.
                    writingScript:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text denoting the type of writing system for the
                            language that was used in recording this textual
                            information. For example, textual information
                            recorded in the language 'Japanese' can be written
                            in any of the following scripts: kanji, katakana,
                            hiragana or romaji.
                          example: Kana
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet denoting
                            the type of writing system for the language that was
                            used in recording this textual information. For
                            example, textual information recorded in the
                            language 'Japanese' can be written in any of the
                            following scripts: kanji, katakana, hiragana or
                            romaji.<br/>Refer to Reference code table "466
                            [Writing Script]" for all possible values.
                          example: 19347
                      description: >-
                        Records the type of writing system for the language that
                        was used in recording this textual information. For
                        example, textual information recorded in the language
                        'Japanese' can be written in any of the following
                        scripts: kanji, katakana, hiragana or romaji.
              gender:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text description of the binary classification or unknown
                      classification based on the highest ranking key
                      stakeholder's personal identity when key stakeholder is an
                      individual.
                    example: Female
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify to
                      define the male/female binary classification or unknown
                      classification when the highest ranking key stakeholder is
                      an individual.<br/>Possible values:<br/>- 190: Male<br/>-
                      191: Female<br/>- 3581: not specified<br/>Refer to
                      Reference code table "18 [Gender]" for all possible
                      values.
                    example: 191
                description: >-
                  The detail of the binary classification or unknown
                  classification based on the highest ranking key stakeholder's
                  personal identity when key stakeholder is an individual.
              jobTitles:
                type: array
                items:
                  description: >-
                    Text string that denotes a position held by the highest
                    ranking key stakeholder in the organization or recording of
                    the title used by the organization to describe this person's
                    job e.g., Leader Global Communication, Manager National
                    Technical Support Center.
                  properties:
                    title:
                      type: string
                      example: President
                      description: >-
                        Text string that denotes a position held by the key
                        stakeholder in the organization or recording of the
                        title used by the organization to describe this person's
                        job e.g., Leader Global Communication, Manager National
                        Technical Support Center.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the standardized alphanumeric classification
                    code generated by Dun & Bradstreet used to identify the
                    business function and hierarchical level of the key
                    stakeholder based on their professional job title.
                  properties:
                    description:
                      type: string
                      description: >-
                        A text description of the standardized alphanumeric
                        classification code generated by Dun & Bradstreet that
                        identifies the business function and hierarchical level
                        of the highest ranking key stakeholder of the business
                        or organization based on their professional job
                        title.<br/><br/>For example " Chief Executive Officer"
                        in<br/>A1A7 Chief Executive Officer
                      example: President
                    mrcCode:
                      type: string
                      description: >-
                        A standardized alphanumeric classification code
                        generated by Dun & Bradstreet that identifies the
                        business function of the highest ranking key stakeholder
                        based on the associated job title data. This information
                        is expressed as a standard Management Responsibility
                        Code (MRC).<br/><br/>For example " A1A7" in<br/>A1A7
                        Chief Executive Officer<br/>Refer to Reference code
                        table "27751[MRC]" for all possible values.
                      example: A1A6
              idNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    Identification/registration numbers for the highest ranking
                    key stakeholder of the organization.
                  properties:
                    idNumber:
                      type: string
                      description: >-
                        A number assigned by an external body or by Dun &
                        Bradstreet which either uniquely identifies or helps to
                        identify the highest ranking key stakeholder of the
                        organization.
                      example: '11356097'
                    idType:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that identifies the type of "Principal
                            Identification Number", e.g., Social Security Number
                            for the highest ranking key stakeholder of the
                            organization
                          example: Super Person ID
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet that
                            identifies the type of "Principal Identification
                            Number", e.g., Social Security Number for the
                            highest ranking key stakeholder of the
                            organization<br/>Refer to Reference code table "7
                            [Registration Number Type]" for all possible values.
                          example: 11694
                      description: >-
                        Identifies the type of "Principal Identification
                        Number", e.g., Social Security Number for the highest
                        ranking key stakeholder of the organization.
      description: The details of the entity.
    DataBlock:
      type: object
      description: >-
        A data block is a collection of data elements that are logically grouped
        together. Enables you to retrieve data on a specific entity or category.
      properties:
        transactionDetail:
          type: object
          description: The information used to process this request.
          properties:
            transactionID:
              type: string
              description: >-
                A value assigned by the Dun & Bradstreet application to uniquely
                identify this request.
              example: rlh-hi9puyoijk-jop8u-kd-d-1
            transactionTimestamp:
              type: string
              description: >-
                The date and time, in ISO 8601 UTC Z standard, when this
                response was created.
              example: '2025-10-07T05:40:40Z'
            inLanguage:
              type: string
              description: >-
                An IETF BCP 47 code value that defines the language in which
                this product was rendered.
              example: en-US
        inquiryDetail:
          type: object
          description: The criteria used to process this request.
          properties:
            duns:
              type: string
              description: The D-U-N-S number provided in the request.
              example: '804735132'
            blockIDs:
              type: array
              items:
                description: The blockIDs provided in the request.
                example:
                  - blockID
                type: string
            tradeUp:
              type: string
              description: The value of the tradeUp parameter provided in the request.
              example: hq
            customerReference:
              type: string
              description: >-
                A reference string provided by the customer for this particular
                transaction.
              example: Some text to describe the request.
        blockStatus:
          type: array
          items:
            type: object
            description: Records the status of the data blocks requested by the customer.
            properties:
              blockID:
                type: string
                description: The unique identifier for the data block.
                example: blockID
              status:
                type: string
                description: >-
                  The current status of the data block fulfilled in this
                  response.<br/><br/>Possible values:<br/>* OK<br/>* Unavailable
                example: OK
              reason:
                type: string
                description: >-
                  Any specific reason why the data block is not delivered in
                  this response.<br/><br/>Possible values:<br/>* Data is not
                  available.<br/>* Data is not available for the branch.<br/>*
                  Data is not available on the requested country code.
                example: Data is not available.
        organization:
          $ref: '#/components/schemas/DataBlockOrganization'
    CommercialUltimate:
      type: object
      description: The details of the Commercial Ultimate for the entity.
      properties:
        duns:
          type: string
          description: >-
            The D-U-N-S Number, assigned by Dun & Bradstreet, is an
            identification number that uniquely identifies the entity in
            accordance with the Data Universal Numbering System (D-U-N-S).
          example: '804735132'
        primaryName:
          type: string
          description: Main name of the company.
          example: Acme Corporation
        primaryAddress:
          $ref: '#/components/schemas/DnBAddress'
        path:
          type: array
          description: >-
            List of companies on the path from the root entity to the commercial
            ultimate.
          items:
            $ref: '#/components/schemas/CommercialUltimatePath'
        cmpelkV2:
          $ref: '#/components/schemas/CmpelkV2'
        dataBlock:
          $ref: '#/components/schemas/DataBlock'
    Page:
      type: integer
      description: Current page number.
      example: '1'
      default: 0
      minimum: 0
    ModifiedBy:
      type: string
      description: User or Client UUID which modified the resource.
      example: '76248934691294444'
    DataSourceName:
      type: string
      description: Name of the data source.
      example: Receita Federal Brazil
    DataSourceTechnicalKey:
      type: string
      description: Technical key of the data source.
      example: BR_RF
    BusinessPartnerId:
      type: string
      description: >-
        A CDQ ID identifies a business partner uniquely in the context of the
        Corporate Data League.
      example: 63e635235c06b7396330fe40
    JobId:
      type: string
      description: Unique identifier of a job.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    ConfigurationVersion:
      type: integer
      description: Version number of a configuration.
      example: 1
    schemas-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.).
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        language:
          $ref: '#/components/schemas/Language'
        mainAbbreviation:
          $ref: '#/components/schemas/LegalFormMainAbbreviation'
        cdlElfCode:
          $ref: '#/components/schemas/LegalFormCdlElfCode'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/LegalFormCategory'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormTechnicalKey'
    schemas-IdentifierType:
      type: object
      description: Type of the identifier.
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    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
    schemas-IdentifierStatus:
      type: object
      description: >-
        Identifier Status refers to the current state of a unique identification
        number.
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        url:
          $ref: '#/components/schemas/IdentifierStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    IssuingBodyDescription:
      type: string
      description: Description for an Issuing Body.
      example: Amtsgericht Aachen
    schemas-AdministrativeAreaType:
      type: object
      description: >-
        Type of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    schemas-AdministrativeArea:
      type: object
      description: A top-level geographical or political area division in a country.
      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/schemas-AdministrativeAreaType'
        language:
          $ref: '#/components/schemas/Language'
    schemas-Jurisdiction:
      type: object
      description: >-
        The authority of an official organization to make decisions and
        judgments in a particular administrative area.
      required:
        - country
      properties:
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/schemas-AdministrativeArea'
    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
    schemas-IssuingBody:
      type: object
      description: >-
        An Issuing Body is an organization or government institution that is
        responsible for assigning unique identifiers to individuals,
        organizations, or objects.
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        shortName:
          $ref: '#/components/schemas/IssuingBodyShortName'
        names:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Name'
        description:
          $ref: '#/components/schemas/IssuingBodyDescription'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        jurisdiction:
          $ref: '#/components/schemas/schemas-Jurisdiction'
        gleifCode:
          $ref: '#/components/schemas/IssuingBodyGleifCode'
        localAuthorityCode:
          $ref: '#/components/schemas/IssuingBodyLocalAuthorityCode'
        externalUrl:
          $ref: '#/components/schemas/IssuingBodyExternalUrl'
    schemas-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.
      properties:
        value:
          $ref: '#/components/schemas/IdentifierValue'
        type:
          $ref: '#/components/schemas/schemas-IdentifierType'
        status:
          $ref: '#/components/schemas/schemas-IdentifierStatus'
        issuingBody:
          $ref: '#/components/schemas/schemas-IssuingBody'
    schemas-BusinessPartnerCategory:
      type: object
      description: >-
        A business partner category of a business partner groups similar
        business partners.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        url:
          $ref: '#/components/schemas/BusinessPartnerCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    schemas-AddressVersion:
      type: object
      description: >-
        CDQ supports multiple versions of addresses comprising different
        charsets and languages. An address version is a unique combination of a
        character set and a language.
      properties:
        characterSet:
          $ref: '#/components/schemas/schemas-CharacterSet'
        language:
          $ref: '#/components/schemas/Language'
    schemas-AddressMetadata:
      type: object
      description: Specifies the language and primary data provenance.
      properties:
        primaryProvenance:
          $ref: '#/components/schemas/schemas-Provenance'
        language:
          $ref: '#/components/schemas/Language'
    schemas-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'
    schemas-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
    schemas-AddressType:
      type: object
      description: >-
        An address type characterizes an address. The type of an address is a
        structural statement and provides a truth that is applicable to any user
        (e.g. a legal address is a fact, or that an address is a PO BOX
        address), other than address functions that may differ from user to
        user. Address functions determine the particular business context in
        which an address is in use.
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    schemas-Address:
      type: object
      description: >-
        An address provides information about the physical location of a
        business partner. It can be specialized in a certain context(e.g.
        delivery address or invoice address).
      properties:
        version:
          $ref: '#/components/schemas/schemas-AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        metadata:
          $ref: '#/components/schemas/schemas-AddressMetadata'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/schemas-AdministrativeArea'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PostCode'
        localities:
          type: array
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/Thoroughfare'
        premises:
          type: array
          items:
            $ref: '#/components/schemas/Premise'
        postalDeliveryPoints:
          type: array
          items:
            $ref: '#/components/schemas/PostalDeliveryPoint'
        openingHours:
          type: array
          items:
            $ref: '#/components/schemas/schemas-OpeningHour'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        types:
          type: array
          items:
            $ref: '#/components/schemas/schemas-AddressType'
        formattedAddress:
          $ref: '#/components/schemas/schemas-FormattedAddress'
    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
    ClassificationTypeTechnicalKey:
      type: string
      description: TechnicalKey for the Classification Type.
      example: NAF 2003
    schemas-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'
    schemas-Classification:
      type: object
      description: >-
        A business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      properties:
        value:
          $ref: '#/components/schemas/ClassificationValue'
        code:
          $ref: '#/components/schemas/ClassificationCode'
        level:
          $ref: '#/components/schemas/ClassificationLevel'
        type:
          $ref: '#/components/schemas/schemas-ClassificationType'
    PhoneNumberTypeTechnicalKey:
      type: string
      description: Technical Keys of the PhoneNumber.
      example: FAX
    schemas-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'
    schemas-PhoneNumber:
      type: object
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarter.
      properties:
        countryPrefix:
          $ref: '#/components/schemas/PhoneNumberCountryPrefix'
        number:
          $ref: '#/components/schemas/PhoneNumberNumber'
        type:
          $ref: '#/components/schemas/schemas-PhoneNumberType'
        value:
          $ref: '#/components/schemas/PhoneNumberValue'
    schemas-Tag:
      type: object
      description: >-
        Describing and identifying a resource. Custom information about the
        resource in form of a tag.
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagType'
    Tags:
      type: array
      items:
        $ref: '#/components/schemas/schemas-Tag'
    schemas-Website:
      type: object
      description: >-
        Webpages related to the business partner, e.g. the main corporate
        website as also provided by some company registers.
      properties:
        url:
          $ref: '#/components/schemas/WebsiteUrl'
        type:
          $ref: '#/components/schemas/WebsiteType'
    schemas-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:
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Classification'
        contactEmails:
          type: array
          items:
            $ref: '#/components/schemas/ContactEmail'
        hcpProfile:
          $ref: '#/components/schemas/HcpProfile'
        minorityIndicator:
          $ref: '#/components/schemas/MinorityIndicator'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PhoneNumber'
        tags:
          $ref: '#/components/schemas/Tags'
        vatPayerStatus:
          $ref: '#/components/schemas/VatPayerStatus'
        websites:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Website'
    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
    BankAddress:
      type: object
      description: The address where a bank resides.
      properties:
        localities:
          type: array
          items:
            $ref: '#/components/schemas/Locality'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/schemas-AdministrativeArea'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PostCode'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/Thoroughfare'
    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'
    schemas-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'
    schemas-ExternalContextIdentifier:
      type: object
      description: Describe own identifiers of a record (others than just the external Id).
      properties:
        value:
          $ref: '#/components/schemas/ExternalContextIdentifierValue'
        type:
          $ref: '#/components/schemas/ExternalContextIdentifierType'
    schemas-ExternalContext:
      type: object
      description: Describe own identifiers of a record (others than just the external Id).
      properties:
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/schemas-ExternalContextIdentifier'
    schemas-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:
        names:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Name'
        legalForm:
          $ref: '#/components/schemas/schemas-LegalForm'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Identifier'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/schemas-BusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/schemas-Address'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/schemas-PartnerProfile'
        formattedSapRecord:
          $ref: '#/components/schemas/FormattedSapRecord'
        relations:
          type: array
          items:
            $ref: '#/components/schemas/schemas-BusinessPartnerRelation'
        bankAccounts:
          type: array
          items:
            $ref: '#/components/schemas/schemas-BankAccount'
        types:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
        externalContext:
          $ref: '#/components/schemas/schemas-ExternalContext'
    ReplyQueue:
      type: string
      description: >-
        Technical descriptor of reply queue where workers should put back the
        result.
      example: 647328648329632-34890742-3432
    UserId:
      type: string
      description: Unique ID of a user.
      example: johndoe
    JobProgress:
      type: integer
      description: Progress (%) of the job.
      example: '77'
      maximum: 100
      minimum: 0
    JobStatusMessage:
      type: string
      description: Additional information to explain the status.
      example: The job failed because storage is empty.
    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'
    OrganizationId:
      type: string
      description: Uniquely identifying ID of the organization.
      example: cdq_monitor
    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'
    schemas-LookupJobId:
      type: string
      description: Job Id which was received from the "Start Lookup Job".
      example: cbed7ac6-a97d-4c23-9060-2a88fa660957
    BuildToggle:
      type: boolean
      description: Enable to generate this report.
      example: 'true'
      default: false
    LookupReportConfiguration:
      type: object
      description: Configures if and how Lookup reports are generated.
      properties:
        jobId:
          $ref: '#/components/schemas/schemas-LookupJobId'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        build:
          $ref: '#/components/schemas/BuildToggle'
    DnbJobId:
      type: string
      description: Job Id which was received from the "Start Dnb Lookup Job".
      example: cbed7ac6-a97d-4c23-9060-2a88fa660957
    DnbReportConfiguration:
      type: object
      description: Configures if and how D&B reports are generated.
      properties:
        jobId:
          $ref: '#/components/schemas/DnbJobId'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        build:
          $ref: '#/components/schemas/BuildToggle'
    ReferenceDataReportsConfiguration:
      type: object
      description: Configures if and how Reference Data reports are generated.
      properties:
        lookup:
          $ref: '#/components/schemas/LookupReportConfiguration'
        dnb:
          $ref: '#/components/schemas/DnbReportConfiguration'
    JobName:
      type: string
      description: Name of a Job.
      example: Process vendor data.
    JobDescription:
      type: string
      description: Detailed description of a Job.
      example: I started this job to improve quality of our data.
    schemas-JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
    JobUser:
      type: string
      description: ID of (human) user or API key.
      example: 742429-234242-4343-232323
    FileResourceUrl:
      type: string
      description: Url of the file resource linking to s3.
      example: customer-upload/user/file.xlsx
  responses:
    400_BadRequest:
      description: The sent request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
