D&B Optimizer

Status: Preview

Tier: Standard

Version: 2.0.0

Name

Summary

CleanseMatchAppend (string productId, string versionId, [Optional]string name, [Optional]string streetAddressLine1, [Optional]string streetAddressLine2, string countryISOAlpha2Code, [Optional]string postalCode, [Optional]string addressLocality, [Optional]string addressRegion, [Optional]string telephoneNumber, [Optional]string url, [Optional]string email, [advanced][Optional]string registrationNumber, [advanced][Optional]string registrationNumberType, [advanced][Optional]string confidenceLowerLevelThresholdValue, [advanced][Optional]string exclusionCriteria, [internal][Optional]string isCleanseAndStandardizeInformationRequired, [internal]string connector-version, [internal]string content-type)

Cleanse Match and Append

Enrich (string duns, string productId, string versionId, [internal]string connector-version, [internal]string content-type)

Retrieve data on a specific entity

Name

Summary

Name

Summary

CleanseMatchAppendResponse

EnrichResponse

Name

Type

Summary

Required

Related Action

productId

string

(Product Id)

The product ID provided by D&B that identifies the product to be returned.

True

versionId

string

(Version Id)

The version ID (e.g., v1) that identifies the product version to be returned.

True

name

string

(Name)

Up to 240 characters used to find the entity by its primary name, tradestyle names, or former names.

False

streetAddressLine1

string

(Street Address Line 1)

Up to 70 characters of the first line of the entity's street address.

False

streetAddressLine2

string

(Street Address Line 2)

Up to 70 characters of the second line of the entity's street address

False

countryISOAlpha2Code

string

(Country ISO Alpha Code)

The 2-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the entity.

True

postalCode

string

(Postal Code)

Up to 10 characters of the identifier used by the local country's postal authority to identify where the address is located.

False

addressLocality

string

(Address Locality)

1 to 50 characters that identifies the city, town, township, village, borough, etc. where the entity is located.

False

addressRegion

string

(Address Region)

The name of the locally governed area that forms part of a centrally governed nation to identify where the address is located.

False

telephoneNumber

string

(Telephone Number)

Up to 32 characters of the telephone number--the sequence of digits used for voice communication with the entity. This sequence of digits includes the area code or city code and domestic dialing code.

False

url

string

(URL)

A URL used to identify an entity by its email domain.

False

email

string

(Email)

An email address used to identify an entity by its email domain.

False

registrationNumber

string

(Registration Number)

The number assigned by an external body or by D&B that either uniquely identifies or helps to identify an organization.

False

registrationNumberType

string

(Registration Number Type)

A unique code assigned by D&B to identify the type of registration number.

False

confidenceLowerLevelThresholdValue

string

(Confidence Lower Level)Values: [10, 9, 8, 7, 6, 5, 4, 3, 2, 1, ]

The lowest confidence level for entities returned in the response. Valid values are 1 to 10, if not specified the default of 4 is used.

False

exclusionCriteria

string

(Exclusion Criteria)

Provides the ability to exclude entities based on several properties.

False

isCleanseAndStandardizeInformationRequired

string

(isCleanseAndStandardizeInformationRequired)Values: [true, false]

False

connector-version

string

True

content-type

string

True

Name

Type

Summary

Required

Related Action

duns

string

(D-U-N-S Number)

The D-U-N-S Number is an identification number assigned by D&B that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S).

True

productId

string

(Product Id)

The product ID provided by D&B that identifies the product to be returned.

True

versionId

string

(Version Id)

The version ID (e.g., v1) that identifies the product version to be returned.

True

connector-version

string

True

content-type

string

True

Name

Type

Summary

duns

string

DUNS Number

The D-U-N-S Number is an identification number assigned by D&B that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S).

primary_name

string

Primary Business Name

The single name by which the entity is primarily known or identified.

trade_style

string

Trade Style Name

