The Entity Object
An Entity Object is a core data structure that stores and manages information about individuals or businesses for verification purposes.
Think of an Entity as a digital representation of a real person or business, containing all their relevant information in a structured format.
Key Components
Basic Information
entityId
: Unique identifier (UUID)entityType
: Type of entity (INDIVIDUAL
orBUSINESS
)entityProfile
: Profile configuration string
Personal Details
- Name components (given name, family name, etc.) - Date of birth information
- Gender - Addresses
Additional Features
- Supports multiple address records
- Stores identity documents
- Allows custom data via
extraData
field
Document Storage
Entities can contain zero or more Document Objects. These documents are directly accessible and manageable within the entity structure.
Example Implementation
Here’s a comprehensive example of an Entity Object:
Key Sections Explained
Contains both formatted display name and individual name components for flexible usage.
Supports multiple addresses with comprehensive location details and date ranges.
Stores document metadata and scanned content with support for multiple document types.
Flexible key-value storage for additional information not covered by standard fields.
Ensure all date fields follow ISO 8601 format (YYYY-MM-DD) for consistency and compliance.