Loading

Direct 2.0
Collapse

Add Monitoring Registration

ProductD&B Direct Onboard, 2.0
Product Code(s)Not Applicable
Options(s)None
Monitoring AvailableNo
InterfaceREST
MethodPOST
Format(s)JSON
ServiceMonitoring
{version}8.0
8.0 Released onFebruary 15, 2019

This function allows a customer to specify one D-U-N-S Number, along with active monitoring and notification profiles, and initiates the monitoring process for that organization.

The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Number and initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, or events with data layer included.

Update History

No modifications have been made to this data layer since the initial release.

What to do First

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective December 14, 2018.

NOTE: As of August 22, 2014, for performance reasons, this function no longer performs a Product Availability check during the course of registering a D-U-N-S Number. As a result, it is possible for a registration to be successful, but later result in an unsuccessful state. An upcoming release will provide a method for viewing these cases.

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 does not require entitlement for production and trial usage. While this component does not require entitlement, customers will only be permitted to monitor data layers to which they have been entitled.

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

The Product Availability Lookup feature should be utilized PRIOR TO CALLING THIS OPERATION to determine if the D&B Direct product that will monitored is available for a given D-U-N-S Number.

NOTE: The default value for AutoRenewalIndicator is 'false', indicating that the registration will NOT be automatically renewed at the end of the current contract.

When monitoring the People data layer, a principal identification number (Principal ID) will be required by this operation.

Restriction: An XML namespace statement MUST be included as the first statement within the primary Aggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.

Sample Request (Add)
POST https://direct.dnb.com/V8.0/monitoring/registrations
Content-Type: application/json
Authorization: <MyToken>

{
  "mon:AddMonitoringRegistrationRequest": {
    "@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
    "TransactionDetail": {
      "ApplicationTransactionID": "ID_003",
    },
    "AddMonitoringRegistrationRequestDetail": {
      "InquiryDetail": {
        "DUNSNumber": "16144166",
        "CountryISOAlpha2Code": "US"
      },
      "MonitoringRegistrationSpecification": {
        "MonitoringProfileID": 8932,
        "NotificationProfileID": 4336,
        "TradeUpIndicator": "false",
        "AutoRenewalIndicator": "false",
        "SubjectCategoryText": "High"
      },
      "InquiryReferenceDetail": {
        "CustomerReferenceText": "16144166_Monitoring_Sept2013",
        "CustomerBillingEndorsementText": "16144166_Monitoring"
      }
    }
  }
}
Name Characteristics
AddMonitoringRegistrationRequest Aggregate
AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute
AddMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

