Loading

Direct 2.0
Collapse

On-Demand Entity Identification for Small Businesses

Also known as Small Business Match

Product Code(s)Not Applicable
Option(s)SmallBiz
Monitoring AvailableNo
InterfaceREST
MethodGET
Format(s)JSON
ServiceCompany
{version}6.0
6.0 Released OnMarch 10, 2017

Update History

No modifications have been made to this data layer since the initial release.

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective December 14, 2018.

Overview

The available criteria options are identical for Basic and Advanced match type requests. This feature will default to Advanced if a type is not specified.

There are several options available when implementing this feature.

1. Population: By default this feature will match against the universe of organizations for which D&B has assigned a D-U-N-S Number. An SBRI option (match type set to 'SBRI') is available to perform a match against the collection of U.S. small businesses for which a D-U-N-S Number has not been assigned.

2. Lookup: If a D-U-N-S Number is passed on the request, this feature will perform a direct match and return details about the organization to which the D-U-N-S Number is assigned. This option is not available when matching small businesses.

SBRI Lookup

In order to complete an SBRI lookup, name & address information must be submitted, along with matcht type text.

Global Availability

This data layer is only available for businesses domiciled in the United States.

The Company Match SBRI data layer is available for businesses domiciled in the following country:

CountryISO Code
United States of AmericaUS

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This feature is entitled as "On-Demand Entity Identification" for D&B Direct 2.0 customers.

NOTE: The SBRI match option of this feature will be entitled/invoiced under a "Search - Small Business Risk Insight" for D&B Direct 2.0 customers.

For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.

  • This particular data layer is included in the D&B Direct Onboard 2.0 suite.

Specification

Please refer to the Minimum Requirements section in this topic for scenario specific Required fields.

Sample Request (SmallBiz)
GET https://direct.dnb.com/V6.0/organizations?match=true&MatchTypeText=SBRI&SubjectName=GORMAN MANUFACTURING&StreetAddressLine=492 KOLLER STREET&PrimaryTownName=SAN FRANCISCO&CountryISOAlpha2Code=US&TerritoryName=CA&FullPostalCode=94110
Authorization: <My Token>

Input parameters that include a "-n" designation may be repeated on the request, using a sequence number. For example, for the parameter "example-n", create a request like https://{endpoint}?{other parameters}&example-1={value}&example-2={value} and so on. If a single instance of the parameter is used, it still requires a "-1" suffix.

Name Characteristics
ApplicationTransactionID Element, Optional

Unique Transaction ID of the request generated by the service

TransactionTimestamp Element, Optional

The date and time when this request was created.

SubmittingOfficeID Element, string, Optional

A number that identifies the system or the software application from where this request originated.

SubjectName Element, string, Required
StreetAddressLine-n (repeats twice) Element, dateTime, Optional
PrimaryTownName Element, Optional
CountryISOAlpha2Code Element, Required
TerritoryName Element, string, Required
FullPostalCode Element, string, Optional
TelephoneNumber Element, string, Optional
InternationalDialingCode Element, Optional
CandidateMaximumQuantity Element, string, Optional

A numeric value indicating the greatest number of candidate subjects that may be included in the result set.

MatchTypeText Element, Optional
CustomerReferenceText-n Element, Optional (up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

CustomerBillingEndorsementText Element, Optional

Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process.

Endpoint

Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.

NOTE: While "organizations" is part of this endpoint, there is no service by this name. Many D&B Direct calls have a similar structure; however, the {version} component is based on the SERVICE to which a given product is associated.

REST (Company)
GET https://direct.dnb.com/V{version}/organizations?match

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

Exception: If the Small Business option is selected, this operation will not return any results in the D&B Direct sandbox.

Feature Response

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

The results from a small business search will return subject identification numbers (Subject ID) that may be used to request the Small Business Risk Insight product for additional information about an organization.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (SmallBiz)
{
	"MatchResponse": {
		"TransactionDetail": {
			"ServiceTransactionID": "Id-0c90b85887646c00dc633900725c6df6-1",
			"TransactionTimestamp": "2017-03-02T16:35:10"
		},
		"TransactionResult": {
			"SeverityText": "Information",
			"ResultID": "CM000",
			"ResultText": "Success"
		},
		"MatchResponseDetail": {
			"CandidateMatchedQuantity": 1,
			"MatchCandidate": [{
				"SubjectID": "19248122082",
				"OrganizationPrimaryName": {
					"OrganizationName": {
						"$": "GORMAN MANUFACTURING COMPANY"
					}
				},
				"PrimaryAddress": {
					"StreetAddressLine": [{
						"LineText": "492 KOLLER STREET"
					}],
					"PrimaryTownName": "SAN FRANCISCO",
					"PostalCode": "94110",
					"TerritoryAbbreviatedName": "CA"
				},
				"TelephoneNumber": {
					"TelecommunicationNumber": "6505550000"
				},
				"MatchQualityInformation": {
					"ConfidenceCodeValue": 10,
					"MatchGradeText": "AAAAAZZ",
					"MatchGradeComponentCount": 7,
					"MatchGradeComponent": [{
						"MatchGradeComponentTypeText": {
							"$": "Name"
						},
						"MatchGradeComponentRating": "A",
						"MatchGradeComponentScore": 100,
						"DisplaySequence": "1"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "Street Number"
						},
						"MatchGradeComponentRating": "A",
						"MatchGradeComponentScore": 100,
						"DisplaySequence": "2"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "Street Name"
						},
						"MatchGradeComponentRating": "A",
						"MatchGradeComponentScore": 100,
						"DisplaySequence": "3"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "City"
						},
						"MatchGradeComponentRating": "A",
						"DisplaySequence": "4"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "State"
						},
						"MatchGradeComponentRating": "A",
						"DisplaySequence": "5"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "PO Box"
						},
						"MatchGradeComponentRating": "Z",
						"DisplaySequence": "6"
					}, {
						"MatchGradeComponentTypeText": {
							"$": "Phone"
						},
						"MatchGradeComponentRating": "Z",
						"MatchGradeComponentScore": 448,
						"DisplaySequence": "7"
					}]
				}
			}]
		}
	}
}



