Skip to main content
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

  • entityId: Unique identifier (UUID)
  • entityType: Type of entity (INDIVIDUAL or BUSINESS)
  • entityProfile: Profile configuration string
  • Name components (given name, family name, etc.) - Date of birth information
  • Gender - Addresses
  • 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:
Entity Object Example
{
  "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051", // Unique identifier
  "entityProfile": "string", // Profile configuration
  "entityType": "INDIVIDUAL", // Entity type (INDIVIDUAL/BUSINESS)
  "name": {
    "displayName": "Jane Cecily Smith", // Full formatted name
    "familyName": "Smith",
    "givenName": "Jane",
    "honourific": "Duchess",
    "middleName": "Cecily"
  },
  "dateOfBirth": {
    "dateOfBirth": "1978-11-12", // ISO 8601 format
    "country": "AUS",
    "locality": "Brisbane",
    "yearOfBirth": "1978"
  },
  "addresses": [
    // Additional address fields...
    {
      "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "addressType": "RESIDENTIAL1", // Address classification
      "buildingName": "Tower of Babel",
      "country": "TST",
      "postalCode": "123-TST",
      "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia"
    }
  ],
  "gender": "F",
  "extraData": [
    {
      "kvpKey": "Extra.Information", // Custom key-value pairs
      "kvpType": "general.string",
      "kvpValue": "123-456-789A"
    }
  ],
  "identityDocs": [
    // Document-specific fields...
    {
      "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
      "documentStatus": "DOC_SCANNED",
      "idType": "DRIVERS_LICENCE"
    }
  ]
}

​
Key Sections Explained

Name Structure

Contains both formatted display name and individual name components for flexible usage.

Address Management

Supports multiple addresses with comprehensive location details and date ranges.

Identity Documents

Stores document metadata and scanned content with support for multiple document types.

Extra Data

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.