Skip to main content
POST
/
runCheck
Run a check
curl --request POST \
  --url https://api.parcha.ai/api/v1/runCheck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_key": "<string>",
  "check_id": "<string>",
  "case_id": "<string>",
  "check_args": {}
}
'

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
agent_key
string
required

The unique identifier for the agent

​
check_id
string
required

The ID of the check to run

​
case_id
string
required

The ID of the case

​
case_type
enum<string>
required

The type of case

Available options:
kyb,
kyc,
entity
​
check_args
object

Additional arguments for the check

Response

Check started successfully