> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Dun & Bradstreet: Dnb Cleanse Match

> Match a company name, domain or registration number to D-U-N-S candidates. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Match a company name, domain or registration number to D-U-N-S candidates.

<Info>
  Tool ID: `dnb_cleanse_match`
</Info>

## Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example.

Inspect the live contract before executing it:

```bash theme={null}
deepline tools get dnb_cleanse_match --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get dnb_cleanse_match --json` for the complete live contract.

## Input reference

Match a company name to its DUNS number and ranked candidates. Also resolve a known D-U-N-S number, or an ISO country code with a company website (url), email, telephone, registration number or address. Returns D\&B matching candidates and match-quality information for customer selection. Requires a customer Direct+ key and secret with matching access.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | No | — | Business name as supplied by the caller. Minimum length: 1. |
| `payload.countryISOAlpha2Code` | `string` | No | — | ISO 3166-1 alpha-2 country code. Minimum length: 2. Maximum length: 2. |
| `payload.streetAddressLine1` | `string` | No | — | Minimum length: 1. |
| `payload.addressLocality` | `string` | No | — | Minimum length: 1. |
| `payload.addressRegion` | `string` | No | — | Minimum length: 1. |
| `payload.postalCode` | `string` | No | — | Minimum length: 1. |
| `payload.telephoneNumber` | `string` | No | — | Minimum length: 1. |
| `payload.registrationNumber` | `string` | No | — | Minimum length: 1. |
| `payload.candidateMaximumQuantity` | `integer` | No | `9` | Minimum: 1. Maximum: 50. |
| `payload.confidenceLowerLevelThresholdValue` | `integer` | No | — | Minimum: 1. Maximum: 10. |
| `payload.duns` | `string` | No | — | Minimum length: 1. Pattern: `^[0-9]&#123;9&#125;$`. |
| `payload.url` | `string` | No | — | Company website or domain, as accepted by D\&B. Minimum length: 1. |
| `payload.email` | `string` | No | — | Minimum length: 1. |
| `payload.inLanguage` | `string` | No | — | Minimum length: 1. |
| `payload.exclusionCriteria` | `string` | No | — | D\&B exclusion selector; the public example uses ExcludeOutofBusiness. Minimum length: 1. |
| `payload.customerReference1` | `string` | No | — | Minimum length: 1. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Match a company name to its DUNS number and ranked candidates. Also resolve a known D-U-N-S number, or an ISO country code with a company website (url), email, telephone, registration number or address. Returns D&B matching candidates and match-quality information for customer selection. Requires a customer Direct+ key and secret with matching access.",
    "properties": {
      "name": {
        "type": "string",
        "description": "Business name as supplied by the caller.",
        "minLength": 1
      },
      "countryISOAlpha2Code": {
        "type": "string",
        "description": "ISO 3166-1 alpha-2 country code.",
        "minLength": 2,
        "maxLength": 2
      },
      "streetAddressLine1": {
        "type": "string",
        "minLength": 1
      },
      "addressLocality": {
        "type": "string",
        "minLength": 1
      },
      "addressRegion": {
        "type": "string",
        "minLength": 1
      },
      "postalCode": {
        "type": "string",
        "minLength": 1
      },
      "telephoneNumber": {
        "type": "string",
        "minLength": 1
      },
      "registrationNumber": {
        "type": "string",
        "minLength": 1
      },
      "candidateMaximumQuantity": {
        "type": "integer",
        "default": 9,
        "minimum": 1,
        "maximum": 50
      },
      "confidenceLowerLevelThresholdValue": {
        "type": "integer",
        "minimum": 1,
        "maximum": 10
      },
      "duns": {
        "type": "string",
        "minLength": 1,
        "pattern": "^[0-9]{9}$"
      },
      "url": {
        "type": "string",
        "description": "Company website or domain, as accepted by D&B.",
        "minLength": 1
      },
      "email": {
        "type": "string",
        "minLength": 1
      },
      "inLanguage": {
        "type": "string",
        "minLength": 1
      },
      "exclusionCriteria": {
        "type": "string",
        "description": "D&B exclusion selector; the public example uses ExcludeOutofBusiness.",
        "minLength": 1
      },
      "customerReference1": {
        "type": "string",
        "minLength": 1
      }
    },
    "required": [],
    "anyOf": [
      {
        "required": [
          "duns"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "name"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "url"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "email"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "telephoneNumber"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "registrationNumber"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "streetAddressLine1"
        ]
      },
      {
        "required": [
          "countryISOAlpha2Code",
          "postalCode"
        ]
      }
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "additionalProperties": true
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Dun & Bradstreet provider guide](/docs/providers/dnb/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.