API Reference
Start a KYB agent job
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
API Reference
Start a KYB agent job
POST
/
startKYBAgentJob
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": {}
}
Authorizations
JWT token obtained from the authentication endpoint
Body
application/json
Response
200
application/json
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": {}
}