POST
/
startKYCAgentJob
curl --request POST \
  --url https://demo.parcha.ai/api/v1/startKYCAgentJob \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_key": "<string>",
  "check_ids": [
    "<string>"
  ],
  "kyc_schema": {
    "id": "<string>",
    "self_attested_data": {
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "name_prefix": "<string>",
      "name_suffix": "<string>",
      "date_of_birth": "2023-12-25",
      "address": {
        "street_1": "<string>",
        "street_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>"
      },
      "associated_addresses": [
        {
          "street_1": "<string>",
          "street_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country_code": "<string>",
          "postal_code": "<string>"
        }
      ],
      "country_of_nationality": "<string>",
      "country_of_residence": "<string>",
      "place_of_birth": "<string>",
      "sex": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "title": "<string>",
      "is_applicant": true,
      "is_business_owner": true,
      "business_ownership_percentage": 123,
      "proof_of_address_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ],
      "source_of_funds_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ]
    }
  }
}'
{
  "status": "ok",
  "job_id": "<string>",
  "message": "<string>",
  "job": {}
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

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)

​
kyc_schema
object

Response

200
application/json
Job started successfully
​
status
enum<string>
Available options:
ok,
failed,
mock_success
​
job_id
string | null
​
message
string
​
job
object | null