D&B Total Loss Predictor

Total Loss Predictor (TLP) identifies and quickly assesses companies that have a high risk of defaulting on their very first payment, which could be for a number of reasons, including an inability, unwillingness, or intent not to pay.

See the Predictive Analytics page for more information on Dun & Bradstreet's risk scores.

Product Request

IMPORTANT: Due to a known issue, please do not include request values for SubmittingOfficeID.

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

Overview

When requesting this feature, a valid D&B D-U-N-S Number for a company and the appropriate product code will be required. For improved performance, include a country code of "US".

A trade up option exists to request data for a headquarters location when the requested organization is a branch.

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 product is entitled as "D&B Total Loss Predictor" 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.

Specification

GET https://direct.dnb.com/V5.0/organizations/804735132/products/TLP
Authorization: <My Token>

Endpoint

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

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.

Testing

Product Response

While data for a particular company may not contain values for each of the business elements, there may be items that are considered by D&B to be "essential" to yield the maximum benefit of a data layer. If any of these essential elements do not contain a value for a particular company, a PD005 response code will be returned, and your organization will not incur a usage credit for the request.

For all codified data delivered by D&B Direct, the response package will include the decoded text value as a data element with the code value attached as an attribute. Refer to the Reference Data Service for access to the D&B standard code tables.

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.

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

{"OrderProductResponse": {
  "@ServiceVersionNumber": "5.0",
  "TransactionDetail":   {
    "ServiceTransactionID": "Id-c8f4206f52d58b6610cb1240-2",
    "TransactionTimestamp": "2014-01-14T14:09:27.430-05:00"
  },
  "TransactionResult":   {
    "SeverityText": "Information",
    "ResultID": "CM000",
    "ResultText": "Success"
  },
  "OrderProductResponseDetail":   {
    "InquiryDetail":     {
      "DUNSNumber": "804735132",
      "CountryISOAlpha2Code": "US"
    },
    "Product":     {
      "DNBProductID": "TLP",
      "Organization":       {
        "SubjectHeader": {"DUNSNumber": "804735132"},
        "Telecommunication": {"TelephoneNumber": [        {
          "TelecommunicationNumber": "(650) 555-0000",
          "InternationalDialingCode": "1"
        }]},
        "Location": {"PrimaryAddress": [        {
          "StreetAddressLine": [{"LineText": "492 Koller St"}],
          "PrimaryTownName": "San Francisco",
          "CountryISOAlpha2Code": "US",
          "TerritoryAbbreviatedName": "CA",
          "PostalCode": "94110",
          "TerritoryOfficialName": "California"
        }]},
        "OrganizationName": {"OrganizationPrimaryName": [{"OrganizationName": {"$": "Gorman Manufacturing Company, Inc."}}]},
        "OrganizationDetail": {"FamilyTreeMemberRole":         [
          {"FamilyTreeMemberRoleText":           {
            "@DNBCodeValue": 12775,
            "$": "Global Ultimate"
          }},
          {"FamilyTreeMemberRoleText":           {
            "@DNBCodeValue": 12773,
            "$": "Parent"
          }},
          {"FamilyTreeMemberRoleText":           {
            "@DNBCodeValue": 12774,
            "$": "Domestic Ultimate"
          }}
        ]},
        "Assessment": {"TotalLossPredictorScore":         {
          "ScoreTimestamp": "2014-01-14T14:09:27.316-05:00",
          "RawScore": 2449,
          "ClassScore": "07",
          "RiskIncidencePercentage": 5.1,
          "ScoreCommentary":           [
                        {
              "CommentaryText":               {
                "@DNBCodeValue": 26209,
                "$": "Proportion of recent past due balances reported"
              },
              "DisplaySequence": 1
            },
                        {
              "CommentaryText":               {
                "@DNBCodeValue": 26205,
                "$": "Some firmographic data differs from available external data sources"
              },
              "DisplaySequence": 2
            },
                        {
              "CommentaryText":               {
                "@DNBCodeValue": 26092,
                "$": "Evidence of Negative trade"
              },
              "DisplaySequence": 3
            },
                        {
              "CommentaryText":               {
                "@DNBCodeValue": 26204,
                "$": "Reported high credit amount"
              },
              "DisplaySequence": 4
            }
          ]
        }}
      }
    }
  }
}}

Legend: [C] = may be included in a Custom Data product; [M] = may be referenced by the Monitoring process; [M+] = Monitored using an aggregate or attribute XPath.

Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered in the response and should be anticipated in any implementation.

Empty/NULL Values

A NULL returned for an element indicates that the information was not provided to D&B when the related data items were collected. The absence of a value for a particular item should not be considered indicative of any implied value (e.g., NULL for a boolean indicator is NOT the same as a value of 'false').

Currency Codes/Units

Whenever financial statement data is included in a response, each individual business element (ItemAmount) should be inspected for currency code and unit values (CurrencyISOAlpha3Code and UnitOfSize). If a given element does not include these attributes, the values provided in the statement header should be utilized.

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-CM005, CM007-CM012, CM014, CM017, CM018, PD001, PD003, PD005, PD006, PD015, PD016,PD019 and SC001-SC012.

IMPORTANT: PD006 code - Applicable only for US/CA cases when TradeUpIndicator="true" for Risk packets.

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 D-U-N-S Number and product code are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).

Retrieving Archived Copies

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.

This product will also return a set of standard elements (e.g. D-U-N-S Number, Organization Name, Trade Styles, Family Tree Role, Primary Address, Mailing Address, Telephone Number, Fax Number, etc.) in addition to the business elements listed.

The preceding list is not presented in the order, nor manner, in which the information is packaged and delivered via the D&B Direct API. Legend: [C] = may be included in a Custom Data product; [M] = may be referenced by the Monitoring process; [M+] = Monitored using an aggregate or attribute XPath.

Standard Elements

Product Notes

• © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.