Skip to content

Data Exchange API (5)

This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud.

Overview
URL

https://www.cdq.ch/team

Michal Malinka

michal.malinka@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/data-exchange/soap/v5/

Production

https://api.corporate-data-league.ch/data-exchange/

Seed Updates

Manages operations such as creating, updating, or transforming Business Partner data to ensure that the information is current and accurate.

Operations

Analytics

Provides functionalities for analyzing and processing Business Partner data, enabling users to gain insights and perform various analytical operations on the data.

Business Partner Storages

Provides functionalities for creating, retrieving, updating and deleting Business Partner storage, as well as managing associated data sources and data monitors.

Operations

Business Partners

Provides functionalities for creating, retrieving, updating, and deleting Business Partner records, as well as performing various operations such as lookup and upsert.

Operations

Data Import

Provides functionalities for uploading external data and enabling users to enhance and update their Business Partner records with new information.

Operations

Data Mapping

Provides functionalities for defining and managing data mappings, enabling users to transform and map raw data into structured formats suitable for processing and analysis.

Operations

Data Monitors

Provides functionalities for creating, retrieving, updating and deleting data monitors.

Operations

Data Transformation

Provides functionalities for converting raw data into structured formats.

Operations

DNB Storages

Provides functionalities for creating, retrieving, updating and deleting DNB storage, as well as managing associated data sources and data monitors.

Operations

Poll DNB LOD Job

Request

After you have started a D&B LOD job, you will receive a job id in the response. { "id" : "<ID>" } Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the D&B storage.

Security
basicAuth
Path
idstring(JobId)required

ID of the D&B Create LOD job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Headers
X-Credential-Usernamestringrequired

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")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/jobs/dnbcreatelodjobs/35f23c03-1c22-45fe-9484-3ffe769325de \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
namestring(JobName)

Name of a Job.

Example: "Process vendor data."
descriptionstring(JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(JobStatus)

Job execution status.

Enum ValueDescription
ARCHIVED

Job has been archived.

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 was scheduled and started running but died unexpectedly.

Example: "RUNNING"
statusMessagestring

Message describing the status of the job.

Example: "Job is running"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
attachmentsArray of objects(FileResource)

List of attachments.

Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data.",
  "description": "I started this job to improve quality of our data.",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "Job is running",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "attachments": [
    { … }
  ]
}

Upsert DNB Records

Request

Upserts D&B Records to one of your D&B storages in asynchronous mode. Every D&B data product (Master Data Basic, Master Data Extended, Cmpelk, Extended Linkage Insight) is managed in a dedicated storage. Required D&B storage is created if it does not exist yet.

The default data product is Cmpelk. Change data products by providing the respective feature. Please prepare the request accordingly:

  • USE_DNB: You have to fill properties dnbRecords.duns and dnbRecords.cmpelkV2 (default)
  • USE_DNB_MASTER_DATA_BASIC: You have to fill properties dnbRecords.duns and dnbRecords.dataBlock
  • USE_DNB_MASTER_DATA_MGMT: You have to fill properties dnbRecords.duns and dnbRecords.dataBlock
  • USE_DNB_MASTER_DATA_LNKG: You have to fill properties dnbRecords.duns and dnbRecords.dataBlock
  • USE_DNB_MASTER_DATA_EXTENDED: You have to fill properties dnbRecords.duns and dnbRecords.dataBlock
  • USE_DNB_LINKAGE_LNKLI: You have to fill properties dnbRecords.duns and dnbRecords.cmpelkV2

If you try to use a D&B product, and you don't have proper authentication configured in Global Settings App then the API will return an error.

Note: Using Global Settings App is deprecated and is soon switched to Data Source Management App.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

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")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
dnbRecordsArray of objects(DnbRecord)[ 1 .. 250 ] itemsrequired

List of D&B Records.

dnbRecords[].​dunsstring(Duns)

DUNS number of the record to be fetched.

Example: "15-048-3782"
dnbRecords[].​cmpelkV2object(CmpelkV2)

The details of the entity.

dnbRecords[].​dataBlockobject(DataBlock)

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.

dnbRecords[].​cdqRecordobject(BusinessPartner)

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.

dnbRecords[].​commercialUltimateobject(CommercialUltimate)

Details of the highest commercial organization in the corporate family hierarchy.

dnbRecords[].​domesticCommercialUltimateobject(CommercialUltimate)

Details of the highest commercial organization in the corporate family hierarchy.

dnbRecords[].​modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
dnbRecords[].​lastSyncAtstring(LastSyncAt)

Date of last synchronization.

Example: "2020-02-11T00:00:00Z"
featuresOnArray of strings(DnbStorageFeatureParam)

Features to be used during the D&B storage creation.

Items Enum ValueDescription
SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP record.

USE_DNB

Create/Use Business Partner Storage for D&B data product Company Profile, Linkage, and Executives (CMPELK)

