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 -X POST https://api.complycube.com/v1/checks/{:checkId} \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"enableMonitoring": true
}'
Example responses
{
"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"
}
Last updated
Was this helpful?