Update a check

URL

POST https://api.complycube.com/v1/checks/:id

Updates the specified check by setting the values of the parameters passed. You can only update checks of type standard_screening_check and extensive_screening_check. The update allows you to enable or disable continuous monitoring.

Headers

Name	Type	Description
Content-Type*	string	The content-type must always be set to application/json.
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the check.

Body

Name	Type	Description
enableMonitoring	boolean	Determines whether continuous monitoring is enabled.

Example request

cURL

curl -X POST https://api.complycube.com/v1/checks/{:checkId} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"enableMonitoring": true
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.check.update("CHECK_ID", {
  enableMonitoring: true
});

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

check = cc_api.checks.update('CHECK_ID', enableMonitoring=True)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$check = $ccapi->checks()->update('CHECK_ID', ['enableMonitoring' => true]);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;

var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var checkRequest = new CheckRequest {
  enableMonitoring = "standard_screening_check"
};

var check = await checkApi.UpdateAsync("CHECK_ID", checkRequest);

Example responses

Success (200)

{
    "id": "5eb2b61e02df0a0008f1cf2a",
    "clientId": "5eb1276d96be4a0008713af5",
    "entityName": "John Doe",
    "type": "extensive_screening_check",
    "status": "complete",
    "enableMonitoring": true,
    "result": {
        "outcome": "clear",
        "breakdown": {
            "summary": {
                "pep": {
                    "level1": "clear",
                    "level2": "clear",
                    "level3": "clear",
                    "level4": "clear"
                },
                "watchlist": {
                    "sanctionsLists": "clear",
                    "otherOfficialLists": "clear",
                    "warCrimes": "clear",
                    "terror": "clear",
                    "otherExclusionLists": "clear",
                    "sanctionsControlAndOwnership": "clear"
                },
                "adverseMedia": {
                    "environmentProduction": "clear",
                    "socialLabour": "clear",
                    "competitiveFinancial": "clear",
                    "regulatory": "clear"
                },
                "otherLists": {
                    "associatedEntity": "clear",
                    "organisedCrime": "clear",
                    "financialCrime": "clear",
                    "taxCrime": "clear",
                    "corruption": "clear",
                    "trafficking": "clear"
                }
            }
        }
    },
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:07:10.401Z"
}

Invalid Request (400)

{
    "type": "invalid_check_update",
    "message": "Only checks of type 'standard_screening_check' and 'extensive_screening_check' may be updated"
}