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

This endpoint allows you to run a specific check for either Know Your Business (KYB) or Know Your Customer (KYC) processes.

​
API Endpoint

GET https://api.parcha.ai/api/v1/getChecksOverviewData

​
Request Body

​
agent_key
string
required

The unique identifier for the agent to be used for the check.

​
Response

An array of checks and their aggregated data.

​
Example Request

curl -X POST 'https://api.parcha.ai/getChecksOverviewData' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
  "agent_key": "agent-key-value"
}'

​
Example Response

[
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.addresses_check",
    "command_name": "Addresses Check",
    "total": 1,
    "total_passed_true": 1,
    "total_passed_false": 0,
    "total_thumbs_up": 1,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  },
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.basic_business_profile_check",
    "command_name": "Basic Profile Check",
    "total": 1,
    "total_passed_true": 1,
    "total_passed_false": 0,
    "total_thumbs_up": 0,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  },
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.business_owners_check",
    "command_name": "Business Owners Check",
    "total": 2,
    "total_passed_true": 2,
    "total_passed_false": 0,
    "total_thumbs_up": 2,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Query Parameters

​
agent_key
string
required

Response

200

Checks overview data retrieved successfully

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

This endpoint allows you to run a specific check for either Know Your Business (KYB) or Know Your Customer (KYC) processes.

​
API Endpoint

GET https://api.parcha.ai/api/v1/getChecksOverviewData

​
Request Body

​
agent_key
string
required

The unique identifier for the agent to be used for the check.

​
Response

An array of checks and their aggregated data.

​
Example Request

curl -X POST 'https://api.parcha.ai/getChecksOverviewData' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
  "agent_key": "agent-key-value"
}'

​
Example Response

[
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.addresses_check",
    "command_name": "Addresses Check",
    "total": 1,
    "total_passed_true": 1,
    "total_passed_false": 0,
    "total_thumbs_up": 1,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  },
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.basic_business_profile_check",
    "command_name": "Basic Profile Check",
    "total": 1,
    "total_passed_true": 1,
    "total_passed_false": 0,
    "total_thumbs_up": 0,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  },
  {
    "agent_key": "agent-key-value",
    "command_id": "kyb.business_owners_check",
    "command_name": "Business Owners Check",
    "total": 2,
    "total_passed_true": 2,
    "total_passed_false": 0,
    "total_thumbs_up": 2,
    "total_thumbs_down": 0,
    "total_comments": 0,
    "accuracy_percentage": 1.0
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Query Parameters

​
agent_key
string
required

Response

200

Checks overview data retrieved successfully