Check Result Object

When you fetch the results of a Job using the /getJobById or /getJobByCaseId endpoint, the response will contain a check result object with metadata about the check execution and a check-specific payloads for each check that was run. You can find the results of a specific check by filtering the command_name in the response.

agent_key

string

The unique identifier of the agent.

agent_instance_id

string

The unique identifier for this instance of the agent.

command_id

string

The unique identifier of the command.

command_name

string

The name of the command.

command_desc

string

A description of what the command does.

command_instance_id

string

The unique identifier for this instance of the command.

data_loader_id

string | null

The identifier of the data loader used, if any.

job_id

string

The identifier of the job this check result belongs to.

created_at

string

The timestamp when the check result was created.

updated_at

string

The timestamp when the check result was last updated.

data_loader_start_time

string | null

The timestamp when the data loader started, if applicable.

data_loader_end_time

string | null

The timestamp when the data loader finished, if applicable.

check_start_time

string | null

The timestamp when the check started.

check_end_time

string | null

The timestamp when the check finished.

result_type

string

The type of result, typically “CommandResult”.

status

string

The current status of the check result (e.g., “pending”, “complete”, “failed”).

step_number

number | null

The step number in the workflow, if applicable.

input_data

object

The input data used for the check.

verification_data

object

The verification data used for the check. Input data will be compared against this data.

passed

boolean

Whether the check passed.

answer

string

A human-readable summary of the check result.

explanation

string

A detailed explanation of what was checked and how the result was determined.

payload

object

Check-specific result data. The structure of this object varies depending on the type of check that was run. See the individual check result documentation for details:

alerts

object

An object containing any alerts or warnings generated during the check.

recommendation

string | null

A recommended action based on the check result.

instructions

string | null

Any instructions related to the check.

follow_up

string | null

Any follow-up actions that should be taken.

evidence

object | null

Any evidence collected during the check.

error

string | null

Any error that occurred during the check.

status_messages

array

An array of status messages emitted during the execution of the check.

Example Response

{
    "jobs": [
        {
            "id": "539108a4-3a19-4ecf-88d0-a6468194cedc",
            ...
            "check_results": [
                /* list of check_result objects */
                {
                    /* general info */
                    "agent_key": "agent-kyb-v1",
                    "agent_instance_id": "9db890b9-2d9d-4e4f-a802-18ecef5d72b3",
                    "command_id": "kyb.incorporation_document_verification",
                    "command_name": "Incorporation Document Check",
                    "command_desc": "A tool to verify a business registration/formation documents provided by applicant and extracting relevant data",
                    "command_instance_id": "b3a753c2-500f-4043-93e4-802554635213",
                    "data_loader_id": null,
                    "job_id": "539108a4-3a19-4ecf-88d0-a6468194cedc",
                    "created_at": "2024-11-08T20:19:47.959210",
                    "updated_at": "2024-11-08T20:21:40.430984",
                    "data_loader_start_time": "2024-11-08T20:19:49.046128",
                    "data_loader_end_time": "2024-11-08T20:21:02.267585",
                    "check_start_time": "2024-11-08T20:21:02.299008",
                    "check_end_time": "2024-11-08T20:21:40.372310",
                    "result_type": "CommandResult",
                    "status": "complete",
                    "step_number": null,

                    /* check result specific info */
                    "input_data": { input data },
                    "verification_data": { verification data },
                    "passed": false,
                    "answer": "The business registration verification has failed due to critical discrepancies in the registration number, high-risk fraud indicators, and failed visual inspection of the provided document.",
                    "explanation": "This task involves verifying the business registration information provided by the applicant against the documented incorporation information extracted from the submitted documents.",
                    "payload": { check output },
                    "alerts": {
                        "registration_number": "The self-attested registration number does not match the documented number.",
                    },
                    "recommendation": "Failed",
                    "instructions": null,
                    "follow_up": "",
                    "evidence": null,
                    "error": null,

                    /* status messages emitted during the execution of the check */
                    "status_messages": [
                        { status message },
                        ...
                    ]
                },
                ...
            ]
        },
        ...
    ],
    "count": 4
}

API Reference

Checks Results

Example Response

API Reference

Checks Results

​Example Response

Example Response