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 a Persona KYC job
curl --request POST \
--url https://demo.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": "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>"
}
]
}
}
}'{
"status": "ok",
"job_id": "<string>",
"message": "<string>",
"job": {}
}Authorizations
JWT token obtained from the authentication endpoint
Body
A unique id specific to the account being analyzed
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
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
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
Base64 encoded document content
Name of the document file
Source type of the document
Base64 encoded document content
Name of the document file
Source type of the document
curl --request POST \
--url https://demo.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": "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>"
}
]
}
}
}'{
"status": "ok",
"job_id": "<string>",
"message": "<string>",
"job": {}
}