API Reference
v1.7.3
Search…
⌃K

Filtering checks

Below is a list of attributes available for filtering checks.
Attribute
Type
clientId
string
type
string
status
string
documentId
string
addressId
string
livePhotoId
string
liveVideoId
string
result.outcome
string

Example - Get all checks for one type

In the example below, we will request to get all checks that are of type document_check.
cURL
Python
PHP
.NET
curl -X GET https://api.complycube.com/v1/checks?type=document_check \
-H 'Authorization: <YOUR_API_KEY>'
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
doc_checks = cc_api.checks.list(type='document_check')
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$doc_checks = $ccapi->checks()->list(['type' => 'document_check']);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;
var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var filter = new CheckRequest { type = "document_check" }
var docChecks = await checkApi.ListAsync(filter);