Loading

Direct 2.0
Collapse

Place Investigation (GET)

ProductsD&B Direct 2.0, D&B Direct for Onboard
Product Code(s)Not Applicable
Options(s)D-U-N-S Number, Company Name
Monitoring AvailableNo
InterfaceREST
Method(s)GET & POST
Format(s)JSON
ServiceInvestigation
{version}2.1
Initial ReleaseOctober 3, 2013

D&B Direct provides a service for requesting investigations in order to obtain the most recent information on a business. Successful investigations result in the creation (for companies not in the D&B database) or revision (for existing companies) of a D&B Business Information Report (BIR).

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

An investigation is appropriate under the following conditions: when the In Date status for a data or report product is Investigation Recommended or Out of Date; when a company search fails to return a suitable match; or when the most up-to-date information is required.

Investigations may be initiated either by providing the D-U-N-S Number of an organization or by providing its name and address. If both a D-U-N-S Number and name/address are submitted, an investigation will be performed based on the D-U-N-S Number

Optional telephone number and organization identification number (e.g. FEIN) parameters are available to provide additional information; however, these fields are not sufficient to initiate an investigation by themselves.

An option exists to request a "priority" investigation, which will typically be completed in less time than a regular investigation. Investigations requested using the priority setting will incur an additional charge, and are dependent on the accessibility of information for the organization being requested (which may be impacted by the responsiveness of the organization).

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 "Investigations" 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

The details in this section override the Optional/Required values listed in the specification table.

1. When submitting a request by D-U-N-S Number, a valid D-U-N-S Number is Required.

2. When submitting a request by Organization Name and Address, an Organization Name (or partial name) and a valid Country Code are Required.

Any additional details that are available should be included to assist the D&B Analyst.

Sample Request (by D-U-N-S Number)
GET https://direct.dnb.com/V2.1/organizations/081466849?CountryISOAlpha2Code=US&CustomerBillingEndorsementText=Sandbox%20testing%20for%20name%20and%20address%20investigation&RequestorName=John&RemarksText=Payment%20data%20is%20missing%20in%20the%20BIR%20report%20for%20this%20company.%20Please%20investigate.&CustomerReferenceText=Sandbox%20testing%20for%20name%20and%20address%20investigation&DNBProductID=BIR&investigate=true&RequesterEmailAddress=john%40mycompany.com&PriorityCode=6344
Authorization: <MyToken>
Sample Request (by Company Name)
GET http://services-ext-stg.dnb.com/V2.1/organizations/name-Gorman?TerritoryName=CA&CountryISOAlpha2Code=US&StreetAddressLine-1=492%20KOLLER%20STREET&PrimaryTownName=San%20Francisco&CustomerBillingEndorsementText=Sandbox%20testing%20for%20name%20and%20address%20investigation&RequestorName=John&CustomerReferenceText=Sandbox%20testing%20for%20name%20and%20address%20investigation&DNBProductID=BIR&investigate=true&PriorityCode=6347
Authorization: <MyToken>

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.

This operation is also available as a POST call.

Name Characteristics
{version} Element
ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

TransactionTimestamp DateTimestamp, Optional

The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

SubmittingOfficeID string up to 64 chars., Optional

A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated.

{DUNS} string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

{name} string up to 240 chars., Optional

Records the name of the inquired organization.

StreetAddressLine-n string up to 240 chars., Optional

Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name.

PrimaryTownName string up to 64 chars., Required (US), Optional (other countries)

The name of the town or city recognized by the Postal Authority for delivering mail.

CountryISOAlpha2Code string at least 2 chars. up to 2 chars., 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.

TerritoryName string up to 64 chars., Required (US & CA), Optional (other countries)

The name of a locally governed area which forms part of a centrally governed nation. As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State in the UK this would be one of the Home Nations.

FullPostalCode string up to 32 chars., Optional

