On-Demand Entity Identification for Small Businesses
Also known as Small Business Match
| Product Code(s) | Not Applicable |
| Option(s) | SmallBiz |
| Monitoring Available | No |
| Interface | SOAP |
| WSDL | download |
| Format(s) | XML |
| Service | Company |
| Operation | Match |
| {version} | 4.0 |
| 4.0 Released On | October 3, 2013 |
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 November 09, 2020.
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:
| Country | ISO Code |
|---|---|
| United States of America | US |
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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/CompanyServiceV2.0">
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-11">
<wsse:Username>MyUserName</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<com:MatchRequest ServiceVersionNumber="4.0">
<MatchRequestDetail>
<InquiryDetail>
<SubjectName>GORMAN MANUFACTURING</SubjectName>
<Address>
<StreetAddressLine>
<LineText>492 KOLLER STREET</LineText>
</StreetAddressLine>
<PrimaryTownName>SAN FRANCISCO</PrimaryTownName>
<CountryISOAlpha2Code>US</CountryISOAlpha2Code>
<TerritoryName>CA</TerritoryName>
<FullPostalCode>94110</FullPostalCode>
</Address>
</InquiryDetail>
<MatchSpecification>
<MatchTypeText>SBRI</MatchTypeText>
</MatchSpecification>
</MatchRequestDetail>
</com:MatchRequest>
</soapenv:Body>
</soapenv:Envelope>
| Name | Characteristics |
|---|---|
| MatchRequest | Aggregate, Required |
| MatchRequest@ServiceVersionNumber | Attribute, Optional |
| MatchRequest@xsi:schemaLocation | Attribute, Optional |
| MatchRequest. TransactionDetail | Aggregate, Optional |
| MatchRequest. TransactionDetail. ApplicationTransactionID | Element, Optional Unique Transaction ID of the request generated by the service |
| MatchRequest. TransactionDetail. TransactionTimestamp | Element, Optional The date and time when this request was created. |
| MatchRequest. TransactionDetail. SubmittingOfficeID | Element, Optional A number that identifies the system or the software application from where this request originated. |
| END: MatchRequest. TransactionDetail | Aggregate, Optional |
| MatchRequest. MatchRequestDetail | Aggregate, Required |
| MatchRequest. MatchRequestDetail. InquiryDetail | Aggregate, Required |
| MatchRequest. MatchRequestDetail. InquiryDetail. SubjectName | Element, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. StreetAddressLine | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. StreetAddressLine. LineText | Element, Optional |
| END: MatchRequest. MatchRequestDetail. InquiryDetail. Address. StreetAddressLine | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. PrimaryTownName | Element, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. CountryISOAlpha2Code | Element, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. TerritoryName | Element, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. Address. FullPostalCode | Element, Optional |
| END: MatchRequest. MatchRequestDetail. InquiryDetail. Address | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. TelephoneNumber | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. TelephoneNumber. TelecommunicationNumber | Element, Optional |
| MatchRequest. MatchRequestDetail. InquiryDetail. TelephoneNumber. InternationalDialingCode | Element, Optional |
| END: MatchRequest. MatchRequestDetail. InquiryDetail. TelephoneNumber | Aggregate, Optional |
| END: MatchRequest. MatchRequestDetail. InquiryDetail | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. MatchSpecification | Aggregate, Optional Records data used by a matching routine to identify the customer and search parameters. |
| MatchRequest. MatchRequestDetail. MatchSpecification. CandidateMaximumQuantity | Element, Optional A numeric value indicating the greatest number of candidate subjects that may be included in the result set. |
| MatchRequest. MatchRequestDetail. MatchSpecification. MatchTypeText | Element, Optional |
| END: MatchRequest. MatchRequestDetail. MatchSpecification | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryReferenceDetail | Aggregate, Optional |
| MatchRequest. MatchRequestDetail. InquiryReferenceDetail. CustomerReferenceText | Element, Optional A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. |
| MatchRequest. MatchRequestDetail. InquiryReferenceDetail. 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. |
| END: MatchRequest. MatchRequestDetail. InquiryReferenceDetail | Aggregate, Optional |
| END: MatchRequest. MatchRequestDetail | Aggregate, Required Abbreviated State/province where company is located |
| END: MatchRequest | Aggregate, Required |
Endpoint
Use the following endpoint with the downloadable WSDL to request this feature.
| SOAP (Company) |
|---|
| https://direct.dnb.com/Company/V{version} |
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
Specification
The following is a list of the possible data fields returned by this operation in the XML 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.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<com:MatchResponse ServiceVersionNumber="4.0" xmlns:com="http://services.dnb.com/CompanyServiceV2.0">
<TransactionDetail>
<ServiceTransactionID>Id-f78eb858025b6c00c0633900ee534ed2-1</ServiceTransactionID>
<TransactionTimestamp>2017-03-02T16:30:32</TransactionTimestamp>
</TransactionDetail>
<TransactionResult>
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
</TransactionResult>
<MatchResponseDetail>
<CandidateMatchedQuantity>1</CandidateMatchedQuantity>
<MatchCandidate>
<SubjectID>19248122082</SubjectID>
<OrganizationPrimaryName>
<OrganizationName>GORMAN MANUFACTURING COMPANY</OrganizationName>
</OrganizationPrimaryName>
<PrimaryAddress>
<StreetAddressLine>
<LineText>492 KOLLER STREET</LineText>
</StreetAddressLine>
<PrimaryTownName>SAN FRANCISCO</PrimaryTownName>
<PostalCode>94110</PostalCode>
<TerritoryAbbreviatedName>CA</TerritoryAbbreviatedName>
</PrimaryAddress>
<TelephoneNumber>
<TelecommunicationNumber>6505550000</TelecommunicationNumber>
</TelephoneNumber>
<MatchQualityInformation>
<ConfidenceCodeValue>10</ConfidenceCodeValue>
<MatchGradeText>AAAAAZZ</MatchGradeText>
<MatchGradeComponentCount>7</MatchGradeComponentCount>
<MatchGradeComponent>
<MatchGradeComponentTypeText>Name</MatchGradeComponentTypeText>
<MatchGradeComponentRating>A</MatchGradeComponentRating>
<MatchGradeComponentScore>100</MatchGradeComponentScore>
<DisplaySequence>1</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>Street Number</MatchGradeComponentTypeText>
<MatchGradeComponentRating>A</MatchGradeComponentRating>
<MatchGradeComponentScore>100</MatchGradeComponentScore>
<DisplaySequence>2</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>Street Name</MatchGradeComponentTypeText>
<MatchGradeComponentRating>A</MatchGradeComponentRating>
<MatchGradeComponentScore>100</MatchGradeComponentScore>
<DisplaySequence>3</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>City</MatchGradeComponentTypeText>
<MatchGradeComponentRating>A</MatchGradeComponentRating>
<DisplaySequence>4</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>State</MatchGradeComponentTypeText>
<MatchGradeComponentRating>A</MatchGradeComponentRating>
<DisplaySequence>5</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>PO Box</MatchGradeComponentTypeText>
<MatchGradeComponentRating>Z</MatchGradeComponentRating>
<DisplaySequence>6</DisplaySequence>
</MatchGradeComponent>
<MatchGradeComponent>
<MatchGradeComponentTypeText>Phone</MatchGradeComponentTypeText>
<MatchGradeComponentRating>Z</MatchGradeComponentRating>
<MatchGradeComponentScore>448</MatchGradeComponentScore>
<DisplaySequence>7</DisplaySequence>
</MatchGradeComponent>
</MatchQualityInformation>
</MatchCandidate>
</MatchResponseDetail>
</com:MatchResponse>
</soapenv:Body>
</soapenv:Envelope>
| Name | Characteristics |
|---|---|
| MatchResponse | Aggregate, Required |
| MatchResponse@ServiceVersionNumber | Attribute, string, Required |
| MatchResponse. TransactionDetail | Aggregate, string, Required |
| MatchResponse. TransactionDetail. ApplicationTransactionID | Element, string, Optional |
| MatchResponse. TransactionDetail. ServiceTransactionID | Element, string, Required |
| MatchResponse. TransactionDetail. TransactionTimestamp | Element, date/Time, Required |
| END: MatchResponse. TransactionDetail | Aggregate, Required |
| MatchResponse. TransactionResult | Aggregate, Required |
| MatchResponse. TransactionResult. SeverityText | Element, string, Required |
| MatchResponse. TransactionResult. ResultID | Element, string, Required |
| MatchResponse. TransactionResult. ResultText | Element, string, Optional |
| MatchResponse. TransactionResult. ResultMessage | Aggregate, Optional |
| MatchResponse. TransactionResult. ResultMessage. ResultDescription | Element, string, Optional |
| END: MatchResponse. TransactionResult. ResultMessage | Aggregate, Optional |
| END: MatchResponse. TransactionResult | Aggregate, Required |
| MatchResponse. MatchResponseDetail | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. CandidateMatchedQuantity | Element, integer, Required |
| MatchResponse. MatchResponseDetail. MatchCandidate | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. SubjectID | Element, string, Optional Auto-Generated Number that idenfies a business in the D&B's Non-DUNS Numbered Repository. |
| MatchResponse. MatchResponseDetail. MatchCandidate. OrganizationPrimaryName | Aggregate, Required |
| MatchResponse. MatchResponseDetail. MatchCandidate. OrganizationPrimaryName. OrganizationName | Element, Required Primary Business name of the organization |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. OrganizationPrimaryName | Aggregate, Required |
| MatchResponse. MatchResponseDetail. MatchCandidate. TradeStyleName | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. TradeStyleName. OrganizationName | Element, string, Required 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, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. StreetAddressLine | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. StreetAddressLine. LineText | Element, string, Required Physical address line of the company |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. StreetAddressLine | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. PrimaryTownName | Element, string, Optional City where company is located |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. CountryISOAlpha2Code | Element, string, Optional ISO Country code Alpha 2 where company is located |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. PostalCode | Element, string, Optional Postal code |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. PostalCodeExtensionCode | Element, string, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress. TerritoryAbbreviatedName | Element, string, Optional Abbreviated State/province where company is located |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. PrimaryAddress | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. TelephoneNumber | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. TelephoneNumber. TelecommunicationNumber | Element, string, Required |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. TelephoneNumber | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. FamilyTreeMemberRole | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. FamilyTreeMemberRole. FamilyTreeMemberRoleText | Element, string, Optional Indicates if the location is HQ or Branch |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. FamilyTreeMemberRole | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. ConfidenceCodeValue | Element, integer, Optional Confidence Code (CC) indicates the degree of Match between an Inquiry and a Match Result. |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. MatchGradeText | Element, string, Optional 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, Optional 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, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. MatchGradeComponent. MatchGradeComponentTypeText | Element, string, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. MatchGradeComponent. MatchGradeComponentRating | Element, string, Optional |
| MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. MatchGradeComponent. MatchGradeComponentScore | Element, decimal, Optional |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation. MatchGradeComponent | Aggregate, Optional |
| END: MatchResponse. MatchResponseDetail. MatchCandidate. MatchQualityInformation | Aggregate, Optional |
| END: MatchResponse. MatchResponseDetail. MatchCandidate | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. InquiryReferenceDetail | Aggregate, Optional |
| MatchResponse. MatchResponseDetail. InquiryReferenceDetail. CustomerReferenceText | Element, string, Optional 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, 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. |
| END: MatchResponse. MatchResponseDetail. InquiryReferenceDetail | Aggregate, Optional An identifier used by the local country Postal Authority to identify a particular geographic location. For example, in Belgium, Postal Code 9000 identifies the town of GHENT. |
| END: MatchResponse. MatchResponseDetail | Aggregate, Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. |
| END: MatchResponse | Aggregate, Required The name of the country where this address belongs to. |
NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.
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 |
Feature Notes
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.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.