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": {}
}
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": {}
}
POST https://api.parcha.ai/startKYBAgentJob
Show KYB Schema Properties
Show Common Object Types
Show Address Properties
Show Document Properties
Show Self Attested Data Properties
Show Associated Individual Properties
Show Individual Data Properties
Show Associated Entity Properties
Show Entity Data Properties
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.Show Job Properties
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"
}
}
}'
{
"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"
}
}
}
}
}
job_id
already exists:
{
"error": "Job with the provided ID already exists.",
"job_id": "your-custom-job-id-123e4567-e89b-12d3-a456-426614174001"
}
JWT token obtained from the authentication endpoint
Job started successfully
The response is of type object
.