Monitoring

The samples provided are representative of what can be included in requests or will be returned in responses. In order to provide comprehensive samples, values may have been added for the sole purpose of these examples and may be null or empty in the actual API responses.

In addition, values in both requests and responses have been "faked" or modified to protect potentially private data (e.g., phone number) where applicable. Therefore, using requests exactly as is may not return any results.

Page Contents

Add Subjects to existing Registration

Request

PATCH https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects
Accept: application/json 
Authorization: Bearer yourtoken
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="addSubjectIDs"; filename="file.txt"
Content-Type: 


------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "transactionDetail": {
    "transactionID": "rrt-705ef266-c-ea-17368-32348214-3",
    "transactionTimestamp": "2021-11-09T22:22:25.873Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21108",
    "message": "Request to append subjectIDs to registration accepted, processing pending."
  }
}

Add Single Subject to existing Registration

Request

POST https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects/00000000001
Authorization: Bearer yourtoken

Response

{
    "transactionDetail": {
        "transactionID": "740342ed-ec61-44a1-82fd-b1a8ecb75ea6",
        "transactionTimestamp": "2021-11-09T22:22:25.873Z",
        "inLanguage": "en-US"
    },
    "information": {
        "code": "21113",
        "message": "Requested subjectID added to registration successfully."
    }
}

Check for Subject

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects/00000000001
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-705ef266-c-ea-17369-32344988-7",
    "transactionTimestamp": "2021-11-09T22:13:34.218Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "myregistration"
  },
"information": {
	"code": "21110",
	"message": "SubjectID is available in registration"
}
}

Export List of Subject

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects 
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-705ef266-c-ea-17369-32344988-7",
    "transactionTimestamp": "2021-11-09T22:13:34.218Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "myregistration"
  },
  "information": {
    "code": "21109",
    "message": "Request accepted, processing pending for returning a list of subjectIDs."
  }
}

Remove Subjects from existing Registration

Request

PATCH https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects
Accept: application/json 
Authorization: Bearer yourtoken
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="removeSubjectIDs"; filename="file.txt"
Content-Type: 

------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-31685-269774-10",
    "transactionTimestamp": "2021-11-12T20:32:09.857Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21107",
    "message": "Request accepted, processing pending for deleting a list of SubjectIDs."
  }
}

Add DUNS to existing Registration

Request

PATCH https://plus.dnb.com/v1/monitoring/registrations/myregistration/duns/add
Accept: application/json 
Authorization: Bearer yourtoken
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="duns"; filename="file.txt"
Content-Type: 


------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "transactionDetail": {
    "transactionID": "rrt-705ef266-c-ea-17368-32348214-3",
    "transactionTimestamp": "2017-05-09T22:22:25.873Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21108",
    "message": "Request to append duns to registration accepted, processing pending."
  }
}

Add Single DUNS to existing Registration

Request

POST https://plus.dnb.com/v1/monitoring/registrations/myregistration/duns/804735132
Authorization: Bearer yourtoken

Response

{
    "transactionDetail": {
        "transactionID": "740342ed-ec61-44a1-82fd-b1a8ecb75ea6",
        "transactionTimestamp": "1591092225",
        "inLanguage": "en-US"
    },
    "information": {
        "code": "21113",
        "message": "Requested duns added to registration successfully."
    }
}

Delete a Registration

Initiate Delete Request

DELETE https://plus.dnb.com/v1/monitoring/registrations/myregistration
Authorization: Bearer yourtoken

Initiate Delete Response

{
  "transactionDetail": {
    "transactionID": "rrt-98842f8e-c-ea-6285-207725-5",
    "transactionTimestamp": "2017-05-12T18:16:10.989Z",
    "inLanguage": "en-US"
  },
  "action": {
    "code": "51001",
    "message": "Please provide acknowledgement token to commit action",
    "url": "https://plus.dnb.com/v1/monitoring/registrations/myregistration?ackToken=1234567890123",
    "method": "DELETE"
  }
}

Confirm Delete Request

DELETE https://plus.dnb.com/v1/monitoring/registrations/myregistration?ackToken=1234567890123
Authorization: Bearer yourtoken

Confirm Delete Response

{
  "transactionDetail": {
    "transactionID": "rrt-e39b70d3-b-ea-9844-223003-13",
    "transactionTimestamp": "2017-05-12T18:17:57.217Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21105",
    "message": "Request accepted, processing pending for deleting registration."
  },
  "messages": {
    "registration": {
      "reference": "myregistration",
      "destination": {
        "type": "STP"
      },
      "productId": "cmpelk",
      "versionId": "v1",
      "email": "ourgroup@mycompany.com, jsmith@company.com, mytam@dnb.com",
      "triggerType": "PUSH",
      "frequency": "DAILY",
      "seedData": true,
      "fileTransferProfile": "MySTPProfile",
      "description": null,
      "notificationType": "UPDATE"
    },
    "dunsCount": 13
  }
}

Edit Registration Details

Request

PATCH https://plus.dnb.com/v1/monitoring/registrations/myregistration
Accept: application/json 
Authorization: Bearer yourtoken
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="destinationType"

STP
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="destinationHost"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="destinationPort"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="destinationUrn"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="email"

ourgroup@mycompany.com, jsmith@company.com, mytam@dnb.com
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="fileTransferProfile"

MySTPProfile
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="maxDistributionConnections"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="Description"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="jsonPathInclusion"


------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="jsonPathExclusion"

organization.financials,organization.primaryAddress
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="encryptionKey"

------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-18049-34829187-12",
    "transactionTimestamp": "2017-05-09T22:23:40.987Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21100",
    "message": "Registration accepted, processing complete."
  }
}

