Skip to main content
The Business Schema contains information about a business entity. It is used for Know Your Business (KYB) processes in Parcha’s case management system.
This schema is crucial for maintaining accurate and comprehensive business records in our system.

​
How to Prepare Your Schema

Follow these steps to prepare your business schema based on the checks you want to run:

​
Step 1: Identify Required Schema Fields for Checks

First, determine which checks you need to run. Common check types include. The following sections detail which attributes are required (✓) for each check:
While some attributes are marked as optional, providing them can improve the accuracy and comprehensiveness of the check results.

​
Step 2: Gather Required Information

For each required field:
  1. Basic Information
    • Business name (max 64 characters)
    • Website URL (if available)
    • Business description (max 512 characters)
    • Industry classification
    • Tax ID number (if required)
  2. Address Information
    • Operating address
    • Incorporation address (if different)
    • Include all required address fields (street, city, state, postal code, country)
  3. Documents
    • Prepare URLs for required documents
    • Ensure documents are accessible
    • Use proper file names and source types
  4. Associated Data
    • List of partners and customers
    • Source of funds information
    • Associated individuals and entities

​
Step 3: Validate Your Data

Before submitting:
  1. Check Field Requirements
    • Verify all required fields are present
    • Ensure field lengths are within limits
    • Validate URL formats
    • Check date formats (YYYY-MM-DD)
  2. Document Accessibility
    • Test all document URLs
    • Verify document permissions
    • Check file formats
  3. Data Completeness
    • Review the Check Requirements table
    • Ensure all required fields for your checks are included
    • Consider adding optional fields for better results

​
Validation Rules

  • business_name is required and is truncated to 64 characters if longer
  • description is truncated to 512 characters if longer
  • If website is provided, it must be a valid URL
  • incorporation_date must be in YYYY-MM-DD format if provided

​
Validation Process

When submitting data for the Business Schema, the system performs several validation checks:
  1. Required fields are checked for presence
  2. Field formats are validated (e.g., date formats, URL formats)
  3. Field lengths are checked and truncated if necessary
  4. Associated individuals and entities are processed and validated
If any validation errors occur, the system will return a SchemaValidationError with details about the specific fields that failed validation.

​
Step 4: Structure Your Schema

Follow this template structure: 
{
  "id": "your-case-id",
  "self_attested_data": {
    // Required fields based on your checks
    "business_name": "Your Business Name",
    "website": "https://your-website.com",
    // ... other fields
  }
}
While some fields are optional, providing them can improve the accuracy and comprehensiveness of the check results.
  • All URLs must be accessible
  • Document URLs must be direct download links
  • Dates must be in YYYY-MM-DD format
  • Country codes must be ISO 3166-1 alpha-2 format

​
Step 5: Use the Schema in API Calls

When using this schema in API calls:
  1. Ensure all required fields are provided
  2. Follow the specified formats for dates, URLs, and other structured data
  3. Be prepared to handle validation errors and adjust your data accordingly

API Documentation

Dive into our comprehensive API documentation to understand all available endpoints and features.
​
agent_key
string
required

The unique identifier for the agent

​
check_ids
string[]

The check IDs to run (runs all checks in agent configuration if not provided)

​
kyb_schema
object