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
Start KYB Agent Job
Initiate a Know Your Business (KYB) agent job
curl --request POST \
--url https://demo.parcha.ai/api/v1/startKYBAgentJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_ids": [
"<string>"
],
"kyb_schema": {
"id": "<string>",
"self_attested_data": {
"business_name": "<string>",
"registered_business_name": "<string>",
"address_of_incorporation": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"address_of_operation": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"website": "<string>",
"business_purpose": "<string>",
"description": "<string>",
"industry": "<string>",
"tin_number": "<string>",
"incorporation_date": "2023-12-25",
"partners": [
"<string>"
],
"customers": [
"<string>"
],
"source_of_funds": [
"<string>"
],
"incorporation_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"business_ownership_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"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>"
}
],
"ein_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"cannabis_license_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
]
},
"external_validation_data": {},
"research_data": {},
"associated_individuals": [
{
"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>"
}
]
}
}
],
"associated_entities": [
{
"self_attested_data": {
"business_name": "<string>",
"business_ownership_percentage": 123,
"is_business_owner": true
}
}
]
}
}'{
"status": "ok",
"job_id": "<string>",
"message": "<string>",
"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
The unique identifier for the agent to be used for the KYB job.
The KYB schema containing the business information.
A unique identifier for this KYB case.
Self-attested information about the business.
Standard address format used throughout the schema.
Standard document format used throughout the schema.
URL to access the document. Required if b64_document is not provided.
Name of the file including extension
Type of document source. Currently supported: “file_url”
Base64 encoded document content. Required if url is not provided.
The name of the business. Required if website is not provided.
The registered name of the business. Required if website is not provided and business_name is not set.
The business’s operational address. Uses the Address Object format defined above.
The business’s incorporation address. Uses the Address Object format defined above.
The website of the business. Required if business_name or registered_business_name is not provided.
The primary purpose or activity of the business.
A brief description of the business. Maximum 512 characters.
The industry sector the business operates in.
Tax Identification Number or Employer Identification Number (EIN).
Date of incorporation in YYYY-MM-DD format.
Array of business partner names.
Array of customer names.
Array of funding sources (e.g., [“Investment”, “Revenue”]).
Array of incorporation document objects. Each item uses the Document Object format defined above.
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.
Array of address proof document objects. Each item uses the Document Object format defined above.
Array of EIN document objects. Each item uses the Document Object format defined above.
Array of funding source document objects. Each item uses the Document Object format defined above.
Array of individuals associated with the business.
Unique identifier for the individual.
Individual’s first name
Individual’s middle name
Individual’s last name
Date of birth in YYYY-MM-DD format
Individual’s address. Uses the Address Object format defined above.
Two-letter ISO country code of nationality
Two-letter ISO country code of residence
Place of birth (city, country)
Individual’s sex
Email address
Phone number
Job title or position
Whether this individual is the applicant
Whether this individual is a business owner
Percentage of business ownership
Array of address proof document objects. Each item uses the Document Object format defined above.
Array of entities associated with the business.
Unique identifier for the entity
Name of the associated business
Whether the entity is a trust
Entity’s address. Uses the Address Object format defined above.
Industry sector
Tax Identification Number
Percentage of business ownership
Two-letter ISO country code
Entity’s website
Description of the entity
Optional. A unique identifier (UUID) that you can provide for this job.
If provided, this ID will be used as an idempotency key.
If a job with this ID already exists, the API will return a 409 Conflict error, and you can then use this job_id to retrieve the existing job’s status and results using /getJobById.
If not provided, a new unique ID will be automatically generated for the job.
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.
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.
The unique identifier of the job.
The current status of the job (e.g., “PENDING”, “RUNNING”, “COMPLETE”, “FAILED”, “RETRIED”).
The timestamp when the job was created.
The timestamp when the job was last updated.
The ID of the agent used for this job.
The input payload provided for the job.
Example Request
curl -X POST 'https://api.parcha.ai/startKYBAgentJob' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"agent_key": "public-bdd",
"job_id": "your-custom-job-id-123e4567-e89b-12d3-a456-426614174001",
"kyb_schema": {
"id": "parcha-demo-case-001",
"self_attested_data": {
"business_name": "Acme Corp",
"website": "https://www.acmecorp.com"
}
}
}'
Example Response
Successful creation (200 OK):
{
"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"
}
}
}
}
}
Conflict (409 Conflict) if job_id already exists:
{
"error": "Job with the provided ID already exists.",
"job_id": "your-custom-job-id-123e4567-e89b-12d3-a456-426614174001"
}
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.
Authorizations
JWT token obtained from the authentication endpoint
Body
Response
Job started successfully
The response is of type object.
curl --request POST \
--url https://demo.parcha.ai/api/v1/startKYBAgentJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_ids": [
"<string>"
],
"kyb_schema": {
"id": "<string>",
"self_attested_data": {
"business_name": "<string>",
"registered_business_name": "<string>",
"address_of_incorporation": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"address_of_operation": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"website": "<string>",
"business_purpose": "<string>",
"description": "<string>",
"industry": "<string>",
"tin_number": "<string>",
"incorporation_date": "2023-12-25",
"partners": [
"<string>"
],
"customers": [
"<string>"
],
"source_of_funds": [
"<string>"
],
"incorporation_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"business_ownership_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"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>"
}
],
"ein_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
],
"cannabis_license_documents": [
{
"b64_document": "<string>",
"file_name": "<string>",
"source_type": "<string>"
}
]
},
"external_validation_data": {},
"research_data": {},
"associated_individuals": [
{
"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>"
}
]
}
}
],
"associated_entities": [
{
"self_attested_data": {
"business_name": "<string>",
"business_ownership_percentage": 123,
"is_business_owner": true
}
}
]
}
}'{
"status": "ok",
"job_id": "<string>",
"message": "<string>",
"job": {}
}