An identifier used by the local country Postal Authority to identify a particular geographic location and may include the identification of a street or building. When this data has been derived by concatenating the elements Postal Code and Postal Code Extension, a separator will be inserted between these two elements based on country rules. For example, when the address is a U.S. address, the separator that will be used is a hyphen '-'.

CountyName string up to 64 chars., Optional

The name of a primary administrative division within a Territory or Country. As a guiding principle this is a geographic area which would be classified as a Province (except Canada) or a County. In the U.S. this would be a county within a State. In the UK this would be a county in one of the Home Nations. In Republic Of Ireland, this would be a county and there would be no Territory.

TelephoneNumber string at least 1 chars. up to 50 chars., Optional

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

OrganizationIdentificationNumber string at least 1 chars. up to 40 chars., Optional

A number issued by an external official registry body, a government entity or a commercial enterprise to uniquely identify an organization.

OrganizationIdentificationNumberTypeCode integer up to 7 digits., Optional

A D&B code value which denotes the type of Organization Identification Number, e.g., Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number.

DNBProductID string up to 64 chars., Required

An alphanumeric string that uniquely identifies the product being requested.

Possible values: BIR

LanguagePreferenceCode integer up to 7 digits., Optional

A D&B code value that defines the language in which the customer wants this product to be rendered.

CharacterSetPreferenceCode integer up to 7 digits., Optional

A D&B code value denoting the set of graphic symbols (e.g., alphabet letter, pictograph) in which the product is to be rendered, e.g., Unicode.

ProductFormatPreferenceCode integer up to 7 digits., Optional

A D&B code value that describes the defined structure in which the product is to be rendered, e.g., txt, xml, pdf.

OrderReasonCode integer up to 7 digits., Optional

A D&B code value that defines the grounds for the customer requesting the product, e.g., required to support a credit decision.

PriorityCode integer up to 7 digits., Optional

A D&B code value representing the urgency of the investigation, e.g., Regular 3 Days, Priority 1 Way - 2 Days. PDQ 2 Way - 1 Day.

Possible values: 6344 - Priority; 6347 - Routine

RemarksText string up to 3000 chars., Optional

Free form text for the customer to enter any special remarks for this investigation request.

NOTE: For the US and CA, 3000 characters are supported. For GB, IE, IT, SM, BE, LU, NL, DE, PT, ES, AD, AT, CH, LI, HU, PL, CZ, SK, DK, FI, NO, SE, GL, FO, FR, MC, MQ, RE, GP, GF, 255 characters are supported. For the remaining countries, 280 characters are supported. Refer to the ISO Country Codes list.

SubjectContactFirstName string up to 64 chars., Optional

The given name of the individual. If this is not known then an initial may be supplied.

SubjectContactLastName string up to 64 chars., Optional

The portion of the individual's name usually presented at the end used to identify the members of a family.

SubjectContactTelephoneNumber string at least 1 chars. up to 50 chars., Optional

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

RequestorName string up to 64 chars., Optional

Text recording the name of the Customer/User who has placed this request.

RequesterStreetAddressLine-n string up to 240 chars., Optional

Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name.

RequesterPrimaryTownName string up to 64 chars., Optional

The name of the town or city recognized by the Postal Authority for delivering mail.

RequesterCountryISOAlpha2Code string at least 2 chars. up to 2 chars., 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.

RequesterTerritoryName string up to 64 chars., Optional

The name of a locally governed area which forms part of a centrally governed nation. As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State in the UK this would be one of the Home Nations.

RequesterFullPostalCode string up to 32 chars., Optional

An identifier used by the local country Postal Authority to identify a particular geographic location and may include the identification of a street or building. When this data has been derived by concatenating the elements Postal Code and Postal Code Extension, a separator will be inserted between these two elements based on country rules. For example, when the address is a U.S. address, the separator that will be used is a hyphen '-'.

RequesterCountyName string up to 64 chars., Optional

