Get Specific Check Result

Get a specific check result from job

curl --request GET \
  --url https://api.parcha.ai/api/v1/getCheckResultFromJob \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.parcha.ai/api/v1/getCheckResultFromJob', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parcha.ai/api/v1/getCheckResultFromJob",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parcha.ai/api/v1/getCheckResultFromJob"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.parcha.ai/api/v1/getCheckResultFromJob")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

GET

getCheckResultFromJob

Get a specific check result from job

curl --request GET \
  --url https://api.parcha.ai/api/v1/getCheckResultFromJob \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.parcha.ai/api/v1/getCheckResultFromJob', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.parcha.ai/api/v1/getCheckResultFromJob",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.parcha.ai/api/v1/getCheckResultFromJob"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.parcha.ai/api/v1/getCheckResultFromJob")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

This endpoint retrieves the full result of a specific check from a completed job, including all evidence and detailed findings.

Endpoint

GET /getCheckResultFromJob

When to Use This Endpoint

Use this endpoint when you need to:

Fetch the complete result for a specific check (e.g., sanctions screening, PEP check)
Get evidence and detailed findings that may not be included in the standard job response
Retrieve results for a specific entity in a multi-entity job (like KYB jobs with associated individuals)

For the overall job status and all check results, use getJobById with include_check_results=true instead.

Parameters

string

required

The unique identifier of the job. You receive this when you start a job or from a webhook notification.

string

required

The check type identifier (also called command_id). This identifies which type of check to retrieve.Examples:

kyb.sanctions_screening_check_v2
kyb.adverse_media_screening_check_v2
kyc.pep_screening_check_v2
kyb.incorporation_document_verification

This is the stable check identifier, not command_instance_id which changes with each job run.

string

required

Identifies which entity the check was run against. This is especially important for jobs that process multiple entities (e.g., a business with associated individuals).You can find this value in the check results from getJobById response as agent_instance_id.

For single-entity jobs, all checks will have the same agent_instance_id. For multi-entity jobs (like KYB with associated individuals), each entity will have its own agent_instance_id.

string

required

The type of the case. Use "kyb" for business checks or "kyc" for individual checks.

boolean

default:"true"

Whether to include status messages showing the check’s progress history in the response.

Response

array

An array of source identifiers used in the check.

object

The full check result object. Structure may vary based on the type of check.

Error Responses

string

A description of the error that occurred.

Status Code	Description
404	Job or check result not found
403	Unauthorized access to agent
500	Internal server error

Example Request

curl -X GET 'https://api.parcha.ai/api/v1/getCheckResultFromJob?job_id=e85e0cc4-b1e8-40b0-9a3d-83c328eee0f4&check_id=kyb.sanctions_screening_check_v2&agent_instance_id=09e3133959c447b493313b1b3360cc05&case_type=kyb' \
-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "command_id": "kyb.sanctions_screening_check_v2",
  "command_name": "KYB Sanctions Screening Check",
  "command_desc": "Tool used to screen a business against sanctions watchlists",
  "command_instance_id": "a5494583409b41d587cd753b686bcf43",
  "agent_instance_id": "09e3133959c447b493313b1b3360cc05",
  "status": "complete",
  "output": {
    "explanation": "The business was screened against multiple sanctions databases and no matches were found.",
    "payload": {
      "type": "SanctionsWatchlistScreeningCheckResult",
      "verified_sanctions_hits": [],
      "passed": true
    },
    "passed": true,
    "answer": "No sanctions matches found for this business.",
    "recommendation": null,
    "alerts": {}
  },
  "evidence": [
    {
      "source": "OFAC SDN List",
      "searched_name": "Parcha Labs Inc",
      "match_count": 0
    }
  ],
  "sources": ["OFAC SDN", "UN Sanctions", "EU Consolidated List"],
  "created_at": "2023-06-15T10:30:00Z",
  "updated_at": "2023-06-15T10:35:00Z"
}

Authorizations

Authorization

string

header

required

API key obtained from your Parcha account settings. Include as Bearer token in the Authorization header.

Query Parameters

job_id

string

required

The unique identifier of the job

agent_instance_id

string

required

The unique identifier of the agent instance

check_id

string

required

The unique identifier of the check

case_type

enum<string>

required

The type of the case

Available options:

kyb,

kyc,

entity

include_status_messages

boolean

default:true

Whether to include status messages in the response

Response

Check result retrieved successfully

⌘I

Getting Started

Checks Results

API Reference

Endpoint

When to Use This Endpoint

Parameters

Response

Error Responses

Example Request

Example Response

Authorizations

Query Parameters

Response

​Endpoint

​When to Use This Endpoint

​Parameters

​Response

​Error Responses

​Example Request

​Example Response

Authorizations

Query Parameters

Response

Endpoint

When to Use This Endpoint

Parameters

Response

Error Responses

Example Request

Example Response