Get Marketing Information by D-U-N-S Number

Get marketing information about a company (credit rating, PAYDEX score, demographic information, ...) based on the company's D-U-N-S number. In order to get the marketing information each request requires a reason.

Request Url: https://api.datamill.solutions/business-data/duns/rating
Request Method: POST

Table of Contents

Request Parameters

The API uses the POST request method to send data in the HTTP message body to avoid data being stored in the cache of the web server. A request is valid if all parameters are provided as described below (data type, minimum and maximum length). Please note that all data must be UTF-8 and URL encoded.

POST /business-data/duns/rating HTTP/1.1
Host: https://api.datamill.solutions

name1=value1&name2=value2
Parameter Mandatory Data Type Min. Max. Description
license required string 29 29 Your license key used for authentication - keep this key secret!
guid required string 30 40 Your GUID used for authentication - keep this key secret!
duns_number required string 9 9 D-U-N-S number representing the company you like to get detailed information about.
reason_code required integer 1 8 Unique code describing the reason why you like to get detailed information about the specified company. Possible codes are:
  • 1: Credit decisions
  • 2: Credit check (intended business connection)
  • 3: Credit check (ongoing business connection)
  • 4: Debt collections
  • 5: Commercial credit insurance
  • 6: Insurance contract
  • 7: Leasing agreement
  • 8: Rental agreement

Response

The API returns all data in valid JSON. A few programming languages include native support for JSON. For those that don't, you can find a suitable library at http://www.json.org. Valid requests always returns all response keys listed below. Depending on the request parameters some response keys may be empty.

HTTP/1.1 200 OK

Server: Apache
Content-Type: application/json; charset=UTF-8
Date: Fri, 18 Oct 2019 11:53:35 GMT
Content-Length: 33
Access-Control-Allow-Origin: *

{"key1":"value1","key2":"value2"}
Name Data Type Description
status string Flag if a company was found by its D-U-N-S number or not [0,1]
status_description string Describes if a company was found or if the specified D-U-N-S number could not be resolved.
  • company not found
  • company found
  • invalid duns number
enquiry_duns string The D-U-N-S number of the enquiry. May vary from the specified D-U-N-S number if the headquarters data are returned
company_name string The company's official name
continent_name string Continent name of the company's headquarters
country_name string Country name together with the language information
country_code string ISO 3166-1 alpha-2 country code of the company's headquarters
country_code_3 string ISO 3166-1 alpha-3 country code of the company's headquarters
zip string Postal code of the company's headquarters
city string City of the company's headquarters
street string Street name of the company's headquarters
house_number string House number of the company's headquarters
state_name string State name of the company's headquarters
phone_number string Phone number of the company's headquarters
fax_number string Fax number of the company's headquarters
ceo_name string Name of the company's CEO (Chief Executive Officer)
ceo_title string Position / Business title of the company's CEO
year_started string Year of establishment
incorporation_year string Year business incorporated
is_branch boolean Flag if the company found is a branch or the main headquarter
sic_code string The company's international SIC (Standard Industrial Classification) code
sic_description string Description of the SIC code
sic_version string The version of SIC (either 1972, 1977 or 1987)
net_worth integer The company's net worth (net value) in its local currency (may be NULL if unset)
currency_code string The local currency code of the company's headquarters country
currency_name string The local currency name of the company's headquarters country
total_employees integer The total number of employees (may be NULL if unset)
total_employees_indicator string Indicator if subsidiaries are included or not
  • A: subsidiaries are not included
  • B: total value including subsidiaries
total_employees_indicator_description string Description of the total number of employees indicator
are_employees_estimated boolean Flag if the total number of employees is estimated or actual
legal_form_code string Code of the company's legal form
legal_form_description string Description of the legal form code
business_registration_number string Primary business identification number assigned to the business by government agency
business_registration_type string Type of identification number assigned to the business (e.g. Registration number, Judicial number, ...)
sales integer Net sales for the period after returns, allowances and discounts are deducted (may be NULL if unset)
sales_estimated_description string Qualifies the annual sales volume (actual, estimated, forecast, projected or calculated)
are_sales_estimated boolean Flag if the annual sales volume is estimated or actual
paydex_score integer D&B® PAYDEX® for the last 2 months experiences (not for all countries) (may be NULL if unset)
paydex_score_description string Description about the D&B® PAYDEX® score (either Anticipate, Discount, Prompt, X days beyond terms or Unavailable) (may be NULL if unset)
paydex_norm integer Industry D&B® PAYDEX® median or average (may be NULL if unset)
dub_rating string Rating assigned by Dun & Bradstreet (meaning varies by country)
dub_rating_financial_strength string Part of the Dun & Bradstreet rating which indicates the financial strength of the business (from - to in USD)
dub_rating_risk string Part of the Dun & Bradstreet rating which indicates the risk of a potential business cooperation
  • 1: minimal risk
  • 2: low risk
  • 3: greater than average risk
  • 4: significant level of risk
  • <other values>: insufficient information to define a risk indicator
