API Reference
Run a check
Getting Started
Checks Results
- Check Result Object
- Business (KYB) Checks
- Individual (KYC) Checks
API Reference
- POSTStart a KYB agent job
- POSTStart a KYC agent job
- GETGet job by ID
- GETGet jobs by case ID
- POSTRun a check
- POSTUpload base64 document
- GETGet feedback inputs by key
- POSTSend feedback
- POSTTest webhook
- POSTTest webhook receiver
- POSTDownload report
- POSTGenerate report to Google Drive
- POSTGenerate bulk case reports
- GETExport CSV batch
- GETGet job batches
- GETGet batch jobs
- POSTEnqueue jobs from CSV
- POSTRun flash check
- GETGet checks overview data
- POSTStart a Persona KYB job
- POSTStart a Persona KYC job
API Reference
Run a check
POST
/
runCheck
curl --request POST \
--url https://demo.parcha.ai/api/v1/runCheck \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_id": "<string>",
"case_id": "<string>",
"case_type": "kyb",
"check_args": {}
}'
Authorizations
JWT token obtained from the authentication endpoint
Body
application/json
Response
200
Check started successfully
curl --request POST \
--url https://demo.parcha.ai/api/v1/runCheck \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_id": "<string>",
"case_id": "<string>",
"case_type": "kyb",
"check_args": {}
}'