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

Configurations

Operations

Configuration

Operations

Delete Configuration

Request

Delete configuration.

Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: transactionId=abcdef
featuresOnArray of strings(TransactionFeatureParam)

Features to be enabled. Don't use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
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.

Example: featuresOn=CREATE_TRANSACTION
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/configurations/commercialultimatedetection/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

OK.

Bodyapplication/json
idstring

Configurations unique identifier.

Example: "abcdef"
namestring

The name of the configuration.

Example: "MyConfigV2"
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(CommercialUltimateDetectionConfiguration)

Workspace configuration to customize the Commercial Ultimate detection behavior.

createdAtstring

Date when the configuration was created.

Example: "2023/08/12"
modifiedAtstring

Date when the configuration was modified.

Example: "2023/08/12"
createdBystring

ID of the user that created the configuration.

Example: "testUser"
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
relatedConfigurationsArray of objects(RelatedConfiguration)
defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true
Response
application/json
{
  "id": "abcdef",
  "name": "MyConfigV2",
  "version": 1,
  "configuration": {
    "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "createdAt": "2020-08-31T16:47+00:00",
    "createdBy": "76248934691294444",
    "modifiedAt": "2020-08-31T16:47+00:00",
    "systemClassifications": [ … ],
    "customClassifications": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ]
  },
  "createdAt": "2023/08/12",
  "modifiedAt": "2023/08/12",
  "createdBy": "testUser",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ],
  "defaultConfiguration": true
}