Export List of DUNS

Request

GET https://plus.dnb.com/v1/monitoring/registrations/export/myregistration/duns 
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-705ef266-c-ea-17369-32344988-7",
    "transactionTimestamp": "2017-05-09T22:13:34.218Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "myregistration"
  },
  "information": {
    "code": "21109",
    "message": "Request accepted, processing pending for returning a list of duns."
  }
}

List Pending Deliveries

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration/deliveries
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rlh-hi9puyoijk-jop8u-kd-d-1",
    "transactionTimestamp": "2017-02-21T17:46:19.839Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "myregistration"
  },
  "deliveries": [
    {
      "id": 41,
      "status": "SUCCESSFUL",
      "type": "SEED_FILE",
      "subject": "Monitoring - Registration Status:STG_CMPELKv2_MKTLNK_FP",
      "to": "joe@company.com, steve@company.com, donna@company.com",
      "headerFileName": "MYREGISTRATION_20170331132934_SEEDFILE_HEADER.json",
      "rootFileName": "MYREGISTRATION_20170331132934_SEEDFILE",
      "transferType": "STP",
      "numFiles": 5,
      "transferProfile": "mystpprofile",
      "created": "2017-03-31T13:29:34Z",
      "transferred": "2017-03-31T13:29:34Z"
    }
  ]
}

List Registrations

Request

GET https://plus.dnb.com/v1/monitoring/registrations/
Authorization: Bearer yourtoken

Response

{
    "transactionDetail": {
        "transactionID": "rrt-98842f8e-c-ea-13107-32529894-2",
        "transactionTimestamp": "2017-05-04T18:35:12.976Z",
        "inLanguage": "en-US"
    },
    "messages": {
        "references": [
            "myregistration",
            "myregistration2"
        ]
    }
}

Get Registration Details

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration
Authorization: Bearer yourtoken

Response

{
    "transactionDetail": {
        "transactionID": "rrt-ec0304fa-d-ea-7971-32481541-6",
        "transactionTimestamp": "2017-05-04T18:36:18.331Z",
        "inLanguage": "en-US"
    },
    "inquiryDetail": {
        "reference": "myregistration"
    },
    "messages": {
		 "apiKey": {
            "keyType": "Production",
            "key": "f66d********************************************************0971"
        },
        "registration": {
            "reference": "myregistration",
            "destination": {
                "type": "STP"
            },
            "productId": "cmpelk",
            "versionId": "v1",
            "email": "group@mycompany.com",
            "triggerType": "PUSH",
            "frequency": "DAILY",
            "seedData": true,
            "fileTransferProfile": "OTMUCust3",
            "description": null,
            "notificationType": "UPDATE",
            "jsonPathExclusion": "organization.financials,organization.primaryAddress"
        },
        "notificationsSuppressed": true,
        "dunsCount": 7
    }
}

Get Status

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration/status
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-e39b70d3-b-ea-10406-34942598-4",
    "transactionTimestamp": "2017-05-09T22:16:32.236Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "myregistration"
  },
  "messages": {
    "status": "ACTIVE"
  }
}

Remove DUNS from existing Registration

Request

PATCH https://plus.dnb.com/v1/monitoring/registrations/myregistration/duns/remove
Accept: application/json 
Authorization: Bearer yourtoken
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="duns"; filename="file.txt"
Content-Type: 

------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-31685-269774-10",
    "transactionTimestamp": "2017-05-12T20:32:09.857Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21107",
    "message": "Request accepted, processing pending for deleting a list of DUNS"
  }
}

Remove Single DUNS from existing Registration

Request

DELETE https://plus.dnb.com/v1/monitoring/registrations/{myregistration}/duns/804735132
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-31685-269774-10",
    "transactionTimestamp": "2017-05-12T20:32:09.857Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21114",
    "message": "Requested duns removed from registration successfully."
  }
}

Remove Single Subject from Registration

Request

DELETE https://plus.dnb.com/v1/monitoring/registrations/myregistration/subjects/3987390190
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-31685-269774-10",
    "transactionTimestamp": "2017-05-12T20:32:09.857Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21114",
    "message": "Requested subject removed from registration successfully."
  }
}

Request Notifications be sent

Request

GET https://plus.dnb.com/v1/monitoring/registrations/myregistration/push
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-31685-269774-12",
    "transactionTimestamp": "2017-05-12T20:32:42.421Z",
    "inLanguage": "en-US"
  },
  "inquiryDetail": {
    "reference": "MyCompanyCMPELK"
  },
  "information": {
    "code": "21104",
    "message": "Pending notifications will be sent to the registered delivery channel."
  }
}

Suppress Notifications

Request

POST https://plus.dnb.com/v1/monitoring/registrations/myregistration/suppress
Authorization: Bearer yourtoken
Accept: application/json

Response

{
  "transactionDetail": {
    "transactionID": "rrt-ec0304fa-d-ea-14594-34888403-14",
    "transactionTimestamp": "2017-05-09T22:19:00.269Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21102",
    "message": "Suppressed"
  }
}

Unsuppress Notifications

Request

DELETE https://plus.dnb.com/v1/monitoring/registrations/myregistration/suppress
Authorization: Bearer yourtoken

Response

{
  "transactionDetail": {
    "transactionID": "rrt-f4ede2e2-d-ea-18048-34827462-13",
    "transactionTimestamp": "2017-05-09T22:19:23.289Z",
    "inLanguage": "en-US"
  },
  "information": {
    "code": "21103",
    "message": "UnSuppressed"
  }
}
DNB Full Logo Direct+ Product Documentation