Contact Us

Cloudcheck Watchlist Monitoring API1.0

Core

APIs

Overview

The Cloudcheck Watchlist Monitoring API contains endpoints relating to the ongoing monitoring features available in Cloudcheck.

Create Associations

Path /watchlist/create-associations/ Method POST

Creates associations for ongoing monitoring. Up to 1,000 associations can be created per request.

Parameter Required Description
key true

Your API Key.
signature true

An HMAC SHA-256 signature of request data for call validation. See details on generating a request signature.
nonce true

A single-use key generated for this request. Note that each nonce may only be used once for each access key.
timestamp true

The system timestamp when the request was created in milliseconds since the Epoch (timezone independent). Note Unix time is in seconds and will need to be multiplied by 1000. Requests with old timestamps will be rejected.
data true

A JSON string containing the association(s) to add.

Request

The details of the associations to create must be supplied as a JSON object, included in the POST as the data parameter. All the request parameters need to be included in the signature generation, and the request signed with the private key provided to you.

Example

Response

A successful review response JSON is shown below.

Example

The associationReference is a unique reference generated by Cloudcheck, which can be used in other Watchlist Monitoring APIs.

Delete Associations

Path /watchlist/delete-associations/ Method POST

Deletes associations that have been created for ongoing monitoring. Up to 1,000 associations can be deleted per request.

Parameter Required Description
key true

Your API Key.
signature true

An HMAC SHA-256 signature of request data for call validation. See details on generating a request signature.
nonce true

A single-use key generated for this request. Note that each nonce may only be used once for each access key.
timestamp true

The system timestamp when the request was created in milliseconds since the Epoch (timezone independent). Note Unix time is in seconds and will need to be multiplied by 1000. Requests with old timestamps will be rejected.
data true

A JSON string containing the association(s) to delete.

Request

The references of the associations to delete must be supplied as a JSON object, included in the POST as the data parameter. All the request parameters need to be included in the signature generation, and the request signed with the private key provided to you.

Example

Response

A successful review response JSON is shown below.

Example

Get Associations

Path /watchlist/associations/ Method GET

Fetches associations that have been created in Cloudcheck. Because this API can return a large number of records, pagination is used to limit the results of a particular call to a maximum of 10,000. This ensures that the API call returns a response in a timely fashion. Filters are available to restrict the results returned.

Parameter Required Description
key true

Your API Key.
signature true

An HMAC SHA-256 signature of request data for call validation. See details on generating a request signature.
nonce true

A single-use key generated for this request. Note that each nonce may only be used once for each access key.
timestamp true

The system timestamp when the request was created in milliseconds since the Epoch (timezone independent). Note Unix time is in seconds and will need to be multiplied by 1000. Requests with old timestamps will be rejected.
pageSize false

The number of associations to return per request. Must be > 0 and <= 10000. Defaults to 1000.
filterAlertOnly false

Return associations in alert status only if set to true. Defaults to false, meaning that associations are returned regardless of their alert status.
filterIsDeleted false

Return associations that have been deleted if set to true. Defaults to false, meaning that active associations are returned.
cursor false

Controls pagination. Can be omitted or set to "0" for the first call and set to nextCursor for subsequent calls (nextCursor returned in response meta if more data is available).

Response

The response JSON contains the matching associations.

Example

The personDetail element will be present if type is PERSON. The entityDetail element will be present if type is ENTITY.

If the nextCursor element is returned in the meta element it means that more associations are available for download. To fetch them, repeat the Get Associations API call, setting the cursor value to the value of nextCursor.

Each association can be identified by the unique associationReference. The hasAlerts flag indicates that the association is in alert mode, if set to true.

Get Association

Path /watchlist/association/ Method GET

Fetches all details of an association from Cloudcheck, including match and review information. We recommend that you call this API when the association need to be viewed in your system. It's an expensive operation, and can take a while to complete, depending on the number of matches in the system.

Do not call this API concurrently as Dow Jones restricts the number of calls we make to them. Instead, call this API sequentially, i.e. wait for a response to be returned before making another call. Failure to do this can result in a 429 (Too Many Requests) response being returned.

Parameter Required Description
key true

Your API Key.
signature true

An HMAC SHA-256 signature of request data for call validation. See details on generating a request signature.
nonce true

A single-use key generated for this request. Note that each nonce may only be used once for each access key.
timestamp true

The system timestamp when the request was created in milliseconds since the Epoch (timezone independent). Note Unix time is in seconds and will need to be multiplied by 1000. Requests with old timestamps will be rejected.
associationReference true

Unique Cloudcheck identifier for an association.

Response

The response JSON contains the matching association.

Example

The personDetail element will be present if type is PERSON. The entityDetail element will be present if type is ENTITY.

The matches element contains an array of matches for this association, along with the latest review submitted for this match, if it exists. Each match can be identified by its unique matchId.

Review Match

Path /watchlist/review-match/ Method POST

Use this API to perform a review on a match. Do not call this API concurrently as Dow Jones restricts the number of calls we make to them. Instead, call this API sequentially, i.e. wait for a response to be returned before making another call. Failure to do this can result in a 429 (Too Many Requests) response being returned.

Parameter Required Description
key true

Your API Key.
signature true

An HMAC SHA-256 signature of request data for call validation. See details on generating a request signature.
nonce true

A single-use key generated for this request. Note that each nonce may only be used once for each access key.
timestamp true

The system timestamp when the request was created in milliseconds since the Epoch (timezone independent). Note Unix time is in seconds and will need to be multiplied by 1000. Requests with old timestamps will be rejected.
data true

A JSON string containing the review data.

Request

The details of the review must be supplied as a JSON object, included in the POST as the data parameter. All the request parameters need to be included in the signature generation, and the request signed with the private key provided to you.

Example

The matchId is the unique identifier for a match within Cloudcheck.

The possible values for decision are:

Code Description
CLEARED Indicates that this match is not considered as a risk, but you want to be alerted if changes to the matched profile occur later.
PERMANENTLY_CLEARED Indicates that this match is not considered as a risk and you do not want to be alerted again, even if changes to the matched profile occur later.
CONFIRMED Indicates that this matched profile is considered a risk. Alerts will be raised against a Match on any further updates to the matched profile.
CONFIRMED_RISK_MITIGATED Indicates that this matched profile is considered a risk. This is a variant of the CONFIRMED state, which can be used to record different states in the user’s decision process. Alerts will be raised against a Match on any further updates to the matched profile.

Response

A successful review response JSON is shown below.

Example