Sales Intelligence
Product | D&B Data Exchange |
Data Provider | Iridium Information Resources |
Product Code(s) | n/a |
Level(s) | n/a |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | DataExchange |
{version} | 1.0 |
Initial Release | September 30, 2014 |
Using a D-U-N-S Number, find the business events or sales "triggers" for US companies that are planning a move into new office space or receiving new SBA-backed commercial loans. The Iridium triggering event ID can then be used to find more detail about the event, the company, and its key contacts. Relocation triggers about companies and the location of triggers are based on UCC filings. Knowing these triggers can help businesses find and prioritize leads to reach prospective customers before their competition.
IMPORTANT: Please note all Data Exchange APIs are decommissioned.
Update History
No modifications have been made to this data layer since the initial release.
What to do First
This additional feature can be used to obtain SalesWire ID values used to retrieve a complete trigger record along with company data.
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
When requesting this D&B Data Exchange feature, a valid SalesWire trigger event ID will be required.
Global Availability
This data layer is only available for businesses domiciled in the United States.
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 "Data Exchange" 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 NOT included in the D&B Direct Onboard suite.
Data Exchange Request Setup
D&B Direct specific request parameters are submitted to D&B Data Exchange service requests in the HTTP Header. Partner specific request parameters are submitted in the URL (GET) or body (POST).
GET/POST/PUT/DELETE https://direct.dnb.com/dataexchange/{PartnerIndentifier}/{Partners’s URI}?{Partner’s Query Parameters} ApplicationTransactionID: <Transaction ID assigned by the customer> Accept: application/json Authorization: <Customer’s Authentication Token> ArchiveProductOptOutIndicator: <true/false> ExtendArchivePeriodIndicator: <true/false> Content-Type: application/json [BODY] <Partner Request (POST only)>
GET https://direct.dnb.com/dataexchange/profound/domain/abbott.com Authorization: <MyToken> ApplicationTransactionID: ID_001 ArchiveProductOptOutIndicator: false ExtendArchivePeriodIndicator: false CustomerReferenceText: Order placed by Joe CustomerBillingEndorsementText: Order placed by Joe for abbot.com
Specification
GET https://direct.dnb.com/dataexchange/iridium/dnb/triggers/SW313807 Authorization: <MyToken> Accept: application/json ApplicationTransactionID: ID_001 ArchiveProductOptOutIndicator: false ExtendArchivePeriodIndicator: false CustomerReferenceText: Order placed by Joe CustomerBillingEndorsementText: Order placed by Joe
Name | Characteristics |
---|---|
SalesWireID | string (up to 12 chars), required, embedded in endpoint |
Endpoint
For each D&B Data Exchange partner operations, a partner identifier and URI are appended to a standard Data Exchange REST URL. As a result of this approach, there may be instances where a partner URI contains version information that is different from the D&B Data Exchange version.
Use the following endpoint for requesting this feature.
REST (DataExchange) |
---|
GET https://direct.dnb.com/dataexchange/iridium/dnb/triggers/{SalesWireID} |
Testing
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Feature Response
Specification
NOTE: The information returned from this Data Exchange feature will not be presented in the product canonical model used by other D&B Direct services.
The following is a list of the possible data fields returned by this operation.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
HTTP/1.1 200 OK ApplicationTransactionID: ID_001 CustomerBillingEndorsementText: Order placed by Joe CustomerReferenceText: Order placed by Joe Date: Tue, 12 Nov 2013 15:54:00 GMT DNB-PortfolioAssetID: 36590291 DNB-ResultID: CM000 DNB-ResultText: success DNB-ServiceTransactionID: Id-4d7cd8c752824f1822fb470b { "message": "", "result": { "annual_sales": null, "company_city": "Hartford", "company_country": "US", "company_county": "Hartford", "company_msa": "3280", "company_msa_name": "Hartford", "company_name": "CREC Schools", "company_size": 300, "company_state": "Connecticut", "company_street": "111 Charter Oak Avenue", "company_zip": "06106", "fax": null, "gsa": 0, "id": "SW313807", "lead_city": "Windsor", "lead_country": "US", "lead_county": "Hartford", "lead_msa": "3280", "lead_msa_name": "Hartford", "lead_state": "Connecticut", "lead_street": null, "lead_type": "Relocation/Construction/Expansion", "lead_zip": "06006", "phone": "860-524-4065", "project_due_date": null, "project_size": null, "project_value": null, "publication_date": "09/20/2013", "sales_intelligence": "Windsor, CT -- New Project -- Company: CREC Schools, 111 Charter Oak Avenue Hartford, CT 06106 Telephone: (860) 524-4065; http://www.crecschools.org/ Project details: CREC Academy of Aerospace & Engineering. SIC Code: 8211 Education, Elementary and Secondary Schools. Middle/Senior High School, Remodel. Project Timeline: Planning/Approval.", "sic": "8211", "sic_description": "Elementary And Secondary Schools", "url": "http://www.crecschools.org/" } }
Name | Characteristics |
---|---|
message | string(255), repeats 1 On error, extra information for debugging purposes. |
id | string(12), repeats 1 Iridium's internal ID for the event. |
sales_intelligence | string(max), repeats 1 Free-form summary of the trigger event and important details. |
lead_type | string(50), repeats 1 The type of trigger event being reported on. Possible values: SBA Funding;Relocation/Construction/Expansion;Venture Capital Funding/IPO;Federal Contract Award |
publication_date | date, repeats 1 The date Iridium reported on the event. |
project_due_date | date, repeats 1 The expected timetable for the trigger event. |
project_size | uint32, repeats 1 The square footage associated with the trigger event, if applicable. |
project_value | uint64, repeats 1 The dollar amount associated with the trigger event. |
lead_street | string(255), repeats 1 The project location's street address. |
lead_city | string(50), repeats 1 The project location's city name. |
lead_state | string(50), repeats 1 The project location's state or province name. |
lead_zip | string(15), repeats 1 The project location's zip or postal code name. |
lead_county | string(50), repeats 1 The project location's county name. |
lead_country | string(20), repeats 1 The project location's country name. Possible values: Sheet: Country Codes |
lead_msa | string(4), repeats 1 The project location's 4-digit MSA code. |
lead_msa_name | string(100), repeats 1 The project location's MSA name. |
company_name | string(255), repeats 1 The company's name. |
company_street | string(255), repeats 1 The company headquarters street address. |
company_city | string(50), repeats 1 The company headquarters city name. |
company_county | string(50), repeats 1 The company headquarters county name. |
company_state | string(50), repeats 1 The company headquarters state or province name. |
company_zip | string(15), repeats 1 The company headquarters zip or postal code. |
company_country | string(20), repeats 1 The company headquarters country name. Possible values: Sheet: Country Codes |
company_msa | string(4), repeats 1 The company headquarters 4-digit MSA code. |
company_msa_name | string(100), repeats 1 The company headquarters MSA name. |
phone | string(50), repeats 1 Main company phone number. |
fax | string(50), repeats 1 Main company fax number. |
url | string(255), repeats 1 Main company web address. |
company_size | uint32, repeats 1 Company employee count. |
annual_sales | uint64, repeats 1 Company's annual revenue. |
sic | string(4), repeats 1 4-digit SIC code. |
sic_description | string(100), repeats 1 SIC description. |
gsa | bool, repeats 1 Whether the project is a federal government contract. Possible values: 0 or 1 |
Data Exchange Response Delivery
D&B Direct specific fields are returned in D&B Data Exchange service responses via the HTTP Header. D&B Direct error information will be returned in case of the following scenarios – Failure to connect to Partner; Authentication / entitlement failure for the user -- and the Partner response will not be returned.
ApplicationTransactionID: <ID passed in request> DNB-ServiceTransactionID: <ID assigned by the Service> DNB-ResultID: <PCM Result Code> DNB-ResultText: <PCM Result Text> DNB-PortfolioAssetID: <Portfolio Asset ID> [BODY] <Partner Response (JSON/XML/SOAP)>
HTTP/1.1 200 OK ApplicationTransactionID: ID_001 CustomerBillingEndorsementText: Order placed by Joe for abbot.com CustomerReferenceText: Order placed by Joe Date: Tue, 12 Nov 2013 15:54:00 GMT DNB-PortfolioAssetID: 36590291 DNB-ResultID: CM000 DNB-ResultText: success DNB-ServiceTransactionID: Id-4d7cd8c752824f1822fb470b {"domain":"abbott.com","country_code":"US","datestamp":20130303,"company_name":"Abbott Laboratories","duns":"001307602","url":"http://www.abbott.com/","view":"basic"}
Response Codes & Error Handling
Responses from this Data Exchange feature will return a D&B response code, along with a partner response code, unless the partner service is not accessible at the time of the request.
Successful service requests will return a CM000 response code in the DNB-ResultID header field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM004, SC001-SC009.
NOTE: When a CM004 response code is received, the HTTP status code will be the value returned by the Data Exchange partner.
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 code CM000 is considered successful. A built-in feature exists to prevent duplicate billing when multiple successful feature requests with the same D-U-N-S Number are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
Feature Notes
This D&B Data Exchange feature will pass-thru the partner HTTP status code whenever a CM004 error is delivered in the DNB-ResultID header field. The following are the possible values from this partner.
- 404: no matches found
- 500: unsuccessful