USE_DNB_MASTER_DATA_BASIC

Create/Use for D&B data product Master Data Basic

USE_DNB_MASTER_DATA_MGMT

Create/Use for D&B data product Master Data Management

USE_DNB_MASTER_DATA_LNKG

Create/Use for D&B data product Master Data Linkage

USE_DNB_MASTER_DATA_EXTENDED

Create/Use for D&B data product Master Data Extended

USE_DNB_LINKAGE_LNKELI

Create/Use for D&B data product Extended Linkage Insight

Example: ["USE_DNB"]
featuresOffArray of strings(DnbRecordsUpsertFeature)

Features to be used during the D&B storage creation.

Items ValueDescription
ASYNC_PROCESSING

Save D&B Records in synchronous mode

Example: ["ASYNC_PROCESSING"]
curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/dnbstorages/dnbrecords \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "dnbRecords": [
      {
        "duns": "15-048-3782",
        "cmpelkV2": {
          "transactionDetail": {
            "transactionID": "rlh-hi9puyoijk-jop8u-kd-d-1",
            "transactionTimestamp": "2017-02-21T17:46:19.839Z",
            "inLanguage": "en-US",
            "productID": "PRODID",
            "productVersion": 1
          },
          "inquiryDetail": {
            "duns": 804735132,
            "productID": "PRODID",
            "productVersion": "v1",
            "tradeUp": "hq",
            "customerReference": "Some text to describe the request."
          },
          "organization": {
            "duns": 804735132,
            "dunsControlStatus": {
              "operatingStatus": {
                "description": "Active",
                "dnbCode": 9074
              },
              "isMarketable": "true",
              "isMailUndeliverable": "false",
              "isTelephoneDisconnected": "false",
              "isDelisted": "false",
              "subjectHandlingDetails": [
                {}
              ],
              "fullReportDate": "2017-01-30"
            },
            "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
            "tradeStyleNames": [
              {
                "name": "Alternate Company Name",
                "priority": 1
              }
            ],
            "websiteAddress": [
              {
                "url": "http://www.gorman.com",
                "domainName": "gorman.com"
              }
            ],
            "telephone": [
              {
                "telephoneNumber": 6505550000,
                "isdCode": 1,
                "isUnreachable": "false"
              }
            ],
            "fax": [
              {
                "faxNumber": 6505550001,
                "isdCode": 1
              }
            ],
            "primaryAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US",
                "fipsCode": "US"
              },
              "continentalRegion": {
                "name": "North America"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA",
                "isoSubDivisionName": "Yamanashi",
                "isoSubDivisionCode": "JP-19",
                "fipsCode": "06"
              },
              "addressCounty": {
                "name": "SAN MATEO",
                "fipsCode": 81
              },
              "postalCode": 941109999,
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "streetNumber": 492,
              "streetName": "KOLLER ST",
              "streetAddress": {
                "line1": "492 KOLLER ST",
                "line2": "Suite 100"
              },
              "postOfficeBox": {
                "postOfficeBoxNumber": 5309,
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              },
              "latitude": 37.777709,
              "longitude": -122.404624,
              "geographicalPrecision": {
                "description": "Street Segment Centroid",
                "dnbCode": 30256
              },
              "isRegisteredAddress": "true",
              "isResidentialAddress": "false",
              "statisticalArea": {
                "cbsaName": "San Francisco-Oakland-Hayward CA",
                "cbsaCode": 41860,
                "economicAreaOfInfluenceCode": 146,
                "populationRank": {}
              },
              "locationOwnership": {
                "description": "Rents",
                "dnbCode": 1129
              },
              "premisesArea": {
                "measurement": 10034,
                "unitDescription": "square foot",
                "unitDnBCode": 3848,
                "reliabilityDescription": "Actual",
                "reliabilityDnBCode": 9092
              },
              "isManufacturingLocation": "true"
            },
            "registeredAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA"
              },
              "addressCounty": {
                "name": "SAN MATEO"
              },
              "postalCode": 941109999,
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "streetNumber": 492,
              "streetName": "KOLLER ST",
              "streetAddress": {
                "line1": "492 KOLLER ST",
                "line2": "Suite 100",
                "line3": "Address line 3",
                "line4": "Address line 4"
              },
              "postOfficeBox": {
                "postOfficeBoxNumber": 5309,
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              }
            },
            "mailingAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US"
              },
              "continentalRegion": {
                "name": "North America"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA"
              },
              "addressCounty": {
                "name": "SAN MATEO"
              },
              "postalCode": 941109999,
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "postalRoute": "route 3B",
              "streetNumber": 492,
              "streetName": "KOLLER ST",
              "streetAddress": {
                "line1": "492 KOLLER ST",
                "line2": "Suite 100"
              },
              "postOfficeBox": {
                "postOfficeBoxNumber": 5309,
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              }
            },
            "stockExchanges": [
              {
                "tickerName": "NYSE:DNB",
                "exchangeName": {},
                "exchangeCountry": {},
                "isPrimary": "true"
              }
            ],
            "thirdPartyAssessment": [
              {
                "description": "Fortune 500 Revenue Rank",
                "dnbCode": 23290,
                "assessmentDate": 2017,
                "value": 31
              }
            ],
            "registrationNumbers": [
              {
                "registrationNumber": "12-3456789",
                "typeDescription": "Federal Taxpayer Identification Number (US)",
                "typeDnBCode": 6863
              }
            ],
            "industryCodes": [
              {
                "code": 323111,
                "description": "Commercial Printing ",
                "typeDescription": "North American Industry Classification System 2012",
                "typeDnBCode": 24664,
                "priority": 1
              }
            ],
            "businessEntityType": {
              "description": "Corporation",
              "dnbCode": 451
            },
            "controlOwnershipDate": 1985,
            "startDate": 1985,
            "controlOwnershipType": {
              "description": "Privately owned",
              "dnbCode": 9058
            },
            "isAgent": "false",
            "isImporter": "false",
            "isExporter": "false",
            "numberOfEmployees": [
              {
                "value": 1234,
                "informationScopeDescription": "Consolidated",
                "informationScopeDnBCode": 9067,
                "reliabilityDescription": "Actual",
                "reliabilityDnBCode": 9092,
                "employeeCategories": [
                  {}
                ],
                "trend": [
                  {}
                ]
              }
            ],
            "financials": [
              {
                "financialStatementToDate": "2016-12-31",
                "financialStatementDuration": "Annual",
                "informationScopeDescription": "Actual",
                "informationScopeDnBCode": 9092,
                "reliabilityDescription": "Actual",
                "reliabilityDnBCode": 9092,
                "unitCode": "Single Units",
                "accountantName": "Johnson, Jordan & Jones CPAs",
                "yearlyRevenue": [
                  {}
                ]
              }
            ],
            "mostSeniorPrincipals": [
              {
                "givenName": "Leslie",
                "familyName": "Smith",
                "fullName": "Leslie Ann Smith",
                "namePrefix": "Dr.",
                "nameSuffix": "PhD",
                "gender": "Female",
                "jobTitles": [
                  {}
                ],
                "managementResponsibilities": [
                  {}
                ]
              }
            ],
            "currentPrincipals": [
              {
                "givenName": "Leslie",
                "familyName": "Smith",
                "fullName": "Leslie Ann Smith",
                "namePrefix": "Dr.",
                "nameSuffix": "PhD",
                "gender": "Female",
                "jobTitles": [
                  {}
                ],
                "managementResponsibilities": [
                  {}
                ]
              }
            ],
            "socioEconomicInformation": {
              "isMinorityOwned": "false",
              "isSmallBusiness": "false"
            },
            "isStandalone": "false",
            "corporateLinkage": {
              "familytreeRolesPlayed": [
                {}
              ],
              "hierarchyLevel": 1,
              "globalUltimateFamilyTreeMembersCount": "4",
              "globalUltimate": {
                "duns": 804735132,
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "addressCounty": {},
                  "streetAddress": {}
                }
              },
              "domesticUltimate": {
                "duns": 804735132,
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "addressCounty": {},
                  "streetAddress": {}
                }
              },
              "parent": {
                "duns": 804735132,
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "addressCounty": {},
                  "streetAddress": {}
                }
              },
              "headQuarter": {
                "duns": 804735132,
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "addressCounty": {},
                  "streetAddress": {}
                }
              }
            },
            "shareOwnership": [
              {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                },
                "ownershipPercentage": 8.56
              }
            ],
            "affiliates": [
              {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                },
                "associationType": {},
                "franchiseName": "Franchise",
                "franchiseID": "1058890509"
              }
            ],
            "extendedLinkageInsight": {
              "brandName": "DUN&BRADSTREET",
              "familyTreeCount": 145,
              "globalUltimate": {
                "duns": "005438890",
                "name": "Lawson Products, Inc.",
                "primaryAddress": {
                  "addressCountry": {}
                }
              },
              "domesticUltimate": {
                "duns": "005438890",
                "name": "Lawson Products, Inc.",
                "primaryAddress": {
                  "addressCountry": {}
                }
              },
              "parent": {
                "duns": "005438890",
                "name": "Lawson Products, Inc.",
                "primaryAddress": {
                  "addressCountry": {}
                }
              },
              "linkageSourceCategory": 6,
              "associationType": {
                "description": "Agent Alternate Linkage",
                "dnbCode": 30487
              },
              "nameEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "brandEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "industryEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "locationEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "ceoEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "principalNameEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "telephoneEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "webDomainEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "webPageEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "financialReportEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "wikipediaEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              },
              "feedbackEvidenceStrength": {
                "description": "Moderate",
                "dnbCode": 13695
              }
            }
          }
        },
        "dataBlock": {
          "transactionDetail": {
            "transactionID": "rlh-hi9puyoijk-jop8u-kd-d-1",
            "transactionTimestamp": "2017-02-21T17:46:19.839Z",
            "inLanguage": "en-US"
          },
          "inquiryDetail": {
            "duns": "804735132",
            "blockIDs": [
              [
                "blockID"
              ]
            ],
            "tradeUp": "hq",
            "customerReference": "Some text to describe the request."
          },
          "blockStatus": [
            {
              "blockID": "blockID",
              "status": "OK",
              "reason": "Data is not available."
            }
          ],
          "organization": {
            "duns": "804735132",
            "countryISOAlpha2Code": "US",
            "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
            "dunsControlStatus": {
              "operatingStatus": {
                "description": "Active",
                "dnbCode": "9074",
                "startDate": "2016-03-14"
              },
              "operatingSubStatus": {
                "description": "Out of business - Favourable",
                "dnbCode": "9077",
                "startDate": "2018-07-12T00:00:00.000Z"
              },
              "detailedOperatingStatus": {
                "description": "Operationally Active",
                "dnbCode": "29929"
              },
              "isMarketable": "true",
              "isMailUndeliverable": "false",
              "isTelephoneDisconnected": "false",
              "isDelisted": "false",
              "subjectHandlingDetails": [
                {}
              ],
              "firstReportDate": "2017-01-30",
              "recordClass": {
                "description": "Full DMI record",
                "dnbCode": 10928
              },
              "isSelfRequestedDUNS": true,
              "selfRequestDate": "2016-12-28"
            },
            "registeredName": "GORMAN MANUFACTURING COMPANY, INC.",
            "multilingualPrimaryName": [
              {
                "language": {},
                "name": "GORMAN",
                "writingScript": {}
              }
            ],
            "multilingualRegisteredNames": [
              {
                "language": {},
                "name": "GORMAN MANUFACTURING COMPANY, INC.",
                "writingScript": {}
              }
            ],
            "tradeStyleNames": [
              {
                "name": "Alternate Company Name",
                "priority": 1
              }
            ],
            "multilingualTradestyleNames": [
              {
                "language": {},
                "name": "GORMAN",
                "priority": 1
              }
            ],
            "defaultCurrency": "USD",
            "websiteAddress": [
              {
                "url": "http://www.gorman.com",
                "domainName": "gorman.com"
              }
            ],
            "email": [
              {
                "address": "someone@company.com"
              }
            ],
            "telephone": [
              {
                "telephoneNumber": "6505550000",
                "isdCode": "1"
              }
            ],
            "primaryAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US"
              },
              "continentalRegion": {
                "name": "North America"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA",
                "isoSubDivisionName": "Yamanashi",
                "isoSubDivisionCode": "JP-19"
              },
              "addressCounty": {
                "name": "SAN MATEO"
              },
              "streetAddress": {
                "line1": "492 KOLLER ST",
                "line2": "Suite 100"
              },
              "postalCode": "941109999",
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "streetNumber": "492",
              "streetName": "KOLLER ST",
              "postOfficeBox": {
                "postOfficeBoxNumber": "5309",
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              },
              "standardAddressCodes": [
                {
                  "codeType": {}
                }
              ],
              "isRegisteredAddress": true,
              "latitude": 37.777709,
              "longitude": -122.404624,
              "geographicalPrecision": {
                "description": "Street Segment Centroid",
                "dnbCode": 30256
              },
              "statisticalArea": {
                "economicAreaOfInfluenceCode": "146"
              },
              "isManufacturingLocation": true
            },
            "multilingualPrimaryAddress": [
              {
                "language": {},
                "addressCountry": {},
                "continentalRegion": {},
                "addressLocality": {},
                "minorTownName": "Booker",
                "addressRegion": {},
                "addressCounty": {},
                "postalCode": "941109999",
                "streetNumber": "2",
                "streetName": "Wall Street",
                "streetAddress": {}
              }
            ],
            "registeredAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA"
              },
              "addressCounty": {
                "name": "SAN MATEO"
              },
              "postalCode": "941109999",
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "streetNumber": "51 - 59C",
              "streetName": "Wall Street",
              "streetAddress": {
                "line1": "The Point",
                "line2": "37 North Wharf Road",
                "line3": "Address line 3",
                "line4": "Address line 4"
              },
              "postOfficeBox": {
                "postOfficeBoxNumber": "5309",
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              }
            },
            "mailingAddress": {
              "language": {
                "description": "English",
                "dnbCode": 39
              },
              "addressCountry": {
                "name": "United States",
                "isoAlpha2Code": "US"
              },
              "continentalRegion": {
                "name": "North America"
              },
              "addressLocality": {
                "name": "SAN FRANCISCO"
              },
              "minorTownName": "Booker",
              "addressRegion": {
                "name": "California",
                "abbreviatedName": "CA"
              },
              "addressCounty": {
                "name": "SAN MATEO"
              },
              "postalCode": "941109999",
              "postalCodePosition": {
                "description": "Post code presented before Town/City name",
                "dnbCode": 1009
              },
              "postalRoute": "route 3B",
              "streetNumber": "492",
              "streetName": "KOLLER ST",
              "streetAddress": {
                "line1": "492 KOLLER ST",
                "line2": "Suite 100"
              },
              "postOfficeBox": {
                "postOfficeBoxNumber": "5309",
                "typeDescription": "Supplied by public Post Office authority",
                "typeDnBCode": 120
              }
            },
            "stockExchanges": [
              {
                "tickerName": "NYSE:DNB",
                "exchangeName": {},
                "isPrimary": true
              }
            ],
            "standardizedStockExchanges": [
              {
                "exchangeName": {},
                "sectionNames": [
                  {}
                ]
              }
            ],
            "isForbesLargestPrivateCompaniesListed": false,
            "isFortune1000Listed": false,
            "registrationNumbers": [
              {
                "registrationNumber": "12-3456789",
                "typeDescription": "Federal Taxpayer Identification Number (US)",
                "typeDnBCode": 6863,
                "isPreferredRegistrationNumber": true
              }
            ],
            "primaryIndustryCode": {
              "usSicV4": "5461",
              "usSicV4Description": "Credit reporting services"
            },
            "industryCodes": [
              {
                "code": "323111",
                "description": "Commercial Printing ",
                "typeDescription": "North American Industry Classification System 2012",
                "typeDnBCode": 24664,
                "priority": 1
              }
            ],
            "unspscCodes": [
              {
                "code": "31111617",
                "description": "Zinc impact extrusions",
                "priority": 1
              }
            ],
            "isNonClassifiedEstablishment": true,
            "activities": [
              {
                "description": "Entity operation description",
                "language": {}
              }
            ],
            "startDate": "2012-09-03",
            "incorporatedDate": "1987",
            "businessEntityType": {
              "description": "Corporation",
              "dnbCode": 451
            },
            "legalForm": {
              "description": "Corporation",
              "dnbCode": 31217,
              "startDate": "2002-03-05",
              "registrationLocation": {
                "addressRegion": "California"
              }
            },
            "controlOwnershipDate": "1985",
            "controlOwnershipType": {
              "description": "Privately owned",
              "dnbCode": 9058
            },
            "charterType": {
              "description": "Joint tenancy",
              "dnbCode": 2110
            },
            "isAgent": false,
            "isImporter": false,
            "isExporter": false,
            "registeredDetails": {
              "legalForm": {
                "description": "Corporation (US)",
                "dnbCode": 7101,
                "registrationStatus": {}
              }
            },
            "numberOfEmployees": [
              {
                "value": 1234,
                "employeeFiguresDate": "2017-12-31",
                "informationScopeDescription": "Consolidated",
                "informationScopeDnBCode": 9067,
                "reliabilityDescription": "Actual",
                "reliabilityDnBCode": 9092,
                "employeeCategories": [
                  {}
                ],
                "trend": [
                  {}
                ]
              }
            ],
            "financials": [
              {
                "financialStatementToDate": "2016-12-31",
                "financialStatementDuration": "Annual",
                "informationScopeDescription": "Consolidated",
                "informationScopeDnBCode": 9067,
                "reliabilityDescription": "Actual",
                "reliabilityDnBCode": 9092,
                "unitCode": "Single Units",
                "yearlyRevenue": [
                  {}
                ]
              }
            ],
            "banks": [
              {
                "name": "Bank of My Country",
                "telephone": [
                  {}
                ],
                "address": {
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                },
                "registrationNumbers": [
                  {}
                ]
              }
            ],
            "isSmallBusiness": true,
            "isStandalone": false,
            "globalUltimate": {
              "numberOfEmployees": [
                {}
              ],
              "financials": [
                {
                  "yearlyRevenue": []
                }
              ]
            },
            "domesticUltimate": {
              "numberOfEmployees": [
                {}
              ],
              "financials": [
                {
                  "yearlyRevenue": []
                }
              ]
            },
            "organizationSizeCategory": {
              "description": "Medium",
              "dnbCode": 20548
            },
            "employerDesignation": {
              "scoreDate": "2018-09-12",
              "indexScore": 0.3,
              "designation": {
                "description": "Employer",
                "dnbCode": 36133
              },
              "reliability": {
                "description": "Actual",
                "dnbCode": 9092
              }
            },
            "preferredLanguage": {
              "description": "English",
              "dnbCode": 39
            },
            "multiLingualSearchNames": [
              {
                "name": "GORMAN",
                "language": {},
                "writingScript": {}
              }
            ],
            "imperialCalendarStartYear": 1861,
            "businessTrustIndex": {
              "scoreDate": "2021-01-31",
              "trustIndex": 0.4,
              "trustClass": {
                "description": "Low",
                "dnbCode": 13693
              },
              "nationalPercentile": 75,
              "dataProvider": {
                "description": "Debarment",
                "dnbCode": 36140
              },
              "scoreReasons": [
                {}
              ],
              "excludedOrganization": {
                "duns": "804735132",
                "name": "GORMAN MANUFACTURING COMPANY, INC.",
                "address": {
                  "streetAddressLines": []
                }
              }
            },
            "securitiesReportID": "E04991",
            "corporateLinkage": {
              "familytreeRolesPlayed": [
                {}
              ],
              "hierarchyLevel": 1,
              "globalUltimateFamilyTreeMembersCount": 9000,
              "branchesCount": 27,
              "globalUltimate": {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                }
              },
              "domesticUltimate": {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                }
              },
              "parent": {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                }
              },
              "headQuarter": {
                "duns": "804735132",
                "primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
                "primaryAddress": {
                  "addressCountry": {},
                  "continentalRegion": {},
                  "addressLocality": {},
                  "addressRegion": {},
                  "streetAddress": {}
                }
              },
              "branches": [
                {
                  "multiLingualNames": []
                }
              ]
            },
            "industrialPlantsCount": 23,
            "principalsSummary": {
              "currentPrincipalsCount": 10,
              "otherAssociationsCount": 4,
              "inactiveAssociationsCount": 7,
              "unfavorableInactiveAssociationsCount": 5,
              "favorableInactiveAssociationsCount": 2,
              "detrimentalPrincipalsCount": 2,
              "detrimentalPrincipalsPercentage": 20
            },
            "currentPrincipals": [
              {
                "givenName": "Leslie",
                "middleName": "Ann",
                "familyName": "Smith",
                "fullName": "Leslie Ann Smith",
                "namePrefix": "Dr.",
                "nameSuffix": "PhD",
                "associationStartDate": "2013-09-30",
                "otherLanguageNames": [
                  {}
                ],
                "gender": {},
                "jobTitles": [
                  {}
                ],
                "managementResponsibilities": [
                  {}
                ],
                "idNumbers": [
                  {}
                ]
              }
            ],
            "mostSeniorPrincipals": [
              {
                "givenName": "Leslie",
                "middleName": "Ann",
                "familyName": "Smith",
                "fullName": "Leslie Ann Smith",
                "namePrefix": "Dr.",
                "nameSuffix": "PhD",
                "associationStartDate": "2013-09-30",
                "otherLanguageNames": [
                  {}
                ],
                "gender": {},
                "jobTitles": [
                  {}
                ],
                "managementResponsibilities": [
                  {}
                ],
                "idNumbers": [
                  {}
                ]
              }
            ]
          }
        },
        "cdqRecord": {
          "id": "63e635235c06b7396330fe40",
          "createdAt": "2020-08-31T16:47+00:00",
          "modifiedAt": "2020-08-31T16:47+00:00",
          "externalId": "The ID managed in the customer'\''s SAP systems.",
          "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
          "disclosed": "false",
          "updateMonitoring": "true",
          "updateCommercialMonitoring": [
            {
              "type": {
                "technicalKey": "DNB"
              },
              "value": "true"
            }
          ],
          "metadata": {
            "lastUpdatedAt": "2020-08-31T16:47+00:00",
            "lastSyncAt": "2020-02-11T00:00:00Z",
            "sharingStatus": {
              "status": "SHARED_WITH_NO_MATCH",
              "description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
            },
            "identityLinks": [
              {
                "linkId": "6465f2492bdcd350159a79d6",
                "cdqId": "VIES:PL8660001429",
                "addressId": "0",
                "externalAddressId": "123456789",
                "status": {
                  "details": []
                }
              }
            ],
            "logResultStatuses": [
              {
                "processingLogId": "CURATION_LOG",
                "triggerProcessedAt": "2020-08-31T16:47+00:00",
                "triggerType": {},
                "trigger": {},
                "jobProcessedAt": "2020-08-31T16:47+00:00",
                "processedAt": "2020-08-31T16:47+00:00",
                "status": "INFO",
                "description": "Validation Level",
                "processingStatus": {},
                "previousProcessingStatus": {}
              }
            ],
            "decisionLogResult": {
              "reviewStatus": "REVIEWED",
              "naturalPersonsReviewStatus": "REVIEWED",
              "duplicatesReviewStatus": "REVIEWED"
            }
          },
          "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
          "additionalInformation": [
            {
              "key": "KEY",
              "value": "1"
            }
          ],
          "names": [
            {
              "type": {
                "url": "https://meta.cdq.com/Business_partner/name/type",
                "name": "Local Name",
                "technicalKey": "LOCAL"
              },
              "value": "Corporate Data Quality AG",
              "shortName": "CDQ AG",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "details": [
                {}
              ]
            }
          ],
          "legalForm": {
            "name": "Aktiengesellschaft",
            "url": "https://meta.cdq.com/Business_partner/legal_form",
            "technicalKey": "DE_9866",
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "mainAbbreviation": "AG",
            "categories": [
              {
                "name": "Limited Liability Company",
                "shortName": "LLC",
                "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
                "technicalKey": "LIMITED"
              }
            ]
          },
          "identifiers": [
            {
              "type": {
                "url": "https://meta.cdq.com/Business_partner/identifier/type",
                "name": "CH_VAT_ID",
                "technicalKey": "CH_VAT_ID"
              },
              "value": "CHE-218.608.886 HR/MWST",
              "issuingBody": {
                "name": "Amtsgericht Aachen",
                "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
                "technicalKey": "Amtsgericht Aachen",
                "jurisdiction": {}
              },
              "status": {
                "name": "ACTIVE",
                "technicalKey": "ACTIVE"
              }
            }
          ],
          "categories": [
            {
              "name": "Hotel",
              "url": "https://meta.cdq.com/Business_partner/category",
              "technicalKey": "HOTEL"
            }
          ],
          "status": {
            "type": {
              "name": "In Liquidation",
              "url": "https://meta.cdq.com/Business_partner/status/type",
              "technicalKey": "IN_LIQUIDATION"
            },
            "officialDenotation": "Good Standing",
            "validFrom": "2022-02-26",
            "validUntil": "2022-02-26"
          },
          "profile": {
            "minorityIndicator": {
              "value": "Social enterprise"
            },
            "classifications": [
              {
                "value": "Manufacture of pesticides and other agrochemical products.",
                "code": "20.20Z",
                "type": {}
              }
            ],
            "phoneNumbers": [
              {
                "countryPrefix": "+41",
                "number": "71 571 10 40",
                "type": {},
                "value": "+41 71 571 10 40"
              }
            ],
            "websites": [
              {
                "url": "https://cdq.com",
                "type": {}
              }
            ],
            "contactEmails": [
              {
                "value": "developer-portal@cdq.com"
              }
            ],
            "tags": [
              {
                "value": "Warehouse",
                "type": {}
              }
            ],
            "vatPayerStatus": {
              "publicationDate": "2020-07-21T17:32:28Z",
              "status": {
                "name": "RELIABLE",
                "technicalKey": "VAT_PAYER_STATUS"
              },
              "registrationAuthority": {
                "registrationAuthorityId": "RA000009",
                "registrationAuthorityEntityId": "RA000009",
                "otherRegistrationAuthorityId": "RA000009"
              }
            },
            "hcpProfile": {
              "generalLicense": {
                "professionType": {},
                "licenseStatus": {}
              },
              "operationalPermissions": [
                {
                  "practiceLocations": []
                }
              ]
            }
          },
          "relations": [
            {
              "startedAt": "2019-08-31T16:47+00:00",
              "endedAt": "2019-08-31T16:47+00:00",
              "type": {
                "name": "Commercial ultimate",
                "technicalKey": "COMMERCIAL_ULTIMATE",
                "url": "https://meta.cdq.com/Business_partner/relation/type"
              },
              "class": {
                "name": "CDQ Hierarchy",
                "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY",
                "url": "https://meta.cdq.com/Business_partner/relation/class"
              },
              "startNode": {
                "externalId": "The ID managed in the customer'\''s SAP systems.",
                "dataSourceId": "648824a691d8d2503d65103e"
              },
              "endNode": {
                "externalId": "The ID managed in the customer'\''s SAP systems.",
                "dataSourceId": "648824a691d8d2503d65103e"
              },
              "deactivatedAt": "2019-08-31T16:47+00:00"
            }
          ],
          "types": [
            {
              "name": "Legal Entity",
              "url": "https://meta.cdq.com/Business_partner/type",
              "technicalKey": "LEGAL_ENTITY"
            }
          ],
          "addresses": [
            {
              "id": "0001",
              "externalId": "1",
              "cdqId": "CDQID-123456789",
              "version": {
                "language": {},
                "characterSet": {}
              },
              "identifyingName": {
                "value": "John Doe"
              },
              "careOf": {
                "value": "CDQ GmbH c/o Product Department"
              },
              "contexts": [
                {}
              ],
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              },
              "administrativeAreas": [
                {}
              ],
              "postCodes": [
                {}
              ],
              "localities": [
                {}
              ],
              "thoroughfares": [
                {}
              ],
              "premises": [
                {}
              ],
              "postalDeliveryPoints": [
                {}
              ],
              "geographicCoordinates": {
                "latitude": "47.439549",
                "longitude": "9.395275"
              },
              "types": [
                {}
              ]
            }
          ],
          "bankAccounts": [
            {
              "internationalBankAccountIdentifier": "CH8800781619278412000",
              "internationalBankIdentifier": "KBSGCH22XXX",
              "nationalBankAccountIdentifier": "619278412000",
              "nationalBankIdentifier": "00781",
              "countryCode": "DE",
              "vendorPaymentSummary": {
                "firstPaymentDate": "2020-08-31T16:47+00:00",
                "lastPaymentDate": "2020-08-31T16:47+00:00",
                "numberOfPayments": "1"
              }
            }
          ],
          "externalContext": {
            "identifiers": [
              {
                "value": "7250017031",
                "type": {}
              }
            ]
          }
        },
        "commercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        },
        "domesticCommercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        },
        "modifiedAt": "2020-08-31T16:47+00:00",
        "lastSyncAt": "2020-02-11T00:00:00Z"
      }
    ],
    "featuresOn": [
      "USE_DNB"
    ],
    "featuresOff": [
      "ASYNC_PROCESSING"
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfAcceptedinteger(int32)

Represents number of Business Partners to be processed.

Example: "100"
numberOfFailedinteger(int32)

Number of failed records.

Example: "50"
failuresArray of objects(DnbRecordFailureLog)

List of failed records.

Response
application/json
{
  "numberOfAccepted": "100",
  "numberOfFailed": "50",
  "failures": [
    { … }
  ]
}

Upsert Commercial Ultimates

Request

Upsert Commercial Ultimate for D&B Record to one of your D&B storages in synchronous mode. Every D&B data product is managed in a dedicated storage. Change data products by providing the respective feature.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

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")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
featuresOnArray of strings(DnbStorageFeatureParam)= 1 itemsrequired

Features to be used during upsert of CommercialUltimates.

Items Enum ValueDescription
SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP record.

USE_DNB

Create/Use Business Partner Storage for D&B data product Company Profile, Linkage, and Executives (CMPELK)

USE_DNB_MASTER_DATA_BASIC

Create/Use for D&B data product Master Data Basic

USE_DNB_MASTER_DATA_MGMT

Create/Use for D&B data product Master Data Management

USE_DNB_MASTER_DATA_LNKG

Create/Use for D&B data product Master Data Linkage

USE_DNB_MASTER_DATA_EXTENDED

Create/Use for D&B data product Master Data Extended

USE_DNB_LINKAGE_LNKELI

Create/Use for D&B data product Extended Linkage Insight

Example: ["USE_DNB"]
commercialUltimatesArray of objects(CommercialUltimateUpdate)required

List of Global Commercial Ultimate updates.

commercialUltimates[].​dunsstring(Duns)required

DUNS number of the record to be fetched.

Example: "15-048-3782"
commercialUltimates[].​commercialUltimateobject(CommercialUltimate)required

Details of the highest commercial organization in the corporate family hierarchy.

commercialUltimates[].​commercialUltimate.​dunsstring(Duns)

DUNS number of the record to be fetched.

Example: "15-048-3782"
commercialUltimates[].​commercialUltimate.​primaryNamestring

Name of the Commercial Ultimate.

Example: "Dun & Bradstreet, Inc."
commercialUltimates[].​commercialUltimate.​primaryAddressobject(DnBAddress)

The details of the single primary or physical address at which the entity is located.

commercialUltimates[].​commercialUltimate.​pathArray of objects

List of DUNS numbers that represent the path from the subject to the Commercial Ultimate.

domesticCommercialUltimatesArray of objects(CommercialUltimateUpdate)

List of Domestic Commercial Ultimate updates.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/dnbstorages/dnbrecords/commercialultimates \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "featuresOn": [
      "USE_DNB"
    ],
    "commercialUltimates": [
      {
        "duns": "15-048-3782",
        "commercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        }
      }
    ],
    "domesticCommercialUltimates": [
      {
        "duns": "15-048-3782",
        "commercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfProvidedinteger(int32)

Represents number of Commercial ultimates to update provided in CommercialUltimateUpsertRequest.

Example: "100"
numberOfUpdatedinteger(int32)

Represents number of updated Commercial ultimates.

Example: "100"
numberOfFailedinteger(int32)

Number of failed updates.

Example: "50"
failuresArray of objects(DnbRecordFailureLog)

List of failed updates.

Response
application/json
{
  "numberOfProvided": "100",
  "numberOfUpdated": "100",
  "numberOfFailed": "50",
  "failures": [
    { … }
  ]
}

Files

Provides functionalities for uploading, downloading and deleting files.

Operations

Subscriptions

Provides functionalities for managing subscriptions.

Operations

Data Mappers

Provides functionalities for transforming raw data into structured Business Partner data using predefined data mapper definitions. This allows users to convert various data formats into a standardized format suitable for processing and analysis.

Operations

Relations

Manages relationships between Business Partners.

Operations

Update Classification

Operations

Event Stores

Operations

Business Partner Storages (None Public)

Operations

Restart Monitor Job

Operations

Cache

Operations

Configuration

Operations

Event Store

Operations

CDQ Community Pool

Operations