The Individual Schema contains information about a person. It is used for Know Your Customer (KYC) processes in Parcha’s case management system.

Example

Field Descriptions

Case ID

id
string
required

Unique identifier for the case. Used to tie cases together when running workflows and can be used to link back to internal case management systems.

Self Attested Data

self_attested_data.first_name
string
required

The first name of the individual

self_attested_data.middle_name
string

The middle name of the individual

self_attested_data.last_name
string
required

The last name of the individual

self_attested_data.date_of_birth
string

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

self_attested_data.address
Address

The address of the individual

self_attested_data.country_of_nationality
string

The country of nationality of the individual

self_attested_data.country_of_residence
string

The country of residence of the individual

self_attested_data.place_of_birth
string

The place of birth of the individual

self_attested_data.sex
string

The sex of the individual

self_attested_data.email
string

The email of the individual

self_attested_data.phone
string

The phone number of the individual

self_attested_data.title
string

The title of the individual

self_attested_data.is_applicant
boolean

Whether the individual is an applicant

self_attested_data.is_business_owner
boolean

Whether the individual is a business owner

self_attested_data.business_ownership_percentage
number

The percentage of ownership of the individual

self_attested_data.source_of_funds_description
string

The description of the source of funds for the individual

Document Fields

The following fields are lists of Document objects:

  • proof_of_address_documents
  • source_of_funds_documents

Address Object

street_1
string
required

Primary street address

street_2
string

Secondary street address

city
string
required

City name

state
string

State or province

postal_code
string
required

Postal or ZIP code

country_code
string
required

Two-letter country code

Document Object

document_type
string
required

Type of the document

file_name
string
required

Name of the document file

file_url
string
required

URL to access the document

Validation Rules

  • first_name and last_name are required fields.
  • date_of_birth, if provided, must be in the format YYYY-MM-DD.
  • email, if provided, must be a valid email address format.
  • business_ownership_percentage, if provided, must be a number between 0 and 100.

Validation Process

When submitting data for the Individual Schema, the system performs several validation checks:

  1. Required fields are checked for presence.
  2. Field formats are validated (e.g., date formats, email formats).
  3. Field values are checked for validity (e.g., ownership percentage range).
  4. Associated documents are processed and validated.

If any validation errors occur, the system will return a SchemaValidationError with details about the specific fields that failed validation.

Usage in API

When using this schema in API calls:

  1. Ensure all required fields are provided.
  2. Follow the specified formats for dates, email addresses, 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.