> ## 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.

# Working with Names

> At FrankieOne, we understand that names vary significantly across different cultures and regions. We continuously work to support diverse naming conventions and cultural nuances. If you have specific requirements not covered here, please contact us.

## Name Structure

The Name object consists of the following fields:

<CardGroup cols={2}>
  <Card title="Required (at least one)" icon="asterisk">
    * Family name (Surname)
    * Given/First name
  </Card>

  <Card title="Optional" icon="circle">
    * Other names (Middle name(s))
    * Display Name - Honorific
  </Card>
</CardGroup>

<Callout icon="star" color="#3DD892" iconType="regular">
  For complete technical specifications, refer to the PersonalNameObject in our
  [API Reference](/docs/v1/api/kyc-api-endpoints/reference/status/status-check).
</Callout>

<AccordionGroup>
  <Accordion title="Character Set Support">
    * FrankieOne supports **UTF-8** characters by default
    * Handles names with diacritics (accents, umlauts)
    * Supports multiple character sets (ASCII, local characters)

    ### Handling Multiple Character Sets (e.g., Chinese or Thai)

    For names with both ASCII and local characters, support is contingent on the service providers being used to verify your customer's details. There are two approaches to storing these names:

    |          | Name Fields     | DisplayName Field (what's seen in Portal) |
    | -------- | --------------- | ----------------------------------------- |
    | Option 1 | English version | Local version                             |
    | Option 2 | Local version   | English version                           |

    <Callout icon="thumbtack" color="#1A6CFF" iconType="regular">
      For document-specific requirements, see [Requirements & Additional Fields for ID Documents](/docs/v1/api/guide-to-the-api/requirements-additional-fields-for-id-documents).
    </Callout>
  </Accordion>

  <Accordion title="Single Name Handling">
    Many cultures use single names. You can:

    * Store in `GivenName` field (preferred)
    * Or store in `FamilyName` field if culturally appropriate
    * Use `DisplayName` for alternative renderings

    ### Australian DVS Checks

    <Info>
      For Australian Document Verification Service:

      * Use a hyphen (-) as first name
      * Put the single name in `FamilyName`
      * A full stop (.) can be used instead of hyphen when running through providers
    </Info>
  </Accordion>
</AccordionGroup>

## Middle Name Matching (Australian Data Sources)

<Tabs>
  <Tab title="Matching Rules">
    <CardGroup cols={2}>
      <Card title="Pass Conditions" icon="check">
        * No middle name provided & none in database
        * Middle name provided & matches database
        * Driver's License checks are more flexible
      </Card>

      <Card title="Fail Conditions" icon="xmark">
        * Middle name mismatch
        * Middle name provided but none in database
        * Database has middle name but none provided
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Detailed Matrix">
    <Info>
      The following matrix shows how middle name matching works across different Australian data sources. "Pass\*" indicates a successful match assuming all other details are correct.
    </Info>

    | Scenario                      | A                                            | B                                            | C                                            | D                                            | E                                            |
    | ----------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
    | **If →**                      | No middle name provided to source            | No middle name provided to source            | Middle name provided to source               | Middle name provided to source               | Middle name provided to source               |
    | **And →**                     | No middle name in database                   | Middle name exists in database               | No middle name in database                   | Middle name exists & matches                 | Middle name exists & doesn't match           |
    | ***And →***                   |                                              |                                              |                                              | The middle names match                       | A middle name doesn't match                  |
    | **Australian Electoral Roll** | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Birth Certificate**     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Citizenship**           | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Driver's License**      | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "green"}}>Pass\*</span> |
    | **DVS ImmiCard**              | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Medicare**              | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Passport**              | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |
    | **DVS Visa**                  | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "red"}}>Fail</span>     | <span style={{color: "green"}}>Pass\*</span> | <span style={{color: "red"}}>Fail</span>     |

    \* Pass results assume all other verification details match correctly.
  </Tab>
</Tabs>

<Callout icon="thumbtack" color="#1A6CFF" iconType="regular">
  For specific guidance on name handling or verification requirements, please
  contact our developer support team.
</Callout>