API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
  • Clients
    • Create a client
    • Get a client
    • Update a client
    • Delete a client
    • List clients
    • Filtering clients
  • Addresses
    • Create an address
    • Get an address
    • Update an address
    • Delete an address
    • List addresses
    • Filtering addresses
  • Documents
    • Create a document
    • Get a document
    • Update a document
    • Upload image attachment
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page
  • Validate check outcome
  • Example request
  • Validation per check type

Was this helpful?

  1. Checks

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.

{
    "outcome": "rejected"
}

Example request

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($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.

PreviousUpdate a checkNextList checks

Last updated 4 years ago

Was this helpful?