Business Schema

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:

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

Step 3: Validate Your Data

Before submitting:

Check Field Requirements
- Verify all required fields are present
- Ensure field lengths are within limits
- Validate URL formats
- Check date formats (YYYY-MM-DD)
Document Accessibility
- Test all document URLs
- Verify document permissions
- Check file formats
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:

Required fields are checked for presence
Field formats are validated (e.g., date formats, URL formats)
Field lengths are checked and truncated if necessary
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:

Ensure all required fields are provided
Follow the specified formats for dates, URLs, and other structured data
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

kyb_schema.id

string

required

A unique id specific to the account being analyzed

kyb_schema.self_attested_data

object

kyb_schema.self_attested_data.business_name

string

The name of the business

Maximum length: 64

kyb_schema.self_attested_data.registered_business_name

string

The registered name of the business

Maximum length: 64

kyb_schema.self_attested_data.address_of_incorporation

object

kyb_schema.self_attested_data.address_of_operation

object

kyb_schema.self_attested_data.website

string

The business website URL

kyb_schema.self_attested_data.business_purpose

string

The purpose of the business

kyb_schema.self_attested_data.description

string

Business description

Maximum length: 512

kyb_schema.self_attested_data.industry

string

The industry the business operates in

kyb_schema.self_attested_data.tin_number

string

Tax Identification Number

kyb_schema.self_attested_data.incorporation_date

string

Date of incorporation

kyb_schema.self_attested_data.partners

string[]

List of business partners

kyb_schema.self_attested_data.customers

string[]

List of customers

kyb_schema.self_attested_data.source_of_funds

string[]

List of funding sources

kyb_schema.self_attested_data.incorporation_documents

object[]

kyb_schema.self_attested_data.business_ownership_documents

object[]

kyb_schema.self_attested_data.proof_of_address_documents

object[]

kyb_schema.self_attested_data.source_of_funds_documents

object[]

kyb_schema.self_attested_data.ein_documents

object[]

kyb_schema.self_attested_data.cannabis_license_documents

object[]

kyb_schema.external_validation_data

object

External validation data for the business

kyb_schema.research_data

object

Web research data for the business

kyb_schema.associated_individuals

object[]

List of associated individuals

kyb_schema.associated_individuals.id

string

required

A unique id specific to the account being analyzed

kyb_schema.associated_individuals.self_attested_data

object

kyb_schema.associated_individuals.self_attested_data.first_name

string

The first name of the individual

kyb_schema.associated_individuals.self_attested_data.middle_name

string

The middle name of the individual

kyb_schema.associated_individuals.self_attested_data.last_name

string

The last name of the individual

kyb_schema.associated_individuals.self_attested_data.name_prefix

string

The prefix of the individual

kyb_schema.associated_individuals.self_attested_data.name_suffix

string

The suffix of the individual

kyb_schema.associated_individuals.self_attested_data.date_of_birth

string

The date of birth of the individual, format YYYY-MM-DD

kyb_schema.associated_individuals.self_attested_data.address

object

kyb_schema.associated_individuals.self_attested_data.associated_addresses

object[]

The associated addresses of the individual

kyb_schema.associated_individuals.self_attested_data.country_of_nationality

string

The country of nationality of the individual

kyb_schema.associated_individuals.self_attested_data.country_of_residence

string

The country of residence of the individual

kyb_schema.associated_individuals.self_attested_data.place_of_birth

string

The place of birth of the individual

kyb_schema.associated_individuals.self_attested_data.sex

string

The sex of the individual

kyb_schema.associated_individuals.self_attested_data.email

string

The email of the individual

kyb_schema.associated_individuals.self_attested_data.phone

string

The phone number of the individual

kyb_schema.associated_individuals.self_attested_data.title

string

The title of the individual

kyb_schema.associated_individuals.self_attested_data.is_applicant

boolean

Whether this individual is the applicant

kyb_schema.associated_individuals.self_attested_data.is_business_owner

boolean

Whether this individual is a business owner

kyb_schema.associated_individuals.self_attested_data.business_ownership_percentage

number

The percentage of business ownership

kyb_schema.associated_individuals.self_attested_data.proof_of_address_documents

object[]

kyb_schema.associated_individuals.self_attested_data.source_of_funds_documents

object[]

kyb_schema.associated_entities

object[]

List of associated entities

How to Run a KYB Agent High Risk Country Check

{
  "agent_key": "<string>",
  "check_ids": [
    "<string>"
  ],
  "kyb_schema": {
    "id": "<string>",
    "self_attested_data": {
      "business_name": "<string>",
      "registered_business_name": "<string>",
      "address_of_incorporation": {
        "street_1": "<string>",
        "street_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>"
      },
      "address_of_operation": {
        "street_1": "<string>",
        "street_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>"
      },
      "website": "<string>",
      "business_purpose": "<string>",
      "description": "<string>",
      "industry": "<string>",
      "tin_number": "<string>",
      "incorporation_date": "2023-12-25",
      "partners": [
        "<string>"
      ],
      "customers": [
        "<string>"
      ],
      "source_of_funds": [
        "<string>"
      ],
      "incorporation_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ],
      "business_ownership_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ],
      "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>"
        }
      ],
      "ein_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ],
      "cannabis_license_documents": [
        {
          "b64_document": "<string>",
          "file_name": "<string>",
          "source_type": "<string>"
        }
      ]
    },
    "external_validation_data": {},
    "research_data": {},
    "associated_individuals": [
      {
        "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>"
            }
          ]
        }
      }
    ],
    "associated_entities": [
      {
        "self_attested_data": {
          "business_name": "<string>",
          "business_ownership_percentage": 123,
          "is_business_owner": true
        }
      }
    ]
  }
}

Get Started

Quick Guides

Concepts

Use Cases

Know Your Business (KYB)

How to Prepare Your Schema

Step 1: Identify Required Schema Fields for Checks

Step 2: Gather Required Information

Step 3: Validate Your Data

Validation Rules

Validation Process

Step 4: Structure Your Schema

Step 5: Use the Schema in API Calls

API Documentation

Get Started

Quick Guides

Concepts

Use Cases

Know Your Business (KYB)

​How to Prepare Your Schema

​Step 1: Identify Required Schema Fields for Checks

​Step 2: Gather Required Information

​Step 3: Validate Your Data

​Validation Rules

​Validation Process

​Step 4: Structure Your Schema

​Step 5: Use the Schema in API Calls

API Documentation

How to Prepare Your Schema

Step 1: Identify Required Schema Fields for Checks

Step 2: Gather Required Information

Step 3: Validate Your Data

Validation Rules

Validation Process

Step 4: Structure Your Schema

Step 5: Use the Schema in API Calls