> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Entity Object

> An Entity Object is a core data structure that stores and manages information about individuals or businesses for verification purposes.

<Callout icon="star" color="#3DD892" iconType="regular">
  Think of an Entity as a digital representation of a real person or business,
  containing all their relevant information in a structured format.
</Callout>

## Key Components

<AccordionGroup>
  <Accordion title="Basic Information">
    * `entityId`: Unique identifier (UUID)
    * `entityType`: Type of entity (`INDIVIDUAL` or `BUSINESS`)
    * `entityProfile`: Profile configuration string
  </Accordion>

  {" "}

  <Accordion title="Personal Details">
    * Name components (given name, family name, etc.) - Date of birth information
    * Gender - Addresses
  </Accordion>

  <Accordion title="Additional Features">
    * Supports multiple address records
    * Stores identity documents
    * Allows custom data via `extraData` field
  </Accordion>
</AccordionGroup>

## Document Storage

<Info>
  Entities can contain zero or more [Document
  Objects](/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-document-object). These documents are directly
  accessible and manageable within the entity structure.
</Info>

## Example Implementation

Here's a comprehensive example of an Entity Object:

```json title="Entity Object Example" focus={2-4} theme={null}
{
  "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

<CardGroup cols={2}>
  <Card title="Name Structure" icon="signature">
    Contains both formatted display name and individual name components for
    flexible usage.
  </Card>

  <Card title="Address Management" icon="location-dot">
    Supports multiple addresses with comprehensive location details and date
    ranges.
  </Card>

  <Card title="Identity Documents" icon="id-card">
    Stores document metadata and scanned content with support for multiple
    document types.
  </Card>

  <Card title="Extra Data" icon="database">
    Flexible key-value storage for additional information not covered by
    standard fields.
  </Card>
</CardGroup>

<Callout icon="bell" color="#FFCA16" iconType="regular">
  Ensure all date fields follow ISO 8601 format (YYYY-MM-DD) for consistency and
  compliance.
</Callout>