Skip to main content
POST
Start a KYB agent job

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_ids
string[]

The check IDs to run (runs all checks in agent configuration if not provided)

kyb_schema
object

Response

Job started successfully

status
enum<string>
Available options:
ok,
failed,
mock_success
job_id
string | null
message
string
job
object | null