API Reference
v1.7.3
Search…
⌃K

Update a check

post
https://api.complycube.com
/v1/checks/:id
Update a check
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.
Parameters
Path
id*
string
The ID of the check.
Header
Content-Type*
string
The content-type must always be set to application/json.
Authentication*
string
The API live or test key.
Body
enableMonitoring
boolean
Determines whether continuous monitoring is enabled.
Responses
200
Check successfully updated.
400
Updating a check that is not of type standard_screening_check or extensive_screening_check.

Example request

cURL
Node.js
Python
PHP
.NET
curl -X POST https://api.complycube.com/v1/checks/{:checkId} \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"enableMonitoring": true
}'
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const client = await complycube.check.update("CHECK_ID", {
enableMonitoring: true
});
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
check = cc_api.checks.update('CHECK_ID', enableMonitoring=True)
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$check = $ccapi->checks()->update('CHECK_ID', ['enableMonitoring' => true]);
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);