The name that the entity trades under for commercial purposes  although its registered  legal name used for contracts and other formal situations may be another name.

address.streetline1

string

Street Address

The first line of the address where the entity is located.

address.streetline2

string

Street Address (2)

The second line of the address where the entity is located.

address.city

string

Address City

The name of the city, town, township, village, borough, etc. in which this address is located.

address.territory_code

string

Territory Code

The standard code of the locally governed area that forms part of a centrally governed nation to identify where this address is located.

address.territory_name

string

Territory Name

The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located.

address.postal_code

string

Postal Code

An identifier used by the local country Postal Authority to identify where the business is located.

address.isoalpha2code

string

ISO Country Code

The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the business entity.

address.country_name

string

ISO Country Name

The country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the business entity.

phone.international_code

string

Telephone ISD Code

This sequence of digits contains the International Subscriber Dialling (ISD) code.

phone.number

string

Telephone Number

A sequence of digits used for voice communication with the entity. This sequence of digits includes the area code or city code and domestic dialing code.

primary_sic

string

Industry Code

The code that identifies the business activity in which the entity is engaged.

industrycode.description

string

Industry Code Description

The description for the corresponding Industry Code.

employees.local

integer(int32)

Employee Quantity Details (Local)

The total number of people engaged by the entity to perform its operations. The scope of this employee figure is identified in informationScopeDescription.

employees.global

integer(int32)

Employee Quantity Details (Total)

The total number of people engaged by the entity to perform its operations. The scope of this employee figure is identified in informationScopeDescription.

financials.todate

string(date-time)

Financial Statement To Date

The date when the accounting period ended.  If the Reliability Code denotes the figures are projected (future), then this is the date when the accounting period will end.

financials_global.value

integer(int32)

Sales Revenue Amount in USD

The monetary value of income received from customers from the sale of the entity's goods and/or services in USD.  This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer.

financials_local.value

integer(int32)

Sales Revenue Amount in the local currency

The monetary value of income received from customers from the sale of the entity's goods and/or services in local currency.  This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer.

financials_local.currency

string

Local currency code

The local currency code for this entity.

location_types

string

Location Types

A semi-colon delimited list of Location Types for this entity.

is_headquarters

boolean

Headquarters Indicator

Indicates if the entity is a Headquarters or not.

is_global_ultimate

boolean

Global Ultimate Indicator

Indicates if the entity is a Global Ultimate or not.

is_domestic_ultimate

boolean

Domestic Ultimate Indicator

Indicates if the entity is a Domestic Ultimate or not.

is_parent_headquarters

boolean

Parent Headquarters Indicator

Indicates if the entity is a Parent Headquarters or not.

is_parent

boolean

Parent Indicator

Indicates if the entity is a Parent or not.

is_sibling

boolean

Sibling Indicator

Indicates if the entity is a Sibling or not.

is_division

boolean

Division Indicator

Indicates if the entity is a Division or not.

is_branch_division

boolean

Branch Division Indicator

Indicates if the entity is a Branch Division or not.

is_subsidiary

boolean

Subsidiary Indicator

Indicates if the entity is a Subsidiary or not.

is_branch

boolean

Branch Indicator

Indicates if the entity is a Branch or not.

is_single_location

boolean

Single Location Indicator

Indicates if the entity is a Single Location or not.

parent.duns

string

Parent D-U-N-S Number

The D-U-N-S number of the parent entity. A parent is a corporation that owns more than 50% of another corporation's capital stock; these owned companies are subsidiaries to the parent entity. 

parent.name

string

Parent Business Name

The business name of the parent entity. A parent is a corporation that owns more than 50% of another corporation's capital stock.

domestic_ultimate.duns

string

Domestic Ultimate D-U-N-S Number

The D-U-N-S Number of the highest level parent within a corporate family tree that is domiciled in the same country as the requested entity. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own domestic ultimate.

domestic_ultimate.name

string

Domestic Ultimate Name

