Comment on page
Create a check

Please refer to the check type respective pages for a more detailed breakdown of request and response structures:
​Standard AML Screening​
​Extensive AML Screening​
​Document Check​
​Identity Check​
​Enhanced Identity Check​
​Proof of Address Check​
​Age Estimation Check​
post
https://api.complycube.com
/v1/checks
Create a check
Creates a new check.
Parameters
Header
Content-Type*
string
The content-type must always be set to application/json.
Authentication*
string
The API live or test key
Body
clientId*
string
The ID of the client.
type*
string
The type of check. Valid values include:
1. standard_screening_check
2. extensive_screening_check
3. document_check
4. identity_check
5.  enhanced_identity_check
6. proof_of_address_check
7. multi_bureau_check
8. face_authentication_check
9. age_estimation_check
enableMonitoring
boolean
Determines whether continuous monitoring is enabled. When not provided, it defaults to false.
documentId
string
The ID of the document. This is required when the type of check is document_check, identity_check, or enhanced_identity_check.
livePhotoId
string
The ID of the live photo. This is required when the type of check is identity_check, age_estimation_check, and face_authentication_check.
liveVideoId
string
The ID of the live video. This is required when the type of check is enhanced_identity_check.
options
object
The advanced optional configuration associated with the check. Also, see the options object defined under each type of check.
clientConsent
boolean
Where required, you must collect the client's consent before creating a check. 
Responses
200
Check successfully created.
Example request
cURL
Node.js
Python
PHP
.NET
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);
​
Checks
Get a check
Last modified 30d ago