Overview
A Persona represents an individual’s identity in the system. The Personas API enables managing:
- Personal identity information
- User-persona associations
- Identity verification
- Multi-entity relationships
Core Concepts
| Field | Description | Format |
|---|
first_name | First name | Required, max 100 chars |
last_name | Last name | Required, max 100 chars |
date_of_birth | Birth date | Required, ISO 8601 |
nationality | Country code | ISO 3166-1 alpha-3 |
hash_id | Identity hash | System generated |
Address Types
registered: Legal/official addressactual: Current residential address
Address Fields
| Field | Description |
|---|
street | Street name |
house | Building number |
zip_code | Postal code |
city | City name |
country | ISO 3166-1 alpha-3 |
Validation Rules
Age Requirements
- Must be at least 18 years old
- Date of birth must be valid
- Maximum age: 150 years
Name Requirements
- First and last names required
- Maximum length: 100 characters
- No special characters except hyphens
Security Requirements
- Personal data is encrypted
- Access is role-based
- Changes are audited
- Regular verification required
- Data retention policies apply
Query Parameters
List Personas
| Parameter | Type | Description |
|---|
| active | boolean | Filter by active status |
| nationality | string | Filter by ISO 3166-1 alpha-3 country code |
| limit | integer | Maximum number of records (default: 20, max: 100) |
| offset | integer | Number of records to skip for pagination |
List Links
| Parameter | Type | Description |
|---|
| rec_type_name | string | Filter by linked entity type |
| active | boolean | Filter by active status |
| limit | integer | Maximum number of records (default: 20, max: 100) |
| offset | integer | Number of records to skip for pagination |
See individual endpoint documentation for detailed request/response formats and examples.
