Understanding Check Results

Interpreting and understanding the full set of results that can come back from checks requires a lot more context than what we can give in the API Reference . This section attempts to redress that with a more detailed discussion of check results. It is constantly growing and evolving and we welcome suggestions for more example flows or deeper discussions on results.

Overview

Whenever you run an /entity/verify process against an individual, you’ll be returned a highly detailed response that covers the wide variety of checks that can be performed.

This same result set will also be returned if you query GET /entity/{id}/checks as well.

The result set is broken down into sections, each of which provide details around a check type or family of check types. Various forms of summary information are provided as well.

It should also be noted that when you run a verification check against an entity, the result will not only return the details of the latest check, but will also factor in still-relevant data of previous checks too, to provide a comprehensive picture of the entity.

The following pages will break down the various sections that can be found in the “CheckEntityCheckResultsObject” (see the API Reference for details).

🚧

The Process Result Object

Before jumping in, it is worth reading the overview of one of the workhorse structures of the API result sets: The ProcessResultObject

The CheckEntityCheckResultsObject

This is the object that is returned from all /entity/verify and /entity/checks calls. It is broken down into the following sub-structures:

Other Results

Not all checks get their own dedicated section of the result structure, but are found inside their related result sections. These are looked individually below:


Did this page help you?