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 KYC Agent Job
Initiate a Know Your Customer (KYC) agent job
curl --request POST \
--url https://demo.parcha.ai/api/v1/startKYCAgentJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_ids": [
"<string>"
],
"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": {}
}This endpoint starts a KYC (Know Your Customer) agent job with the specified parameters.
API Endpoint
POST https://api.parcha.ai/startKYCAgentJob
Request Body
The unique identifier for the agent to be used for the KYC job.
The KYC schema containing the individual’s information.
A unique identifier for this KYC case.
Self-attested information about the individual.
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 individual’s first name
The individual’s middle name
The individual’s last name
The individual’s date of birth in YYYY-MM-DD format
The individual’s address. Uses the Address Object format defined above.
Array of associated addresses for the individual. Each item 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
Array of address proof document objects. Each item uses the Document Object format defined above.
Government ID verification data.
First name as shown on ID
Last name as shown on ID
Middle names as shown on ID
Date of birth in YYYY-MM-DD format
Type of ID document (e.g., “Driver’s License”, “Passport”)
ID document number
Address shown on ID. Uses the Address Object format defined above.
Country that issued the ID
Phone number on ID
URL to front image of ID
URL to back image of ID
URL to face match image
URL to face match video
Name of ID verification vendor
URL to vendor’s verification page
Whether vendor validated the document
Vendor-specific verification data
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”).
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/startKYCAgentJob' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"agent_key": "kyc-standard-check",
"kyc_schema": {
"id": "parcha-kyc-demo-001",
"self_attested_data": {
"first_name": "Jane",
"last_name": "Doe"
}
}
}'
Example Response
{
"status": "ok",
"job_id": "job-67890-fghij",
"message": "The job was successfully added to the queue.",
"job": {
"id": "job-67890-fghij",
"status": "PENDING",
"created_at": "2023-06-15T14:30:00Z",
"updated_at": "2023-06-15T14:30:00Z",
"agent_id": "kyc-standard-check",
"input_payload": {
"agent_key": "kyc-standard-check",
"kyc_schema": {
"id": "parcha-kyc-demo-001",
"self_attested_data": {
"first_name": "Jane",
"last_name": "Doe"
}
},
"webhook_url": "https://your-webhook.com/kyc-updates"
}
}
}
This endpoint initiates a KYC 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 KYC process.
Authorizations
JWT token obtained from the authentication endpoint
Body
The unique identifier for the agent
The check IDs to run (runs all checks in agent configuration if not provided)
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/startKYCAgentJob \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent_key": "<string>",
"check_ids": [
"<string>"
],
"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": {}
}