Skip to content

DNB API (1)

This API provides services to access records from DNB and calculate their Commercial Ultimates.

Overview
URL

https://www.cdq.ch/team

Michał Dunat

michal.dunat@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/dnb-api/api-v1/

Production SOAP

https://api.corporate-data-league.ch/dnb/soap/v1/

Production

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

Registrations

Operations

Identification

Operations

Setup

Operations

Data Retrieval

Operations

Fetch DNB Record

Request

Fetch D&B record by its duns number. It is possible to read:

  • legacy CMPELK data
  • Data Blocks defined here
  • linkage LNKELI data

Fetch CMPELK

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

POST /dnb/fetch
{
  "duns": "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/fetch
{
  "duns": "123456789",
  "featuresOn": [
    "ACTIVATE_MASTER_DATA_BASIC"
  ]
}

Fetch LNKELI

It is poosible to fetch LNKELI data:

POST /dnb/fetch
{
  "duns": "123456789",
  "featuresOn": [
    "ACTIVATE_LINKAGE_LNKELI"
  ]
}
Headers
X-DNB-USERstringDeprecated

Username that is used to get access to DNB products.

Example: johnsmith
X-DNB-PASSWORDstringDeprecated

Username that is used to get access to DNB products.

Example: secret
Body
required
dunsstring

DUNS number.

Example: "123456789"
featuresOnArray of strings(DnbFetchFeatureParam)

Features that will be used when fetching dnb data.

Items Enum ValueDescription
ACTIVATE_MASTER_DATA_BASIC

Use a basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use an extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use a management set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use a 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

Use additional cmpelk calls to load the 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.

Example: ["ACTIVATE_MASTER_DATA_BASIC"]
featuresOffArray of strings(DnbFetchFeatureParam)

Features that will not be used when fetching dnb data.

Items Enum ValueDescription
ACTIVATE_MASTER_DATA_BASIC

Use a basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use an extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use a management set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use a 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

Use additional cmpelk calls to load the 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.

Example: ["ACTIVATE_MASTER_DATA_BASIC"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/dnb/fetch \
  -H 'Content-Type: application/json' \
  -d '{
    "duns": "123456789",
    "featuresOn": [
      "ACTIVATE_MASTER_DATA_BASIC"
    ],
    "featuresOff": [
      "ACTIVATE_MASTER_DATA_BASIC"
    ]
  }'

Responses

OK

Body
cmpelkV2object(CmpelkV2)

The details of the entity.

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.

lnkeliobject(CmpelkV2)

The details of the entity.

commercialUltimateobject(CommercialUltimate)

The details of the Commercial Ultimate for the entity.

domesticCommercialUltimateobject(CommercialUltimate)

The details of the Commercial Ultimate for the entity.

headquarterobject(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.

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.

cdqCommercialUltimateobject(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.

statusobject(StatusDetails)

Details about this status or error

messagestring

Message returned from DNB when fetching data.

Example: "OK"
relationsArray of strings(BranchRelation)

Contains relations with branch companies, only present when using tradeUp option.

Example: ["123456789"]
Response
{
  "cmpelkV2": {
    "transactionDetail": { … },
    "inquiryDetail": { … },
    "organization": { … }
  },
  "dataBlock": {
    "transactionDetail": { … },
    "inquiryDetail": { … },
    "blockStatus": [ … ],
    "organization": { … }
  },
  "lnkeli": {
    "transactionDetail": { … },
    "inquiryDetail": { … },
    "organization": { … }
  },
  "commercialUltimate": {
    "duns": "804735132",
    "primaryName": "Acme Corporation",
    "primaryAddress": { … },
    "path": [ … ],
    "cmpelkV2": { … },
    "dataBlock": { … }
  },
  "domesticCommercialUltimate": {
    "duns": "804735132",
    "primaryName": "Acme Corporation",
    "primaryAddress": { … },
    "path": [ … ],
    "cmpelkV2": { … },
    "dataBlock": { … }
  },
  "headquarter": {
    "transactionDetail": { … },
    "inquiryDetail": { … },
    "blockStatus": [ … ],
    "organization": { … }
  },
  "cdqRecord": {
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "addresses": [ … ],
    "externalId": "The ID managed in the customer's SAP systems.",
    "profile": { … },
    "formattedSapRecord": { … },
    "relations": [ … ],
    "bankAccounts": [ … ],
    "types": [ … ],
    "externalContext": { … }
  },
  "cdqCommercialUltimate": {
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "addresses": [ … ],
    "externalId": "The ID managed in the customer's SAP systems.",
    "profile": { … },
    "formattedSapRecord": { … },
    "relations": [ … ],
    "bankAccounts": [ … ],
    "types": [ … ],
    "externalContext": { … }
  },
  "status": {
    "id": 200000004,
    "message": "The job came to an end and finished successfully.",
    "technicalKey": "JOB_FINISHED",
    "jsonPath": "$.businessPartner.names[0].value",
    "jsonRecord": "{ \"key\" : \"value\"}"
  },
  "message": "OK",
  "relations": [
    "123456789"
  ]
}

Configurations

Operations

Configuration

Operations