Name Characteristics
MatchResponse Aggregate,
MatchResponse { TransactionDetail Aggregate, string
MatchResponse { TransactionDetail { ApplicationTransactionID Element, string
MatchResponse { TransactionDetail { ServiceTransactionID Element, string
MatchResponse { TransactionDetail { TransactionTimestamp Element, date/Time
END: MatchResponse { TransactionDetail Aggregate,
MatchResponse { TransactionResult Aggregate,
MatchResponse { TransactionResult { SeverityText Element, string
MatchResponse { TransactionResult { ResultID Element, string
MatchResponse { TransactionResult { ResultText Element, string
MatchResponse { TransactionResult { ResultMessage Aggregate,
MatchResponse { TransactionResult { ResultMessage { ResultDescription Element, string
END: MatchResponse { TransactionResult { ResultMessage Aggregate,
END: MatchResponse { TransactionResult Aggregate,
MatchResponse { MatchResponseDetail Aggregate,
MatchResponse { MatchResponseDetail { CandidateMatchedQuantity Element, integer
MatchResponse { MatchResponseDetail { MatchCandidate Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { SubjectID Element, string

Auto-Generated Number that idenfies a business in the D&B's Non-DUNS Numbered Repository.

MatchResponse { MatchResponseDetail { MatchCandidate { OrganizationPrimaryName Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { OrganizationPrimaryName { OrganizationName Element,

Primary Business name of the organization

END: MatchResponse { MatchResponseDetail { MatchCandidate { OrganizationPrimaryName Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { TradeStyleName Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { TradeStyleName { OrganizationName Element, string

Trade Styles are additional business names used by a Company – also referred to as a DBA (doing business as) or AKA (also known as) names.

END: MatchResponse { MatchResponseDetail { MatchCandidate { TradeStyleName Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { StreetAddressLine Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { StreetAddressLine { LineText Element, string

Physical address line of the company

END: MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { StreetAddressLine Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { PrimaryTownName Element, string

City where company is located

MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { CountryISOAlpha2Code Element, string

ISO Country code Alpha 2 where company is located

MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { PostalCode Element, string

Postal code

MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { PostalCodeExtensionCode Element, string
MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress { TerritoryAbbreviatedName Element, string

Abbreviated State/province where company is located

END: MatchResponse { MatchResponseDetail { MatchCandidate { PrimaryAddress Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { TelephoneNumber Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { TelephoneNumber { TelecommunicationNumber Element, string
END: MatchResponse { MatchResponseDetail { MatchCandidate { TelephoneNumber Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { FamilyTreeMemberRole Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { FamilyTreeMemberRole { FamilyTreeMemberRoleText Element, string

Indicates if the location is HQ or Branch

END: MatchResponse { MatchResponseDetail { MatchCandidate { FamilyTreeMemberRole Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { ConfidenceCodeValue Element, integer

Confidence Code (CC) indicates the degree of Match between an Inquiry and a Match Result.

MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeText Element, string

Match Grade represents the closeness of a single attribute match to the data on D&B Reference Files. A = means the components should be considered to be the same, B = means there is some similarity, F = the components are different, Z = one or both components are missing or not used as part of the match experience Attributes includes:- Business Name, Street Number, Street Name, PO Box, City/Town, State, Postal Code, Telephone Number, Uniqueness, Density and Industry

MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponentCount Element, integer

The total number of constituent parts (e.g., Name, Street Number) that were used in the calculation of the Match Grade.

MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponent Aggregate,
MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponent { MatchGradeComponentTypeText Element, string
MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponent { MatchGradeComponentRating Element, string
MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponent { MatchGradeComponentScore Element, decimal
END: MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation { MatchGradeComponent Aggregate,
END: MatchResponse { MatchResponseDetail { MatchCandidate { MatchQualityInformation Aggregate,
END: MatchResponse { MatchResponseDetail { MatchCandidate Aggregate,
MatchResponse { MatchResponseDetail { InquiryReferenceDetail Aggregate,
MatchResponse { MatchResponseDetail { InquiryReferenceDetail { CustomerReferenceText Element, string

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

MatchResponse { MatchResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText Element, string

Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process.

END: MatchResponse { MatchResponseDetail { InquiryReferenceDetail Aggregate, string

Text recording the name of a city, town, township, village, borough, etc. where the business is located.

END: MatchResponse { MatchResponseDetail Aggregate, string

Text recording the name of the locally governed area which forms part of a centrally governed nation to identify where the business is located.

END: MatchResponse Aggregate, string

Records the place name of a village, town or suburb where this is not a Primary Town/City E.g. the Booker in Booker, High Wycombe.

Abbreviated Territory Names

When present, the Territory Abbreviated Name field will contain local abbreviations, which may be based on standard designations. For companies domiciled in the United States or Canada, this field will contain the second component of ISO 3166-2 codes. For example, the ISO 3166-2:US code for New Jersey is "US-NJ" and the value "NJ" will be delivered in this field. Similarly, the ISO 3166-2:CA code for Ontario is "CA-ON" and the value "ON" will be delivered in this field.

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM002, CM003, CM004, CM007, CM008, CM009, CM011, CM012, CM016, CP001, CP003, CP004, and SC001-SC009.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

Qualified usage (e.g., a successful response) is tracked and billed according to the terms & conditions of the customer's contract. The response codes CM000, CM010, PD002 and PD015 are considered successful. A built-in feature exists to prevent duplicate billing when multiple successful requests with the same criteria are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).

Business Elements

While D&B Direct uses a product canonical naming model in the request/response, many customers may be more familiar with the following business element labels.

Name Description
Auto Generated Number (AGN) Auto-Generated Number that idenfies a business in the D&B's Non-DUNS Numbered Repository.

PCM XPath: //MatchCandidate/ SubjectID

Branch/Headquarter Indicator Indicates if the location is HQ or Branch

PCM XPath: //MatchCandidate/ FamilyTreeMemberRole/ FamilyTreeMemberRoleText

Confidence Code Confidence Code (CC) indicates the degree of Match between an Inquiry and a Match Result.

PCM XPath: //MatchCandidate/ MatchQualityInformation/ ConfidenceCodeValue

Country Code ISO Country code Alpha 2 where company is located

PCM XPath: //MatchCandidate/ PrimaryAddress/ CountryISOAlpha2Code

Match Grade (Combined) Match Grade represents the closeness of a single attribute match to the data on D&B Reference Files.

PCM XPath: //MatchCandidate/ MatchQualityInformation/ MatchGradeText

Match Grade Component Quantity The total number of constituent parts (e.g., Name, Street Number) that were used in the calculation of the Match Grade.

PCM XPath: //MatchCandidate/ MatchQualityInformation/ MatchGradeComponentCount

Match Grade Component Type

PCM XPath: //MatchCandidate/ MatchQualityInformation/ MatchGradeComponent/ MatchGradeComponentTypeText

Match Grade Component Value

PCM XPath: //MatchCandidate/ MatchQualityInformation/ MatchGradeComponent/ MatchGradeComponentRating

Number Of Candidates

PCM XPath: //CandidateMatchedQuantity

Postal Code

PCM XPath: //MatchCandidate/ PrimaryAddress/ PostalCode

Primary Business Name Primary Business name of the organization

PCM XPath: //MatchCandidate/ OrganizationPrimaryName/ OrganizationName

Street Address Physical address line of the company

PCM XPath: //MatchCandidate/ PrimaryAddress/ StreetAddressLine/ LineText

Telephone Number The telephone number of the business.

PCM XPath: //MatchCandidate/ TelephoneNumber/ TelecommunicationNumber

Territory Abbreviated Name Abbreviated State/province where company is located

PCM XPath: //MatchCandidate/ PrimaryAddress/ TerritoryAbbreviatedName

Town Name City where company is located

PCM XPath: //MatchCandidate/ PrimaryAddress/ PrimaryTownName

Trade Style Name Trade Styles are additional business names used by a Company – also referred to as a DBA (doing business as) or AKA (also known as) names.

PCM XPath: //MatchCandidate/ TradeStyleName/ OrganizationName

What to do Next