Configurations

Registrations

Operations

Identification

Operations

Setup

Operations

Data Retrieval

Operations

Configurations

Operations

List Configurations

Request

List all configurations.

Query

limitinteger(Limit)

Max number of configurations.

Example: limit=10

startAfterstring(StartAfter)

ID of the configuration before start.

Example: startAfter=abcdef

defaultConfigurationboolean

Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.

Default null

Example: defaultConfiguration=true

curl -i -X GET \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/configurations/commercialultimatedetection

Responses

Successful operation

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(WorkspaceConfigurationSearchResult)

Response

application/json

{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Create Configuration

Request

Create a new configuration.

Bodyapplication/json

transactionIdstring(TransactionId)

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

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

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

Items Enum Value	Description
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: ["CREATE_TRANSACTION"]

workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring

The name of the configuration.

Example: "Test Configuration"

configurationobject(CommercialUltimateDetectionConfigurationCreate)

Request to create a new CommercialUltimateDetectionConfiguration.

relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items

Related Configurations.

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/configurations/commercialultimatedetection \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Test Configuration",
    "configuration": {
      "name": "Test Configuration.",
      "holdingClassificationEnabled": "false",
      "foundationClassificationEnabled": "false",
      "governmentalClassificationEnabled": "false",
      "customClassifications": [
        {
          "name": "CU Detection Configuration - Monitoring v2",
          "entityTag": "CUSTOM_CLASSIFICATION_A",
          "enabled": true,
          "businessEntityTypes": [
            {
              "code": 454,
              "name": "National Government Entity"
            }
          ],
          "standardIndustrialClassification": [
            {
              "code": 6733,
              "name": "Trust management"
            }
          ]
        }
      ],
      "featuresOn": [
        "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
      ],
      "featuresOff": [
        "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
      ]
    },
    "relatedConfigurations": [
      {
        "id": "a0200062daa56952a8640005",
        "owner": {
          "service": "reference-data-api",
          "path": "/public/configurations/businesspartnerlookup"
        }
      }
    ],
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    },
    "defaultConfiguration": true
  }'

Responses

Configuration created successfully

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
}

Read Configuration

Request

Read configuration by ID.

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

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

Responses

Successful operation

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
}

Update Configuration

Request

Update existing configuration.

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Bodyapplication/json

transactionIdstring(TransactionId)

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

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

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

Items Enum Value	Description
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: ["CREATE_TRANSACTION"]

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(CommercialUltimateDetectionConfigurationCreate)

Request to create a new CommercialUltimateDetectionConfiguration.

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/configurations/commercialultimatedetection/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "Client configuration.",
    "configuration": {
      "name": "Test Configuration.",
      "holdingClassificationEnabled": "false",
      "foundationClassificationEnabled": "false",
      "governmentalClassificationEnabled": "false",
      "customClassifications": [
        {
          "name": "CU Detection Configuration - Monitoring v2",
          "entityTag": "CUSTOM_CLASSIFICATION_A",
          "enabled": true,
          "businessEntityTypes": [
            {
              "code": 454,
              "name": "National Government Entity"
            }
          ],
          "standardIndustrialClassification": [
            {
              "code": 6733,
              "name": "Trust management"
            }
          ]
        }
      ],
      "featuresOn": [
        "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
      ],
      "featuresOff": [
        "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
      ]
    },
    "defaultConfiguration": true
  }'

Responses

Configuration updated successful

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

systemClassificationsArray of objects(EconomicActivityClassification)

List of economic activity classifications provided by CDQ. Business Partner matching any classification are NOT applicable to be the Commercial Ultimate.

customClassificationsArray of objects(EconomicActivityClassification)[ 0 .. 10 ] items

List of economic activity classifications provided by a user. Business Partner matching any classification is NOT applicable to be the Commercial Ultimate.

featuresOnArray of strings(CommercialUltimateDetectionFeature)

Features to be activated during the CU detection.