The name of the highest business in the family tree that is in the same country as the subject.

global_ultimate.duns

string

Global Ultimate D-U-N-S Number

The D-U-N-S number of the highest level parent within a corporate family tree. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own global ultimate. 

global_ultimate.name

string

Global Ultimate Name

The primary name of the global ultimate business.

entity_type

integer(int32)

Business Legal Structure

The D&B Code for the corresponding Business Legal Structure

entity_type.description

string

Business Legal Structure Description

The name of the legal form or structure of the entity as registered with government authorities (e.g., partnership, corporation, private limited company, government department, proprietorship). A unique code assigned by D&B to identify the legal form or structure of the entity as registered with government authorities

match.confidence

integer(int32)

Match Confidence

Confidence codes are based on the detailed MatchGrade Strings™; over 4 million string combinations are mapped to 10 Confidence Codes, allowing for broad categorization of matched records. The higher the number, the higher the confidence that it is an accurate match.

match.profile

string

Match Profile

Match Data Profile (MDP) Codes indicate if and how each component type was matched in the returned candidate.

match.grade

string

Match Grade

MatchGrade Strings provide qualitative assessments between inquiry and reference components. A - Considered the same, B - Some similiarity, F - Considered different, Z - Missing information, cannot make conclusion.

is_delisted

boolean

Delisted Indicator

Indicator as to the whether or not the entity has asked that their data not be included in D&B's marketing file for prospecting.

operating_status

integer(int32)

Operating Status

The D&B code for the corresponding Operating Status

operating_status.description

string

Operating Status Description

The entity's functional state or trading status (e.g., active, out of business). A unique code assigned by D&B to identify the entity's functional state or trading status.

match_grade.name

string

Match Grade - Organization Name

Match Grade - Organization Name

match_grade.street_number

string

Match Grade - Street Number

Match Grade - Street Number

match_grade.street_name

string

Match Grade - Street Name

Match Grade - Street Name

match_grade.city

string

Match Grade - Town/City

Match Grade - Town/City

match_grade.state

string

Match Grade - State/Region

Match Grade - State/Region

match_grade.po_box

string

Match Grade - PO Box

Match Grade - PO Box

match_grade.phone

string

Match Grade - Phone Number

Match Grade - Phone Number

match_grade.postal_code

string

Match Grade - Postal Code

Match Grade - Postal Code

match_grade.density

string

Match Grade - Density

Match Grade - Density

match_grade.uniqueness

string

Match Grade - Uniqueness

Match Grade - Uniqueness

match_grade.industry

string

Match Grade - SIC Code

Match Grade - SIC Code

Name

Type

Summary

duns

string

DUNS Number

The D-U-N-S Number is an identification number assigned by D&B that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S).

primary_name

string

Primary Business Name

The single name by which the entity is primarily known or identified.

trade_style

string

Trade Style Name

The name that the entity trades under for commercial purposes  although its registered  legal name used for contracts and other formal situations may be another name.

address.streetline1

string

Street Address

The first line of the address where the entity is located.

address.streetline2

string

Street Address (2)

The second line of the address where the entity is located.

address.city

string

Address City

The name of the city, town, township, village, borough, etc. in which this address is located.

address.territory_code

string

Territory Code

The standard code of the locally governed area that forms part of a centrally governed nation to identify where this address is located.

address.territory_name

string

Territory Name

The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located.

address.postal_code

string

Postal Code

An identifier used by the local country Postal Authority to identify where the business is located.

address.isoalpha2code

string

ISO Country Code

The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the business entity.

address.country_name

string

ISO Country Name

The country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the business entity.

phone.international_code

string

Telephone ISD Code

This sequence of digits contains the International Subscriber Dialling (ISD) code.

phone.number

string

Telephone Number

A sequence of digits used for voice communication with the entity. This sequence of digits includes the area code or city code and domestic dialing code.

primary_sic

string

Industry Code

The code that identifies the business activity in which the entity is engaged.

