Start KYB Agent Job

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.

string

required

A unique identifier for this KYB case.

self_attested_data

object

required

Self-attested information about the business.

business_name

string

The name of the business. Required if website is not provided.

registered_business_name

string

The registered name of the business. Required if website is not provided and business_name is not set.

address_of_operation

object

The business’s operational address. Uses the Address Object format defined above.

address_of_incorporation

object

The business’s incorporation address. Uses the Address Object format defined above.

website

string

The website of the business. Required if business_name or registered_business_name is not provided.

business_purpose

string

The primary purpose or activity of the business.

description

string

A brief description of the business. Maximum 512 characters.

industry

string

The industry sector the business operates in.

tin_number

string

Tax Identification Number or Employer Identification Number (EIN).

incorporation_date

string

Date of incorporation in YYYY-MM-DD format.

partners

array

Array of business partner names.

customers

array

Array of customer names.

source_of_funds

array

Array of funding sources (e.g., [“Investment”, “Revenue”]).

incorporation_documents

array

Array of incorporation document objects. Each item uses the Document Object format defined above.

business_ownership_documents

array

Array of ownership document objects. Each item uses the Document Object format defined above.

Array of promotional/marketing document objects. Each item uses the Document Object format defined above.

proof_of_address_documents

array

Array of address proof document objects. Each item uses the Document Object format defined above.

ein_documents

array

Array of EIN document objects. Each item uses the Document Object format defined above.

source_of_funds_documents

array

Array of funding source document objects. Each item uses the Document Object format defined above.

associated_individuals

array

Array of individuals associated with the business.

associated_entities

array

Array of entities associated with the business.

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.

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"
        }
      }
    }
  }
}

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.

API Reference

Checks Results

API Endpoint

Request Body

Response

Example Request

Example Response

API Reference

Checks Results

​API Endpoint

​Request Body

​Response

​Example Request

​Example Response

API Endpoint

Request Body

Response

Example Request

Example Response