Monitoring APIs

The Monitoring APIs allow you to manage your registrations. This page provides a list of the available APIs as well as guidelines and best practices for using them.

The following functions are provided to manage Registrations:

Before using any API, you must have an access token; see the Authentication page for more information.

The following resources are available:

Add D-U-N-S Numbers to an Existing Registration

This feature can be used to add one or more D-U-N-S Numbers to an existing Monitoring Registration. Adding D-U-N-S Numbers is a batch operation; once the API request is accepted, the request will be processed and an email will be sent once it is completed.

Best Practice:

A file with a list of D-U-N-S Numbers must be attached to the request. The file must be a flat structure, with each D-U-N-S Number to be added on a separate line.

Any failures are logged in the Registration exceptions file that is transferred to the defined delivery location.

If the initial Monitoring Registration included a request for seed data, a Seed Notification for each added D-U-N-S Number will be included with the next regularly scheduled notification.

Delete Registration

This feature can be used to delete a Registration. Once a Registration is deleted, it cannot be restored (it must be re-created) and change notifications will no longer be provided for the product and D-U-N-S Numbers in that Registration.

Before deleting a registration, consider:

Deleting a registration requires 2 steps:

Edit Registration

This API can be used to change most Registration properties. The following cannot be changed:

To change the registered D-U-N-S Numbers, please see Add D-U-N-S Numbers to an existing Registration or Remove D-U-N-S Numbers from an Existing Registration.

Changing Frequency

A frequency change does not happen immediately. The previous frequency is still in effect until the last delivery in the cycle. For example:

Export List of D-U-N-S Numbers

The system sends an email confirming the file has been delivered per the delivery channel configuration in the Registration.

The text file provided will list all the D-U-N-S Numbers that are currently part of the Registration.

The file will be available in the defined delivery location as REFERENCE_YYYYMMDDHHMMSS_DunsExport_FILE-NUMBER.zip

Remove D-U-N-S Numbers from an Existing Registration

This feature can be used to remove one or more D-U-N-S Numbers to an existing Monitoring Registration. Removing D-U-N-S Numbers is a batch operation; once the API request is accepted, the request will be processed and an email will be sent once it is completed.

Best Practice:

A file with a list of D-U-N-S Numbers must be attached to the request. The file must be a flat structure, with each D-U-N-S Number to be removed on a separate line.

Any failures are logged in the Registration exceptions file that is transferred to the defined delivery location.