dub_rating_risk_description string Part of the Dun & Bradstreet rating which indicates the risk of a potential business cooperation
  • 1: proceed with transaction - offer terms required
  • 2: proceed with transaction
  • 3: process with transaction, but monitor closely
  • 4: take suitable assurances before extending credit
  • <other values>: no public information or D&B proprietary information
has_disaster_event boolean Flag if special events concerning disasters such as fire, hurricanes etc. exists
has_financial_embarrassment boolean Flag if open bankruptcy, receivership liquidation or equivalent exists
has_financial_legal_event boolean Flag if special events available including financial embarrassment and legal fillings exists
has_special_event boolean Flag if special events are available concerning changes to operational aspects including name changes, management changes, etc.
has_other_event boolean Flag if special events exists that are not otherwise specified
has_secured_filings boolean Flag if open secured filing such as UCC filings, secured charges or equivalent exists
has_lawsuit boolean Flag if open suit(s), judgement(s), petitions or payment remarks exists
trade_styles array Collection of trade styles used by business listed in priority order
intangible_assets integer Total of intangible assets (may be NULL if unset)
max_credit_recommendation integer Maximum amount of credit recommended by Dun & Bradstreet (Europe only) (may be NULL if unset)
has_open_claims boolean Flag if open claims, legal claims, liens, protested bills or equivalent exists
has_criminal_proceedings boolean Flag if criminal proceedings exists
report_date string Timestamp when the company's information were updated the last time
is_out_of_business boolean Flag if the company is already out of business

Response Errors

If the request fails the API returns a HTTP status code according to the reason. A reason may be a missing mandatory request parameter, invalid parameter credentials (minimum/maximum length) or invalid API keys. The response body is a valid JSON containing detail information about the reason (except for status code 500).

HTTP/1.1 404 Not Found

Server: Apache
Content-Type: application/json; charset=UTF-8
Date: Fri, 18 Oct 2019 11:53:35 GMT
Content-Length: 71
Access-Control-Allow-Origin: *

{"errorcode":404,"errormessage":"transformation function name invalid"}
HTTP Status Code Reason
401 Unauthorized
The license key and/or GUID key is missing, invalid or inactive.
402 Payment Required
Your /data.mill credit quota is exceeded. You need to get more credits.
403 Forbidden
You need to accept all required agreements of this function to be able to use it.
404 Not Found
The request path in combination with the request method does not exist.
405 Method Not Allowed
The request method is not allowed for the requested path.
412 Precondition Failed
At least one of the given request parameter has invalid credentials (e.g. data type, length).
428 Precondition Required
At least one of the mandatory request parameter is missing or has an empty value.
500 Internal Server Error
An unexpected condition terminated the request.
503 Service Unavailable
The service is currently in maintenance mode and will be alive later.

Batch Mode

The batch mode allows the execution of thousands of records (limited to 5,000) combined in a single request. This API endpoint as described above uses the single mode execution of records. To use the batch mode you need to combine all request parameters above (excluding license and guid) as array, where each array element represents a single record. This array is converted to a valid JSON string and set as value of the new request parameter called batch. The response of the batch mode is a valid JSON which contains the result for each record set in the request. The response keys of each result element are the same as for the single request mode described above.

Batch Request

license=...
&guid=...
&batch=[{"duns_number":"...","reason_code":"..."},{"duns_number":"...","reason_code":"..."}]

Batch Response

