This endpoint starts a KYB (Know Your Business) agent job with the specified parameters.

​
API Endpoint

POST https://api.parcha.ai/startKYBAgentJob

​
Request Body

agent_key
string
required

The unique identifier for the agent to be used for the KYB job.

kyb_schema
object
required

The KYB schema containing the business information.

webhook_url
string

An optional URL to receive webhook notifications about the job status.

slack_webhook_url
string

An optional Slack webhook URL to receive notifications about the job status.

check_ids
array

An optional array of specific check IDs to run. If not provided, all checks will be run.

run_in_parallel
boolean
default: false

Whether to run the checks in parallel. Defaults to false.

​
Response

status
string

The status of the job creation request. Will be “ok” if successful.

job_id
string

The unique identifier for the created job.

message
string

A message indicating the result of the job creation request.

job
object

Details about the created job.

​
Example Request

​
Example Response

{
  "status": "ok",
  "job_id": "job-12345-abcde",
  "message": "The job was successfully added to the queue.",
  "job": {
    "id": "job-12345-abcde",
    "status": "PENDING",
    "created_at": "2023-06-15T10:30:00Z",
    "updated_at": "2023-06-15T10:30:00Z",
    "agent_id": "public-bdd",
    "input_payload": {
      "agent_key": "public-bdd",
      "kyb_schema": {
        "id": "parcha-demo-case-001",
        "self_attested_data": {
          "business_name": "Acme Corp",
          "website": "https://www.acmecorp.com"
        }
      },
      "run_in_parallel": true
    }
  }
}

This endpoint initiates a KYB agent job with the provided parameters. The response includes a job ID that can be used to track the progress and retrieve results of the KYB process.

AuthenticationStartKYCAgentJob