What's the difference between a check `decision` and `result`? (API)

When you run a check, a decision and a result are both returned in the response.

What are `decision` and `result`?

The result is a precise outcome of the check. It may be common across several check types or it may be specific to one check type.

For example, the DOCUMENT_FETCH check and the VISA_CHECK can both return a result of Pass while the IDENTITY_CHECK is the only check type that can return a result of 2+2 or 1+1.

The decision is a way to unify all check results into high-level categories, which makes it easier to action them.

All checks, regardless of type, can have these values for decision: PASS, FAIL, PARTIAL, WARN, and ERROR.

To learn which check results can be returned for each check type, see the Responses for Run a check in the Developer Resources.

How does `result` affect `decision`?

The check result always has a direct impact on the decision.

See the table below for an example of how the decisions map to different check results.

Decision

Result:

IDENTITY_CHECK

Result: 

DOCUMENT_FETCH

Result:

PEPS_AND_SANCTIONS_SCREEN

PASS

2+1

Pass

Pass

PARTIAL

1+1

--

--

FAIL

Fail

Fail

--

WARN

--

--

PEP, Sanction, Media, or Refer

ERROR

Error

Error

Error

The table above shows checks with their default configurations.

How do configuration options affect `decision`?

The decision can also be affected by the configuration options you're using.

For example, by default, the IDENTITY_CHECK will return a decision of PASS when the check result is 2+2 and PARTIAL when the result is 1+1, However, you can configure the check to return a decision of pass when the result is 1+1.

To find out which configuration options can be applied to your check variant, see the configuration article for your data provider.


How did we do?


Powered by HelpDocs (opens in a new tab)