[{"status":"...","status_description":"...","enquiry_duns":"...","company_name":"...","continent_name":"...","country_name":"...","country_code":"...","country_code_3":"...","zip":"...","city":"...","street":"...","house_number":"...","state_name":"...","phone_number":"...","fax_number":"...","ceo_name":"...","ceo_title":"...","year_started":"...","incorporation_year":"...","is_branch":"...","sic_code":"...","sic_description":"...","sic_version":"...","net_worth":"...","currency_code":"...","currency_name":"...","total_employees":"...","total_employees_indicator":"...","total_employees_indicator_description":"...","are_employees_estimated":"...","legal_form_code":"...","legal_form_description":"...","business_registration_number":"...","business_registration_type":"...","sales":"...","sales_estimated_description":"...","are_sales_estimated":"...","paydex_score":"...","paydex_score_description":"...","paydex_norm":"...","dub_rating":"...","dub_rating_financial_strength":"...","dub_rating_risk":"...","dub_rating_risk_description":"...","has_disaster_event":"...","has_financial_embarrassment":"...","has_financial_legal_event":"...","has_special_event":"...","has_other_event":"...","has_secured_filings":"...","has_lawsuit":"...","trade_styles":[],"intangible_assets":"...","max_credit_recommendation":"...","has_open_claims":"...","has_criminal_proceedings":"...","report_date":"...","is_out_of_business":"..."},{"status":"...","status_description":"...","enquiry_duns":"...","company_name":"...","continent_name":"...","country_name":"...","country_code":"...","country_code_3":"...","zip":"...","city":"...","street":"...","house_number":"...","state_name":"...","phone_number":"...","fax_number":"...","ceo_name":"...","ceo_title":"...","year_started":"...","incorporation_year":"...","is_branch":"...","sic_code":"...","sic_description":"...","sic_version":"...","net_worth":"...","currency_code":"...","currency_name":"...","total_employees":"...","total_employees_indicator":"...","total_employees_indicator_description":"...","are_employees_estimated":"...","legal_form_code":"...","legal_form_description":"...","business_registration_number":"...","business_registration_type":"...","sales":"...","sales_estimated_description":"...","are_sales_estimated":"...","paydex_score":"...","paydex_score_description":"...","paydex_norm":"...","dub_rating":"...","dub_rating_financial_strength":"...","dub_rating_risk":"...","dub_rating_risk_description":"...","has_disaster_event":"...","has_financial_embarrassment":"...","has_financial_legal_event":"...","has_special_event":"...","has_other_event":"...","has_secured_filings":"...","has_lawsuit":"...","trade_styles":[],"intangible_assets":"...","max_credit_recommendation":"...","has_open_claims":"...","has_criminal_proceedings":"...","report_date":"...","is_out_of_business":"..."}]

Pricing

In order to enable the payment of different currencies, we have introduced a system based on credit balance as payment for the individual functions. The currency of the account is called /data.mill credits. To use the functions, the account must be charged in advance. If the credit price of a function is higher than the current balance, the function can not be executed. The credits will be deducted from your balance after executing the function. Your credits have no expiration date.

This functions costs 0 /data.mill credits for each record set in the request.
1 record (single mode): 0
2 records (batch mode): 0
3 records (batch mode): 0

Code Snippets

We provide some code snippets for multiple programming languages to easily implement this function in your own application. The code snippets below uses the single request mode. If you want to use the batch mode instead of the single mode you need to modify the snippet. Feel free to copy the code snippets for your preferred programming language.

