Please refer to the check type respective pages for a more detailed breakdown of request and response structures:
URL
POST https://api.complycube.com/v1/checks
Creates a new check.
Body
Example request
curl -X POST https://api.complycube.com/v1/checks \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"CLIENT_ID",
"type": "extensive_screening_check"
}'
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const check = await complycube.check.create("CLIENT_ID", {
type: "extensive_screening_check"
});
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
check = cc_api.checks.create('CLIENT_ID',type='extensive_screening_check')
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$result = $ccapi->checks()->create('CLIENT_ID', [
'type' => 'extensive_screening_check'
]);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;
var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var checkRequest = new CheckRequest {
clientId = "CLIENT_ID",
type = "extensive_screening_check"
};
var check = await checkApi.CreateAsync(checkRequest);
Example response
{
"id": "5eb2b61e02df0a0008f1cf2a",
"clientId": "5eb1276d96be4a0008713af5",
"entityName": "John Doe",
"type": "extensive_screening_check",
"status": "pending",
"enableMonitoring": false,
"createdAt": "2020-01-01T14:06:44.756Z",
"updatedAt": "2020-01-01T14:06:44.756Z"
}