The name of a primary administrative division within a Territory or Country. As a guiding principle this is a geographic area which would be classified as a Province (except Canada) or a County. In the U.S. this would be a county within a State. In the UK this would be a county in one of the Home Nations. In Republic Of Ireland, this would be a county and there would be no Territory.

RequesterTelephoneNumber string at least 1 chars. up to 50 chars., Optional

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

RequesterEmailAddress string up to 240 chars., Optional

Text recording the electronic mail address used by a subject by which the subject can transmit and or receive text messages, links, and files electronically, typically via a network, like the Internet.

DeliveryMethodCode integer up to 7 digits, Required

A D&B code value denoting the type of medium being supplied for sending the product(s)/service(s).

Possible values: 7795 - Email

DeliveryEmailAddress-n string up to 240 chars., Optional

Text recording the electronic mail address used by a subject by which the subject can transmit and or receive text messages, links, and files electronically, typically via a network, like the Internet.

NotificationMethodCode integer up to 7 digits, Required

A D&B code value denoting the type of medium by which the Customer/User should be notified.

Possible values: 7795 - Email

NotificationEmailAddress-n string up to 240 chars., Optional

Text recording the electronic mail address used by a subject by which the subject can transmit and or receive text messages, links, and files electronically, typically via a network, like the Internet.

ArchiveProductOptOutIndicator boolean, Optional

When true (set to 1), it indicates that the product being ordered is not to be stored. When false (set to 0), it indicates that the product being ordered is to be stored; however as this is the assumed condition there is no requirement to create this tag to represent this fact.

ExtendArchivePeriodIndicator boolean, Optional

When true (set to 1), the duration to archive the data is to be extended. Note: There is an additional cost for extending the archival period of the data purchased. When false (set to 0), the duration to archive the data is not to be extended.

PortfolioAssetContainerID long, Optional
CustomerReferenceText-n string up to 240 chars., 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.

NOTE: Due to known limitation, only 100 characters are supported. Same will be increased to 240 (Up to 5x) chars in future.

CustomerBillingEndorsementText string at least 1 chars. up to 64 chars., 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.

NOTE: Due to known limitation, only 100 characters are supported. Same will be increased to 240 chars in future.

Endpoint

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

Endpoint (Investigation)
GET|POST https://direct.dnb.com/V{version}/organizations/{DUNS}?investigate=true
GET|POST https://direct.dnb.com/V{version}/organizations/name-{name}?investigate=true

Testing

This operation is currently unavailable in the D&B Direct sandbox (test) environment.

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.

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

