Skip to main content

​
Name Structure

The Name object consists of the following fields:

Required (at least one)

  • Family name (Surname)
  • Given/First name

Optional

  • Other names (Middle name(s))
  • Display Name - Honorific
For complete technical specifications, refer to the PersonalNameObject in our API Reference.
  • 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:
For document-specific requirements, see Requirements & Additional Fields for ID Documents.
Many cultures use single names. Store the single name in FamilyName:
  • Store in FamilyName field (preferred), with a hyphen (-) as the GivenName placeholder
  • FamilyName is the only required field on the PersonalNameObject, and most data sources mandate a last name — a single name in GivenName with an empty FamilyName will be rejected
  • Use DisplayName for alternative renderings

​
Australian DVS Checks

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

​
Middle Name Matching (Australian Data Sources)

Pass Conditions

  • No middle name provided & none in database
  • Middle name provided & matches database
  • Driver’s License checks are more flexible

Fail Conditions

  • Middle name mismatch
  • Middle name provided but none in database
  • Database has middle name but none provided
For specific guidance on name handling or verification requirements, please contact our developer support team.