API Reference
v1.7.3
Search…
⌃K

Validate check outcome

post
https://api.complycube.com
/v1/checks/:id/validate
Validate check outcome
Validates the outcome of the specified check. The outcome of a check can be changed through validation. For checks of type standard_screening_check and extensive_screening_check, this requires confirming or rejecting each of the found matches. For other check types, validation will change the check outcome.
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
outcome*
string
The validation outcome. Valid values include: 1. confirmed 2. rejected 3. attention
matchId
string
The match ID. This is required for checks of type standard_screening_check and extensive_screening_check.
rejectionReasons
array
The list of rejection reasons. Valid values include: 1. document_appears_fake 2. document_has_expired 3. document_is_specimen 4. document_is_blacklisted 5. document_age_below_threshold 6. document_misread This is can only be provided for checks of type document_check.
userSuppliedData
object
The manually provided document details. This will override the extractedData attribute within a document_check.
comment
string
A comment that can be associated with the validation. This can be up to 4,000 characters long.
Responses
200
Check validated successfully.

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 '{
"outcome": "rejected",
"comment": "Upon manual review, the ID appears fake."
}'
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const client = await complycube.check.validate("CHECK_ID", {
outcome: "rejected",
comment: "My first comment"
});
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
check = cc_api.checks.validate('CHECK_ID',outcome='rejected',comment='my comment')
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$check = $ccapi->checks()->validate('CHECK_ID', ['outcome' => 'rejected']);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;
var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var checkRequest = new CheckOutcomeRequest
{
outcome = "rejected",
matchId = "MATCH_ID"
};
var checkOutcome = await checkApi.ValidateAsync("CHECK_ID", checkRequest);

Validation per check type

Standard and Extensive Screening Checks

Resulting Check Outcome
Description
clear
Upon having all matches rejected, the outcome will be set to clear.
attention
The outcome will remain as attention unless all matches have been rejected or a match has been confirmed.
match_confirmed
When any match is confirmed, the outcome of the check will be changed to match_confirmed.

Document and Identity Checks

Resulting Check Outcome
Description
clear
When the validation outcome is set to confirmed, the check outcome will be changed to clear.
rejected
When the validation outcome is set to rejected, the check outcome will be changed to rejected.
attention
When the validation outcome is set to attention, the check outcome will be changed to attention.