This schema is crucial for maintaining accurate records of related entities and ensuring compliance with KYB regulations.
Example
Field Descriptions
Case 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
string
The name of the UBO entity
string
The registered name of the business
string
The incorporation date of the UBO entity, format YYYY-MM-DD
boolean
Whether or not the UBO Entity is a trust
Address
The address of the business
string
The industry of the UBO entity
string
The tax identification number of the business
boolean
Whether or not the UBO entity is a business owner
number
The business ownership percentage of the business
string | string[]
The website(s) of the business
string
The description of the business
string
The relationship of the business to the main entity
boolean
Whether or not to skip KYB validation, for cases when it is a well-known company
Address Object
string
required
Primary street address
string
Secondary street address
string
required
City name
string
State or province
string
required
Postal or ZIP code
string
required
Two-letter country code
Validation Rules
Validation Process
When submitting data for the Associated Entity Schema, the system performs several validation checks:- Field formats are validated (e.g., date formats, URL formats).
- Field values are checked for validity (e.g., ownership percentage range).
- If
skip_validationis false, additional KYB (Know Your Business) checks may be performed.
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:- Provide as much information as available about the associated entity.
- Follow the specified formats for dates, URLs, and other structured data.
- Set
skip_validationto true only for well-known entities where extensive KYB checks are not necessary. - 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.