// the following code requires cURL php extension installed on your server (http://php.net/manual/en/book.curl.php) // initialize a new cURL session and store the cURL handler object $curl = curl_init(); // set the url to which the request will be sent curl_setopt($curl, CURLOPT_URL, "https://api.datamill.solutions/business-data/duns/rating"); // set the HTTP method to use for the request curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST"); // set the number of parameters to be sent to the server curl_setopt($curl, CURLOPT_POST, 4); // data to be sent to the server // TODO: append your API keys and value(s) and don't forget to urlencode() them curl_setopt($curl, CURLOPT_POSTFIELDS, "license=&guid=&duns_number=&reason_code="); // set a timeout in seconds for the request curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10); curl_setopt($curl, CURLOPT_TIMEOUT, 10); // return the raw data from the server curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); // execute the previously created cURL session $responseString = curl_exec($curl); // close the cURL session after execution curl_close($curl); // convert the response (string) to an array $responseArray = json_decode($responseString, true); // TODO: process the data in the response array (you may process the data in the response string too)
/* Note: We highly recommend to NOT use this code as it is written here. If you choose JavaScript as your preferred programming language, please change the following code to request your own server (without API keys) and further redirect the request from your own server to the API including your API keys. Otherwise everyone will be able to read your API keys and use them for their own purpose! */ // the following code requires jQuery JavaScript library (minimum version 1.8.1) added to your website (http://jquery.com/download/) // perform an asynchronous HTTP (Ajax) request jQuery.ajax({
// set the url to which the request is sent url : "https://api.datamill.solutions/business-data/duns/rating", // set the HTTP method to use for the request type: "POST", // data to be sent to the server (you may use a JavaScript object instead of a string) // TODO: append your API keys and value(s) and don't forget to urlencode() them data : "license=&guid=&duns_number=&reason_code=", // type of data that we are expecting back from the server dataType: "JSON", // set a timeout in milliseconds for the request timeout: 10000, // function to be called if the request succeeds success:function(data, textStatus, jqXHR) {
// {object} data The data returned from the server, formatted according to the dataType parameter. // {string} textStatus String describing the status. // {object} jqXHR A XMLHttpRequest object describing the response. // TODO: process the data in the 'data' JavaScript object
}, // function to be called if the request fails error: function(jqXHR, textStatus, errorThrown) {
// {object} jqXHR A XMLHttpRequest object describing the response. // {string} textStatus String describing the type of error occurred. // {string} errorThrown Text portion of the HTTP status, such as "Not Found" or "Internal Server Error". // TODO: process the error occurred
}
});
// the following code uses standard libraries included in Microsoft Visual Studio 2013 or higher using System.IO; using System.Web; using System.Net;
// create an array of bytes representing the data to be sent to the server // TODO: append your API keys and value(s) and don't forget to urlencode() them byte[] Data = Encoding.ASCII.GetBytes("license=&guid=&duns_number=&reason_code="); // create a new web request resource and set the url to which the request is sent HttpWebRequest Request = (HttpWebRequest)WebRequest.Create("https://api.datamill.solutions/business-data/duns/rating"); // set the HTTP method to use for the request Request.Method = "POST"; // set the request content type Request.ContentType = "application/x-www-form-urlencoded"; // set the number of bytes being sent to the server Request.ContentLength = Data.Length; // set a timeout in milliseconds for the request Request.Timeout = 10000; // try to send all data to the newly created web request resource try {
using(var Stream = Request.GetRequestStream()) {
Stream.Write(Data, 0, Data.Length);
}
} catch (Exception ex) {
// TODO: process the exception thrown (e.g. url not found) return;
} // try to read the response from the web resource try {
HttpWebResponse ResponseObject = (HttpWebResponse)Request.GetResponse(); StreamReader Reader = new StreamReader(ResponseObject.GetResponseStream()); // read the whole response as string and store it String ResponseMessage = System.Net.WebUtility.HtmlDecode(Reader.ReadToEnd()); // TODO: process the data in 'ResponseMessage'
} catch (WebException ex) {
// error occurred, http status code != 200 (e.g. timeout or parameter invalid) if(ex.Status == WebExceptionStatus.Timeout) {
// TODO: process the timeout reached
} else {
// read the response from the web exception HttpWebResponse ResponseObject = (HttpWebResponse)ex.Response; StreamReader Reader = new StreamReader(ResponseObject.GetResponseStream()); // read the whole response as string and store it String ResponseMessage = System.Net.WebUtility.HtmlDecode(Reader.ReadToEnd()); // TODO: process the error response received from the server (stored in 'ResponseMessage')
}
}
// the following code requires at least Android API version 10 // import standard Java and Android libraries import java.util.List; import org.apache.http.NameValuePair; import java.util.ArrayList; import org.apache.http.message.BasicNameValuePair; import java.net.URLDecoder; import org.apache.http.client.methods.HttpPost; import org.apache.http.client.entity.UrlEncodedFormEntity; import org.apache.http.client.HttpClient; import org.apache.http.impl.client.DefaultHttpClient;
// create a list of key-value-pairs to store the data which will be sent to the server List<NameValuePair> dataPairs = new ArrayList<NameValuePair>(); // add each parameter to the key-value-pair list (value is decoded to UTF-8 standard) // TODO: append your API keys and value(s) dataPairs.add(new BasicNameValuePair("license", URLDecoder.decode("enter value here", "UTF-8"))); dataPairs.add(new BasicNameValuePair("guid", URLDecoder.decode("enter value here", "UTF-8"))); dataPairs.add(new BasicNameValuePair("duns_number", URLDecoder.decode("enter value here", "UTF-8"))); dataPairs.add(new BasicNameValuePair("reason_code", URLDecoder.decode("enter value here", "UTF-8"))); // create the web resource with pre-defined POST method and set the url to which the request is sent HttpPost request = new HttpPost("https://api.datamill.solutions/business-data/duns/rating"); // append the parameters to the web resource request.setEntity(new UrlEncodedFormEntity(dataPairs)); try {
// execute the request and read the response string HttpClient client = new DefaultHttpClient(); String response = client.execute(request); // TODO: process the data in 'response'
} catch (IOException ex) {
// TODO: process the exception thrown
}

Need help?

If you have any questions about the implementation of this API or found an error please don't hesitate to contact our support team.