This endpoint allows you to run a specific check for either Know Your Business (KYB) or Know Your Customer (KYC) processes.
API Endpoint Request Body The unique identifier for the agent to be used for the check.
The identifier of the specific check you want to run.
The KYB schema containing the information for business verification checks.
Standard address format used throughout the schema.
Primary street address line
Secondary street address line (optional)
Two-letter ISO country code (e.g., “US”, “GB”)
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
Description of the document
Type of document source. One of: “file_url”, “gdrive”, “dropbox”, etc.
Base64 encoded document content. Required if url is not provided.
Number of pages in the document
Show KYB Schema Properties
A unique identifier for this check case.
The registered name of the business
The address where the business is incorporated. Uses the Address Object format defined above.
The address of primary business operations. Uses the Address Object format defined above.
The website(s) of the business
Description of the business
The industry of the business
The tax identification number
Business partners that should be screened
Customers that should be screened
The source of funds for the business
List of countries where the business has customers
The incorporation date in YYYY-MM-DD format
business_registration_number
The business registration number
The cannabis license number (if applicable)
The MCC code of the business
The contact email for the business
The contact phone number for the business
List of incorporation documents. Each item uses the Document Object format defined above.
business_ownership_documents
List of business ownership documents. Each item uses the Document Object format defined above.
promo_marketing_documents
List of promotional/marketing documents. Each item uses the Document Object format defined above.
proof_of_address_documents
List of proof of address documents. Each item uses the Document Object format defined above.
source_of_funds_documents
List of source of funds documents. Each item uses the Document Object format defined above.
List of EIN documents. Each item uses the Document Object format defined above.
cannabis_license_documents
List of cannabis license documents. Each item uses the Document Object format defined above.
List of bank check documents. Each item uses the Document Object format defined above.
The KYC schema containing the information for individual verification checks.
Standard address format used throughout the schema.
Primary street address line
Secondary street address line (optional)
Two-letter ISO country code (e.g., “US”, “GB”)
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
Description of the document
Type of document source. One of: “file_url”, “gdrive”, “dropbox”, etc.
Base64 encoded document content. Required if url is not provided.
Number of pages in the document
Show KYC Schema Properties
A unique identifier for this check case.
The first name of the individual
The middle name of the individual
The last name of the individual
The prefix of the individual (e.g., “Mr.”, “Mrs.”, “Dr.”)
The suffix of the individual (e.g., “Jr.”, “Sr.”, “III”)
The date of birth of the individual in YYYY-MM-DD format
The address of the individual. Uses the Address Object format defined above.
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 address of the individual
The phone number of the individual
The job title of the individual
The LinkedIn profile URL of the individual
The current employer of the individual
The industry of the current employer
Whether the individual is an applicant
Whether the individual is a business owner
business_ownership_percentage
The percentage of business ownership (if applicable)
source_of_funds_description
Description of the source of funds
source_of_funds_documents
List of source of funds documents. Each item uses the Document Object format defined above.
proof_of_address_documents
List of proof of address documents. Each item uses the Document Object format defined above.
An optional URL to receive webhook notifications about the check status.
Optional arguments specific to the check being run.
Response The unique identifier for the created check job.
The current status of the check job (e.g., “PENDING”, “RUNNING”, “COMPLETE”).
The timestamp when the check job was created.
The timestamp when the check job was last updated.
The ID of the agent used for this check.
The input payload provided for the check job.
Example Request Example Response This endpoint runs a specific check with the provided parameters. The response includes a check job ID that can be used to track the progress and retrieve results of the check.
Implementation Details The runCheck endpoint is implemented in the shared_router.py file. Here’s a brief overview of the implementation:
The endpoint uses the get_check_schema dependency to parse and validate the incoming request data.
It then calls the celery_enqueue_run_check function, which handles the logic for running a single check.
The function checks if the user has access to the requested agent and validates the check configuration.
If everything is valid, it enqueues the check job using Celery.
Finally, it returns a JSON response with the check job details.
For more detailed information about the implementation, you can refer to the shared_router.py file in the Parcha backend codebase.
Available Checks Here are some of the available checks that can be run using this endpoint:
kyb.web_presence_check: Verifies the online presence of a business.kyb.business_registration_check: Checks the registration status of a business.kyc.identity_verification: Verifies the identity of an individual.kyc.adverse_media_check: Searches for any negative media coverage related to an individual.
The available checks may vary depending on your subscription level and the specific agent you’re using. Consult the Parcha documentation or contact support for a complete list of checks available to you.
Best Practices
Choose the right check : Make sure you’re using the appropriate check for your use case (KYB or KYC).Provide comprehensive data : The more details you provide in the payload, the more thorough and accurate the check can be.Use webhooks : Setting up a webhook_url allows you to receive real-time updates about your check progress.Handle errors gracefully : Be prepared to handle potential errors or edge cases in your application.Respect rate limits : Be mindful of any rate limits on the API to ensure smooth operation of your integration.
By following these guidelines, you can effectively use the runCheck endpoint to perform specific checks as part of your KYB or KYC processes.
