Validate check outcome

Validate check outcome

POST https://api.complycube.com/v1/checks/:id/validate

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.

Path Parameters

Name	Type	Description
id	string	The ID of the check.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authentication	string	The API live or test key

Request Body

Name	Type	Description
outcome	string	The validation outcome. Valid values include: 1. confirmed 2. rejected 3. pending See the validation per check type table below to learn how each can affect the check outcome.
matchId	string	The match ID. This is required for checks of type standard_screening_check and extensive_screening_check.
comment	string	A comment that can be associated with the validation. This can be up to 4,000 characters long.

200 Check validated successfully.

{
    "outcome": "rejected"
}

Example request

cURL

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."
        }'

Node.js

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"
});

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

check = cc_api.checks.validate('CHECK_ID',outcome='rejected',comment='my comment')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$check = $ccapi->checks()->validate($id, ['outcome' => 'rejected']);

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.