AddMonitoringRegistrationRequest { TransactionDetail { 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.

END: AddMonitoringRegistrationRequest } TransactionDetail /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail Aggregate, Required

Records the details to add company / companies for monitoring, allowing the customer to receive alerts when there is a data change for the company.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail Aggregate, Required
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to register for Monitoring.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { 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 of the inquired subject.

END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } InquiryDetail /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification Aggregate, Required

Records details of an organization to be monitored and the preferences that the customer has set for registering an organization for Monitoring.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { MonitoringProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { NotificationProfileID int, Required

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { TradeUpIndicator boolean, Optional

When true (set to 1) this denotes that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When false (set to 0) this denotes that the customer has not requested that D&B return the data for the Headquarters when the requested organization is a Branch; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Note: There are D&B WorldWide Network operations where the Headquarters information will be returned automatically, regardless of the customer request.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { AutoRenewalIndicator boolean, Optional

When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

Possible values: High; Medium; Low

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { RegistrationReasonCode integer up to 7 digits., Optional

Code identifying the reason for the Customer showing interest to monitor this subject. This reason needs to be captured to comply with German Data Protection Laws.

END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } MonitoringRegistrationSpecification /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } InquiryReferenceDetail /Aggregate
END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail /Aggregate
END: AddMonitoringRegistrationRequest /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

Endpoint

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

Endpoint (Monitoring)
POST https://direct.dnb.com/V{version}/monitoring/registrations

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

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 (Add)
{"AddMonitoringRegistrationResponse": {
   
   "TransactionDetail":    {
      "ApplicationTransactionID": "ID_003",
      "ServiceTransactionID": "Id-fd8a0c3e5244711b099bffff-2",
      "TransactionTimestamp": "2016-12-16T13:38:38-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM026",
      "ResultText": "Request accepted.Processing pending."
   },
   "AddMonitoringRegistrationResponseDetail":    {
      "InquiryDetail":       {
         "DUNSNumber": "016144166",
         "CountryISOAlpha2Code": "US"
      },
      "MonitoringRegistrationDetail":       {
         "DUNSNumber": "016144166",
         "MonitoringProfileID": 8932,
         "NotificationProfileID": 4336,
         "StartDate": {"$": "2016-09-26"},
         "EndDate": {"$": "2017-06-05"}
      },
      "InquiryReferenceDetail":       {
         "CustomerReferenceText": ["16144166_Monitoring_Sept2013"],
         "CustomerBillingEndorsementText": "16144166_Monitoring"
      }
   }
}}

Name Characteristics
AddMonitoringRegistrationResponse Aggregate
AddMonitoringRegistrationResponse@xsi:schemaLocation Attribute
AddMonitoringRegistrationResponse { TransactionDetail Aggregate, Required

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

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

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

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

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

AddMonitoringRegistrationResponse { 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: AddMonitoringRegistrationResponse } TransactionDetail /Aggregate
AddMonitoringRegistrationResponse { TransactionResult Aggregate, Required

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

AddMonitoringRegistrationResponse { TransactionResult { SeverityText string up to 16 chars., Required

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

Possible values: High; Medium; Low

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

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

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

Text that explains the outcome of the transaction.

AddMonitoringRegistrationResponse { 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.

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

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

END: AddMonitoringRegistrationResponse } TransactionResult } ResultMessage /Aggregate
END: AddMonitoringRegistrationResponse } TransactionResult /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail Aggregate, Optional

Records the details of the company / companies that are registered for monitoring which will allow the customer to receive alerts when there is a data change for the company.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail Aggregate, Required
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to register for Monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { 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 of the inquired subject.

END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } InquiryDetail /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail Aggregate, Required

Records details of an organization that will be monitored.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is registered for Monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID int, Required

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate date, Required

The date when the subject has been registered for monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate date, Required

The date when the subject registration for monitoring has been ended.

END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } InquiryReferenceDetail /Aggregate
END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail /Aggregate
END: AddMonitoringRegistrationResponse /Aggregate

Response Codes

Successful service requests will return a CM026 response code in the TransactionResult ResultID field, however, the registration will be set to a pending status until several asynchronous steps are completed. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM002, CM004, CM009, CM011, CM012, CM023, MN001, MN002, PD003, PD005, PD006, PD016, PD017, SC001-SC009.

Use the List Monitoring Registation operation to determine when the additional asynchronous steps are complete, and for the success/failure of the registration (value in MonitoringRegistrationStatusText).

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]).

Operation-specific supplemental response code explanations:

CM001Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
CM002Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request, Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM009Missing reason code
CM012Invalid subject- Duns number
CM023Duplicate Registration
PD003DUNS stop distribution
PD005Requested Product not available
PD006

Trade-up to HQ is not available.

NOTE: Applicable only for US/CA cases when TradeUpIndicator= "true" for Risk packets.

PD016DUNS transferred
PD017DUNS out of business

Feature Notes

The EndDate for new registrations will be set to the last day of the current contract year. Registrations for customers with multi-year contracts will be extended each year for the duration of the contract only if the AutoRenewalIndicator is set to 'true'.

Active registrations, those with the AutoRenewalIndicator set to 'true' and not subsequently updated to 'cancelled', will be re-registered at the time of contract renewal by extending the registration EndDate to the last day of the contract year.

If the contract renewal occurs after the previous contract expires, the registrations will NOT be auto-renewed.

If registration is pending for more than 14 days, the registration will be placed in failed status.

What to do Next