StartKYCAgentJob
Initiate a Know Your Customer (KYC) agent job
This endpoint starts a KYC (Know Your Customer) agent job with the specified parameters.
API Endpoint
POST https://api.parcha.ai/startKYCAgentJob
Request Body
The unique identifier for the agent to be used for the KYC job.
The KYC schema containing the individual’s information.
An optional URL to receive webhook notifications about the job status.
An optional Slack webhook URL to receive notifications about the job status.
An optional array of specific check IDs to run. If not provided, all checks will be run.
Whether to run the checks in parallel. Defaults to false.
Response
The status of the job creation request. Will be “ok” if successful.
The unique identifier for the created job.
A message indicating the result of the job creation request.
Details about the created job.
Example Request
Example Response
{
"status": "ok",
"job_id": "job-67890-fghij",
"message": "The job was successfully added to the queue.",
"job": {
"id": "job-67890-fghij",
"status": "PENDING",
"created_at": "2023-06-15T14:30:00Z",
"updated_at": "2023-06-15T14:30:00Z",
"agent_id": "kyc-standard-check",
"input_payload": {
"agent_key": "kyc-standard-check",
"kyc_schema": {
"id": "parcha-kyc-demo-001",
"self_attested_data": {
"first_name": "Jane",
"last_name": "Doe",
"date_of_birth": "1990-01-01",
"address": {
"street_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"country_code": "US",
"postal_code": "12345"
},
"country_of_nationality": "US",
"country_of_residence": "US",
"email": "jane.doe@example.com",
"phone": "+1234567890"
}
},
"webhook_url": "https://your-webhook.com/kyc-updates",
"run_in_parallel": true
}
}
}
This endpoint initiates a KYC 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 KYC process.