industrycode.description

string

Industry Code Description

The description for the corresponding Industry Code.

employees.local

integer(int32)

Employee Quantity Details (Local)

The total number of people engaged by the entity to perform its operations. The scope of this employee figure is identified in informationScopeDescription.

employees.global

integer(int32)

Employee Quantity Details (Total)

The total number of people engaged by the entity to perform its operations. The scope of this employee figure is identified in informationScopeDescription.

financials.todate

string(date-time)

Financial Statement To Date

The date when the accounting period ended.  If the Reliability Code denotes the figures are projected (future), then this is the date when the accounting period will end.

financials_global.value

integer(int32)

Sales Revenue Amount in USD

The monetary value of income received from customers from the sale of the entity's goods and/or services in USD.  This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer.

financials_local.value

integer(int32)

Sales Revenue Amount in the local currency

The monetary value of income received from customers from the sale of the entity's goods and/or services in local currency.  This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer.

financials_local.currency

string

Local currency code

The local currency code for this entity.

location_types

string

Location Types

A semi-colon delimited list of Location Types for this entity.

is_headquarters

boolean

Headquarters Indicator

Indicates if the entity is a Headquarters or not.

is_global_ultimate

boolean

Global Ultimate Indicator

Indicates if the entity is a Global Ultimate or not.

is_domestic_ultimate

boolean

Domestic Ultimate Indicator

Indicates if the entity is a Domestic Ultimate or not.

is_parent_headquarters

boolean

Parent Headquarters Indicator

Indicates if the entity is a Parent Headquarters or not.

is_parent

boolean

Parent Indicator

Indicates if the entity is a Parent or not.

is_sibling

boolean

Sibling Indicator

Indicates if the entity is a Sibling or not.

is_division

boolean

Division Indicator

Indicates if the entity is a Division or not.

is_branch_division

boolean

Branch Division Indicator

Indicates if the entity is a Branch Division or not.

is_subsidiary

boolean

Subsidiary Indicator

Indicates if the entity is a Subsidiary or not.

is_branch

boolean

Branch Indicator

Indicates if the entity is a Branch or not.

is_single_location

boolean

Single Location Indicator

Indicates if the entity is a Single Location or not.

parent.duns

string

Parent D-U-N-S Number

The D-U-N-S number of the parent entity. A parent is a corporation that owns more than 50% of another corporation's capital stock; these owned companies are subsidiaries to the parent entity. 

parent.name

string

Parent Business Name

The business name of the parent entity. A parent is a corporation that owns more than 50% of another corporation's capital stock.

domestic_ultimate.duns

string

Domestic Ultimate D-U-N-S Number

The D-U-N-S Number of the highest level parent within a corporate family tree that is domiciled in the same country as the requested entity. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own domestic ultimate.

domestic_ultimate.name

string

Domestic Ultimate Name

The name of the highest business in the family tree that is in the same country as the subject.

global_ultimate.duns

string

Global Ultimate D-U-N-S Number

The D-U-N-S number of the highest level parent within a corporate family tree. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own global ultimate. 

global_ultimate.name

string

Global Ultimate Name

The primary name of the global ultimate business.

entity_type

integer(int32)

Business Legal Structure

The D&B Code for the corresponding Business Legal Structure

entity_type.description

string

Business Legal Structure Description

The name of the legal form or structure of the entity as registered with government authorities (e.g., partnership, corporation, private limited company, government department, proprietorship). A unique code assigned by D&B to identify the legal form or structure of the entity as registered with government authorities

is_delisted

boolean

Delisted Indicator

Indicator as to the whether or not the entity has asked that their data not be included in D&B's marketing file for prospecting.

operating_status

integer(int32)

Operating Status

The D&B code for the corresponding Operating Status

operating_status.description

string

Operating Status Description

The entity's functional state or trading status (e.g., active, out of business). A unique code assigned by D&B to identify the entity's functional state or trading status.