Sample Response (by D-U-N-S Number)
{"PlaceInvestigationResponse": {
   "@ServiceVersionNumber": "2.0",
   "TransactionDetail":    {
      "ApplicationTransactionID": null,
      "ServiceTransactionID": "Id-5e83d5fd5256cced0bab742e-2",
      "TransactionTimestamp": "2013-10-10T11:51:11.738-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "PlaceInvestigationResponseDetail":    {
      "InquiryDetail":       {
         "DUNSNumber": "081466849",
         "OrganizationName": "MICROSOFT CORPORATION",
         "Address":          {
            "StreetAddressLine": [{"LineText": null}],
            "PrimaryTownName": null,
            "CountryISOAlpha2Code": "US",
            "TerritoryName": null,
            "FullPostalCode": null
         }
      },
      "InvestigationTrackingID": "M24578512171A1003058QH0",
      "ArchiveDetail": {"PortfolioAssetID": 4595541},
      "InquiryReferenceDetail":       {
         "CustomerReferenceText": ["Sandbox testing for name and address investigation"],
         "CustomerBillingEndorsementText": "Sandbox testing for name and address investigation"
      }
   }
}}
Sample Response (by Company Name)
{"PlaceInvestigationResponse": {
   "@ServiceVersionNumber": "2.1",
   "TransactionDetail":    {
      "ApplicationTransactionID": null,
      "ServiceTransactionID": "Id-9e17a3065256ee2b162b742e-1",
      "TransactionTimestamp": "2013-10-10T14:13:02.212-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "PlaceInvestigationResponseDetail":    {
      "InquiryDetail":       {
         "DUNSNumber": null,
         "OrganizationName": "GORMAN",
         "Address":          {
            "StreetAddressLine": [{"LineText": "492 KOLLER STREET"}],
            "PrimaryTownName": "San Francisco",
            "CountryISOAlpha2Code": "US",
            "TerritoryName": "CA",
            "FullPostalCode": null
         }
      },
      "InvestigationTrackingID": "M24578512171A1003058S1L",
      "ArchiveDetail": {"PortfolioAssetID": 4595872},
      "InquiryReferenceDetail":       {
         "CustomerReferenceText": ["Sandbox testing for name and address investigation"],
         "CustomerBillingEndorsementText": "Sandbox testing for name and address investigation"
      }
   }
}}
Name Characteristics
PlaceInvestigationResponse Aggregate
PlaceInvestigationResponse@ServiceVersionNumber Attribute
PlaceInvestigationResponse { TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

PlaceInvestigationResponse { TransactionDetail { ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

PlaceInvestigationResponse { TransactionDetail { ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to uniquely identify this transaction.

PlaceInvestigationResponse { TransactionDetail { TransactionTimestamp DateTimestamp, Required

The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

END: PlaceInvestigationResponse } TransactionDetail /Aggregate
PlaceInvestigationResponse { TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

PlaceInvestigationResponse { TransactionResult { SeverityText string, Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

PlaceInvestigationResponse { TransactionResult { ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

PlaceInvestigationResponse { TransactionResult { ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

PlaceInvestigationResponse { TransactionResult { ResultMessage Aggregate, Optional (Array)

An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

PlaceInvestigationResponse { TransactionResult { ResultMessage { ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the transaction.

END: PlaceInvestigationResponse } TransactionResult } ResultMessage /Aggregate
END: PlaceInvestigationResponse } TransactionResult /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail Aggregate, Optional

Records the data being returned to the Customer/User when an investigation is placed successfully by a D&B investigation tracking system.This includes details of the Customer/User portfolio where this investigation placement request is archived and the investigation tracking id returned as a result.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail Aggregate, Required

Records data that allows the customer to specify identifying information about the subject being inquired, e.g., the DUNS Number, the address, the telephone number.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { DUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { OrganizationName string up to 240 chars., Optional

Records the name of the inquired organization.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address Aggregate, Required

Records the location information of the requested subject.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { StreetAddressLine Aggregate, Optional(Up to 10x)

An entry loop which can repeat multiple times to allow the recording of several lines where each address line contains one or more named address elements. Examples of named address elements are Street Name, Street Number, Building Name, Estate Name. They are called “lines” because an addres can be divided into multiple lines. When there are multiple lines the sequence of the lines must be preserved.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { StreetAddressLine { LineText string up to 240 chars., Required

Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name.

END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryDetail } Address } StreetAddressLine /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { PrimaryTownName string up to 64 chars., Optional

The name of the town or city recognized by the Postal Authority for delivering mail.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required

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.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { TerritoryName string up to 64 chars., Optional

The name of a locally governed area which forms part of a centrally governed nation. As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State in the UK this would be one of the Home Nations.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { FullPostalCode string up to 32 chars., Optional

An identifier used by the local country Postal Authority to identify a particular geographic location and may include the identification of a street or building. When this data has been derived by concatenating the elements Postal Code and Postal Code Extension, a separator will be inserted between these two elements based on country rules. For example, when the address is a U.S. address, the separator that will be used is a hyphen '-'.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { Address { CountyName string up to 64 chars., Optional

The name of a primary administrative division within a Territory or Country. As a guiding principle this is a geographic area which would be classified as a Province (except Canada) or a County. In the U.S. this would be a county within a State. In the UK this would be a county in one of the Home Nations. In Republic Of Ireland, this would be a county and there would be no Territory.

END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryDetail } Address /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { TelephoneNumber Aggregate, Optional

Records Telephone contact information used for voice communication with the inquired subject.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { TelephoneNumber { TelecommunicationNumber string at least 1 chars. up to 50 chars., Required

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { TelephoneNumber { InternationalDialingCode string up to 7 chars., Optional

The country calling code assigned by the International Telecommunication Union (ITU) required to connect to this Telecommunication Number of the subject country when dialing from outside the subject country; e.g., '1' for the US, '44' for the UK, '91' for India.

END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryDetail } TelephoneNumber /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { OrganizationIdentificationNumberDetail Aggregate, Optional

An entry loop which can repeat multiple times to allow the recording of several different identifiers issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise, e.g., Chamber of Commerce numbers, VAT numbers, etc.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { OrganizationIdentificationNumberDetail { OrganizationIdentificationNumber string at least 1 chars. up to 40 chars., Required

A number issued by an external official registry body, a government entity or a commercial enterprise to uniquely identify an organization.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryDetail { OrganizationIdentificationNumberDetail { OrganizationIdentificationNumberTypeCode integer up to 7 digits., Required

A D&B code value which denotes the type of Organization Identification Number, e.g., Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number.

END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryDetail } OrganizationIdentificationNumberDetail /Aggregate
END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryDetail /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InvestigationTrackingID string, Required

The number assigned by a D&B investigation tracking system which uniquely identifies this investigation request. This identifier can be used by the Customer/User to track the current status of this investigation request.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { ArchiveDetail Aggregate, Optional

Records data that allows the customer to specify details about the archival of the investigation placement in the actor’s portfolio .

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { ArchiveDetail { PortfolioAssetID PortfolioAssetIDType, Required

A number used to uniquely identify this product in the location where it is stored.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { ArchiveDetail { PortfolioAssetContainerID long, Optional

A number used to uniquely identify the location where this product is stored.

END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } ArchiveDetail /Aggregate
PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryReferenceDetail Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryReferenceDetail { CustomerReferenceText string up to 240 chars., 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.

PlaceInvestigationResponse { PlaceInvestigationResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., 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: PlaceInvestigationResponse } PlaceInvestigationResponseDetail } InquiryReferenceDetail /Aggregate
END: PlaceInvestigationResponse } PlaceInvestigationResponseDetail /Aggregate
END: PlaceInvestigationResponse /Aggregate

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, CM005, CM006, CM008, CM009, CM011, CM012, CM014, CP001, 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]).

Expected Response Times

A D&B Fulfillment Specialist will perform research on the organization and collect up-to-date information. The following table provides the expected number of days that a regular investigation will be completed for each country.

CountryExpected DaysCustomer Service Center
Abu Dhabi - UAE6D&B SAME
Admiralty Islands10Australia (Corre. Office)
Afghanistan6D&B North Africa
Ajman - UAE6D&B SAME
Alain6D&B SAME
Albania4Emerging Markets Center
Algeria6D&B North Africa
Andorra3Spain D&B
Angola6D&B North Africa
Anguilla10LABIC
Antarctica---Not reported on by D&B
Antigua & Barbuda10LABIC
Argentina7Argentina D&B
Armenia4Emerging Markets Center
Aruba10LABIC
Ascension Islands6D&B North Africa
Australia5Australia D&B
Austria3Austria D&B
Azerbaijan4Emerging Markets Center
Azores7Portugal (Corre. Office)
Bahamas10LABIC
Bahrain6D&B SAME
Bangladesh6D&B SAME
Barbados10LABIC
Belgium3Belgium D&B
Belize10LABIC
Belorussia4Emerging Markets Center
Benin6D&B North Africa
Bermuda10LABIC
Bhutan6D&B SAME
Bolivia10LABIC
Bosnia Herzegovina4Emerging Markets Center
Botswana5TU ITC
Bouvet Island---Not Reported on by D&B
Brazil7Brazil D&B
British Indian Ocean Territory---Not Reported on by D&B
Brunei10Singapore (Corre. Office)
Bulgaria4Emerging Markets Center
Burkina Faso6D&B North Africa
Burma10Singapore (Corre. Office)
Burundi6D&B North Africa
Cambodia---Not Reported on by D&B
Cameroon6D&B North Africa
Canada7-10Canada D&B
Cape Verde6D&B North Africa
Caroline Islands10Australia (Corre. Office)
Cayman Islands10LABIC
Central African Republic6D&B North Africa
Ceuta7Spain D&B
Chad6D&B North Africa
Chile10LABIC
China10China D&B
Christmas Islands10Australia (Corre. Office)
Colombia10LABIC
Cocos & Keeling Island---Not Reported on by D&B
Comoros6D&B North Africa
Congo6D&B North Africa
Cook Islands10Australia (Corre. Office)
Costa Rica10LABIC
Croatia4Emerging Markets Center
Cuba---Not Reported on by D&B
Cyprus4Emerging Markets Center
Czech3Czech D&B
Denmark3Denmark D&B
Djibouti6D&B North Africa
Dominica10LABIC
Dominican Republic10LABIC
Dubai6D&B SAME
East Timor10Singapore (Corre. Office)
Ecuador10LABIC
Egypt6D&B North Africa
El Salvador10LABIC
England3United Kingdom D&B
Equatorial Guinea6D&B North Africa
Eritrea6D&B North Africa
Estonia4Emerging Markets Center
Ethiopia6D&B North Africa
Falkland Islands6D&B North Africa
Faroe Islands7Denmark (Correspondent)
Fiji10Australia (Corre. Office)
Finland3Finland
Former Yugoslav Republic4Emerging Markets Center
France3France
French West Indies7France (Correspondent)
French Guyana7France (Correspondent)
French Southern Territory7France (Correspondent)
Friendly Isles10Australia (Corre. Office)
Furjairah - UAE6D&B SAME
Gabon6D&B North Africa
Gambia6D&B North Africa
Georgia4Emerging Markets Center
Germany3Germany D&B
Ghana10Emerging Markets Center
Gibraltar4Emerging Markets Center
Greece7Greece Alpha Mi
Greenland7Denmark (Correspondent)
Grenada10LABIC
Guadaloupe7France (Correspondent)
Guam10Australia (Corre. Office)
Guatemala10LABIC
Guinea6D&B North Africa
Guinea Bissau6D&B North Africa
Guyana10LABIC
Haiti10LABIC
Heard & McDonald---Not Reported on by D&B
Honduras10LABIC
Hong Kong7Hong Kong D&B
Hungary3Hungary D&B
Iceland4Emerging Markets Center
India (356)14D&B SAME
Indonesia10Singapore (Corre. Office)
Iran8D&B SAME
Iraq6D&B SAME
Ireland Republic of3Ireland D&B
Israel5Israel D&B
Italy3Italy D&B
Ivory Coast6D&B North Africa
Jamaica10LABIC
Japan5Japan D&B
Jordan6D&B SAME
Kazakhstan4Emerging Markets Center
Kenya6D&B North Africa
Kirghizia4Emerging Markets Center
Kiribati10Australia (Corre. Office)
Korea, Democratic Peoples Republic (North)

---

Not Reported on by D&B
Korea,Republic of (South)10Korea D&B
Kuwait6D&B SAME
Laos---Not Reported on by D&B
Latvia4Emerging Markets Center
Lebanon6D&B SAME
Leichtenstein3Switzerland D&B
Lesotho10TU ITC
Liberia---Not Reported on by D&B
Libya---Not Reported on by D&B
Lithuania4Emerging Markets Center
Luxembourg3Belgium D&B
Macau10Hong Kong (Corre. Office)
Madagascar6D&B North Africa
Madeira7Portugal (Corre Office)
Malawi6D&B North Africa
Malaysia7Malaysia D&B
Maldives6D&B SAME
Mali6D&B North Africa
Malta4Emerging Markets Center
Marianas Islands10Australia (Corre. Office)
Marshall Islands10Australia (Corre. Office)
Martinique7France (Correspondent)
Mauritania6D&B North Africa
Mauritius6D&B North Africa
Mexico7Mexico D&B
Micronesia10Australia (Corre. Office)
Midway Islands(SX)10Australia (Corre. Office)
Moldova4Emerging Markets Center
Monaco3France D&B
Mongolia---Not Reported on by D&B
Montserrat10LABIC
Morocco6D&B North Africa
Mozambique6D&B North Africa
N. Ireland3Northern Ireland D&B
Namibia10TU ITC
Nauru10Australia (Corre. Office)
Nepal6D&B SAME
Netherlands3Netherlands D&B
Netherlands Antilles10LABIC
New Caledonia7France (Correspondent)
New Zealand5New Zealand D&B
Nicaragua10LABIC
Niger6D&B North Africa
Nigeria6D&B North Africa
Norfolk Island10Australia (Corre. Office)
Northern Mariana Island10Australia (Corre. Office)
Norway3Norway D&B
Nuie Island---Not Reported on by D&B
Oman6D&B SAME
Pakistan14D&B SAME
Palau Island10Australia (Corre. Office)
Palestine10Israel D&B
Panama10LABIC
Papua New Guinea10Australia (Corre. Office)
Paraguay10Argentina (Corre. Office)
Peru7Peru D&B
Philippines10Singapore (Corre. Office)
Pitcairn Island10Australia (Corre. Office)
Poland3Poland D&B
French Polynesia7France (Correspondent)
Portugal3Portugal D&B
Puerto Rico3United States D&B
Principe Sao Tome10Emerging Markets Center
Qatar6D&B SAME
Ras Al Khaimah - UAE6D&B SAME
Reunion Island7France (Correspondent)
Romania4Emerging Markets Center
Russian Federation4Russia D&B
Rwanda6D&B North Africa
Saint Helena10Emerging Markets Center
Saint Kitts & Nevis10LABIC
Saint Lucia10LABIC
Saint Pierre & Miquelon7France (Correspondent)
Saint Vincent10LABIC
American Samoa10Australia (Corre. Office)
Western Samoa10Australia (Corre. Office)
San Marino3Italy D&B
Saudi Arabia6D&B SAME
Scotland3United Kingdom D&B
Senegal6D&B North Africa
Serbia & Montenegro4Emerging Markets Center
Seychelles6D&B North Africa
Sharjah - UAE6D&B SAME
Sierra Leone6D&B North Africa
Singapore7Singapore D&B
Slovakia7Czech Republic D&B
Slovenia4Emerging Markets Center
Society Isles10Australia (Corre. Office)
Solomon Islands10Australia (Corre. Office)
Somalia6D&B North Africa
South Africa5South Africa ITC
Spain6Spain D&B
Sri Lanka6D&B SAME
Sudan10Emerging Markets Center
Suriname10LABIC
Svalbard & Jan Mayen3Norway D&B
Swaziland10TU ITC
Sweden3Sweden D&B
Switzerland3Switzerland D&B
Syria6D&B SAME
Tahiti10Australia (Corre. Office)
Taiwan7Taiwan D&B
Tajikistan4Emerging Markets Center
Tanzania6D&B North Africa
Thailand10Singapore (Corre. Office)
Togo6D&B North Africa
Tokelau Islands10Australia (Corre. Office)
Tonga10Australia (Corre. Office)
Trinidad & Tobago10LABIC
Trust Territory10Australia (Corre. Office)
Tunisia6D&B North Africa
Turkey4Emerging Markets Center
Turkish Rep. of Cyprus4Emerging Markets Center
Turkmenistan4Emerging Markets Center
Turks & Caicos10LABIC
Tuvalu10Australia (Corre. Office)
Uganda6D&B North Africa
United Kingdom3United Kingdom D&B
Ukraine7Emerging Markets Center
Umm-Al-Quwain - UAE6D&B SAME
Uruguay10Argentina (Corre. Office)
United States of America5 - 7USA D&B
US Minor Outlying Islands, Baker/Howland10Australia (Corre. Office)
Uzbekistan4Emerging Markets Center
Vanuatu10Australia (Corre. Office)
Vatican City3Italy D&B
Venezuela10LABIC
Vietnam10Singapore (Corre. Office)
American Virgin Islands10USA D&B
British Virgin Islands10LABIC
Wake Islands10Australia (Corre. Office)
Wales3United Kingdom D&B
Wallis and Futuna Island7France (Correspondent)
West Indies10LABIC
Western Sahara---Not Reported on by D&B
Yemen6D&B SAME
Zaire10Emerging Markets Center
Zambia6D&B North Africa
Zimbabwe10TU ITC

Feature Notes

Investigations initiated using the D&B Direct API may only be requested for the Business Information Report, although when the investigation is completed any data updated in the BIR will also be available in D&B Direct products that provide similar information.

Additional questions may be submitted (in the comments field) with the initial investigation request. Responses to these questions will be appended to the Business Information Report provided upon completion of the investigation.

When an investigation is requested on an in date case, please provide an explanation in the comments section. This is an operational requirement that ensures the local D&B Customer Service Center understands the expectations of the request.

If D&B is unable to locate the organization based on the information provided in the request, an Unable To Locate (UTL) report will be prepared and delivered.

Multiple email addresses may be included with the request, and each will receive a notification email -- with the Business Information Report attached --when the investigation process is completed. A copy of the report is also stored in the Product Request Archive.

What to do Next

Check Investigation Status

Investigation status can be checked using the List Portfolio Asset with the below options:

Use Investigation Status Code and User Read Indicator query parameters:

  • /V2/assets?UserReadIndicator=0&InvestigationStatusCode=5&SortBasisText=FulfillmentTimeStamp &SortDirectionText=Descending

The above REST URL will list all the Fulfilled Investigations records and records that have not been retrieved using Retrieve Portfolio. The response will be sorted by Fulfilled Timestamp in descending order.

Use Investigation Tracking ID query parameter:

  • /V2/assets?InvestigationTrackingID={InvestigationTrackingID}

The above REST URL will provide the status of Investigation Status Text: Pending, Fulfilled or Cancelled.

NOTE: No action is required if Investigation Status Text is Pending or Cancelled.

Use time stamp fields Order From Timestamp, Order To Timestamp and Fulfillment From Timestamp, Fulfillment To Timestamp:

  • /V2/assets?InvestigationStatusCode=5&OrderFromTimestamp=2018-10-01T00:00:00Z&OrderToTimestamp=2018-11-01T00:00:00Z
  • /V2/assets?FulfillmentFromTimestamp=2018-10-01T00:00:00Z&FulfillmentToTimestamp=2018-11-01T00:00:00Z

The above REST URL will list all the Fulfilled Investigations records between the time period provided.

Retrieve Fulfilled Reports

Use the following REST URLs to retrieve the report stored for the Asset/ Investigation Tracking ID provided.

  • /V2/assets/{PortfolioAssetID}?ApplicationTransactionID={PassUniqueNumber}
  • /V2/assets?InvestigationTrackingID={InvestigationTrackingID}

NOTE: After retrieval, status of Investigation will be changed to 'Delivered' and User Read Indicator will be updated to ‘true’.