Items Enum Value	Description
DETECT_GLOBAL_COMMERCIAL_ULTIMATE	The feature is ON by default to not break the current behaviour of the capability. Either this feature or DETECT_DOMESTIC_COMMERCIAL_ULTIMATE has to be activated. Deactivating both makes the capability useless.
EVALUATE_SECONDARY_SIC	The feature is ON by default to not break the current behaviour of the capability. The feature can be seen as optional, which means it can be on or off, but in general the capability will be working.
DETECT_DOMESTIC_COMMERCIAL_ULTIMATE	The feature is OFF by default to not break the current behaviour of the capability. Either this feature or ``DETECT_GLOBAL_COMMERCIAL_ULTIMATE has to be activated. Deactivating both makes the capability useless.

Example: ["DETECT_GLOBAL_COMMERCIAL_ULTIMATE"]

featuresOffArray of strings(CommercialUltimateDetectionFeature)

Features to be deactivated during the CU detection.

Items Enum Value	Description
DETECT_GLOBAL_COMMERCIAL_ULTIMATE	The feature is ON by default to not break the current behaviour of the capability. Either this feature or DETECT_DOMESTIC_COMMERCIAL_ULTIMATE has to be activated. Deactivating both makes the capability useless.
EVALUATE_SECONDARY_SIC	The feature is ON by default to not break the current behaviour of the capability. The feature can be seen as optional, which means it can be on or off, but in general the capability will be working.
DETECT_DOMESTIC_COMMERCIAL_ULTIMATE	The feature is OFF by default to not break the current behaviour of the capability. Either this feature or ``DETECT_GLOBAL_COMMERCIAL_ULTIMATE has to be activated. Deactivating both makes the capability useless.

Example: ["DETECT_GLOBAL_COMMERCIAL_ULTIMATE"]

Response

application/json

{
  "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": [
    "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
  ],
  "featuresOff": [
    "DETECT_GLOBAL_COMMERCIAL_ULTIMATE"
  ]
}

Read Commercial Ultimate Detection Configuration Version

Request

Read a specific version of a commercial ultimate detection configuration by id and version number.

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

versionintegerrequired

Version number of the configuration.

Example: 1

curl -i -X GET \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/configurations/commercialultimatedetection/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json

idstring

Unique identifier of the commercial ultimate detection configuration version. Not to be confused with the configuration ID.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring

The name of the configuration

Example: "Configuration Name"

configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(CommercialUltimateDetectionConfiguration)

Workspace configuration to customize the Commercial Ultimate detection behavior.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"

createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"

modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "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": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true
}

List Business Entity Types

Request

List all available Business Entity Types and Standard Industrial Classification Codes

curl -i -X GET \
  https://idp.cdq.com/_mock/apis/dnb-api/api-v1/commercialultimatedetection/availablecodes

Responses

Successful operation

Bodyapplication/json

businessEntityTypesArray of objects(AvailableBusinessEntityTags)

All available Business Entity Types.

standardIndustrialClassificationsArray of objects(AvailableStandardIndustrialClassifications)

All available Standard Industrial Classification Codes.

divisionsArray of objects(AvailableStandardIndustrialClassificationDivisions)

All available Divisions.

subdivisionsArray of objects(AvailableStandardIndustrialClassificationSubdivisions)

All available Divisions.

Response

application/json

{
  "businessEntityTypes": [
    { … }
  ],
  "standardIndustrialClassifications": [
    { … }
  ],
  "divisions": [
    { … }
  ],
  "subdivisions": [
    { … }
  ]
}

Configuration

Operations

DNB API (1)

Registrations

Identification

Setup

Data Retrieval

Configurations

List Configurations

Request

Responses

Share the feedback!

Create Configuration

Request

Responses

Share the feedback!

Read Configuration

Request

Responses

Share the feedback!

Update Configuration

Request

Responses

Share the feedback!

Read Commercial Ultimate Detection Configuration Version

Request

Responses

Share the feedback!

List Business Entity Types

Request

Responses

Share the feedback!

Configuration

DNB API (1)

Registrations

Identification

Setup

Data Retrieval

Configurations

List Configurations

Request

Responses

Share the feedback!

Create Configuration

RequestExpand all

Responses

Share the feedback!

Read Configuration

Request

Responses

Share the feedback!

Update Configuration

RequestExpand all

Responses

Share the feedback!

Read Commercial Ultimate Detection Configuration Version

Request

Responses

Share the feedback!

List Business Entity Types

Request

Responses

Share the feedback!

Configuration

Request

Request