Getting Started
Checks Results
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
- GETGet a specific check result from job
- GETGet check all results for a job
- GETGet source contents
- GETGet all sources for an agent instance
- GETGet job metadata
- GETGet job metadata by job ID
- GETGet job metadata by case ID
- GETGet job status summary
- GETGet latest application state
- GETGet available checks
- GETGet check information
- POSTUpdate application status
- POSTMap CSV columns to schema fields
- POSTEnqueue jobs from various sources
- POSTExtract KYB schemas from source
- POSTEnqueue KYB schemas as jobs
- GETGet available checks with filtering
- GETGet thinking for a command instance
- GETGet agent cost estimate
- POSTGet agent configuration cost estimate
- POSTEnrich person data
- POSTEnrich company data
- POSTScrape using specialized scrapers
- GETGet agent configuration
- GETGet agent schemas
- POSTStart a Persona KYB job
- POSTStart a Persona KYC job
curl --request POST \
--url https://api.parcha.ai/api/v1/startPersonaKYCJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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": "[email protected]",
"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": {}
}Start a Persona KYC job
curl --request POST \
--url https://api.parcha.ai/api/v1/startPersonaKYCJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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": "[email protected]",
"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
API key obtained from your Parcha account settings. Include as Bearer token in the Authorization header.
Body
Show child attributes
Show child attributes
A unique id specific to the account being analyzed
Show child attributes
Show child attributes
The first name of the individual
The middle name of the individual
The last name of the individual
The prefix of the individual
The suffix of the individual
The date of birth of the individual, format YYYY-MM-DD
Show child attributes
Show child attributes
Primary street address line
Secondary street address line (optional)
City name
State/province code
Two-letter ISO country code (e.g., "US", "GB")
Postal/ZIP code
The associated addresses of the individual
Show child attributes
Show child attributes
Primary street address line
Secondary street address line (optional)
City name
State/province code
Two-letter ISO country code (e.g., "US", "GB")
Postal/ZIP code
The country of nationality of the individual
The country of residence of the individual
The place of birth of the individual
The sex of the individual
The email of the individual
The phone number of the individual
The title of the individual
Whether this individual is the applicant
Whether this individual is a business owner
The percentage of business ownership
Show child attributes
Show child attributes
Base64 encoded document content
Name of the document file
Source type of the document
Show child attributes
Show child attributes
Base64 encoded document content
Name of the document file
Source type of the document