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

# International

## International National IDs

<Info>
  This guide explains how to verify international national ID documents. National IDs are government-issued identification documents that serve as primary proof of identity in many countries.
</Info>

**Implementation Example**

<CodeGroup>
  ```json Example Request theme={null}
  {
    "identityDocs": [
      {
        "idType": "NATIONAL_ID",
        "country": "SGP", // Singapore
        "idNumber": "S1234567A",
        "extraData": []
      }
    ]
  }
  ```

  ```json Example with Full Entity theme={null}
  {
    "entity": {
      "name": {
        "givenName": "JOHN",
        "middleName": "MICHAEL",
        "familyName": "SMITH"
      },
      "dateOfBirth": {
        "dateOfBirth": "1990-01-15"
      },
      "identityDocs": [
        {
          "idType": "NATIONAL_ID",
          "country": "SGP",
          "idNumber": "S1234567A"
        }
      ]
    }
  }
  ```
</CodeGroup>

**Required Fields**

<AccordionGroup>
  <Accordion title="Personal Information">
    * **Name:** Must match ID exactly
      * Given name(s)
      * Middle name(s)
      * Family name(s)
    * **Date of Birth:** Format: `YYYY-MM-DD`
  </Accordion>

  <Accordion title="Document Details">
    * **ID Type:** Must be `NATIONAL_ID`
    * **Country:** ISO-3166-alpha3 country code
    * **Document Number:** Provided in `idNumber` field
  </Accordion>
</AccordionGroup>

<Callout icon="star" color="#3DD892" iconType="regular">
  ##### Common Country Codes

  Frequently used ISO-3166-alpha3 codes:

  * `SGP` - Singapore
  * `MYS` - Malaysia
  * `IND` - India
  * `CHN` - China
  * `GBR` - United Kingdom
  * `USA` - United States
</Callout>

<Callout icon="bell" color="#FFCA16" iconType="regular">
  Ensure that:

  * Names match exactly as shown on the ID
  * Date format is strictly `YYYY-MM-DD`
  * Country code is in ISO-3166-alpha3 format
  * ID number includes all special characters and leading zeros
</Callout>

## International Passport Verification

<Info>
  This guide covers the verification of international passports. Passports are standardized travel documents that follow International Civil Aviation Organization (ICAO) guidelines.
</Info>

<CodeGroup>
  ```json Example Request theme={null}
  {
    "identityDocs": [
      {
        "idType": "Passport",
        "country": "GBR",  // United Kingdom
        "idNumber": "123456789",
        "idExpiry": "2030-12-31"
      }
    ]
  }
  ```

  ```json Example with Full Entity theme={null}
  {
    "entity": {
      "name": {
        "givenName": "JAMES",
        "middleName": "ROBERT",
        "familyName": "WILSON"
      },
      "dateOfBirth": {
        "dateOfBirth": "1985-06-20"
      },
      "identityDocs": [
        {
          "idType": "PASSPORT",
          "country": "GBR",
          "idNumber": "123456789",
          "idExpiry": "2030-12-31"
        }
      ]
    }
  }
  ```
</CodeGroup>

**Required Fields**

<AccordionGroup>
  <Accordion title="Personal Information">
    * **Name:** Must match passport exactly
      * Given name(s)
      * Middle name(s)
      * Family name(s)
    * **Date of Birth:** Format: `YYYY-MM-DD`
  </Accordion>

  <Accordion title="Passport Details">
    * **ID Type:** Must be `PASSPORT`
    * **Country:** ISO-3166-alpha3 country code
    * **Document Number:** Provided in `idNumber` field
    * **Expiry Date:** Format: `YYYY-MM-DD`
  </Accordion>
</AccordionGroup>

<Card title="Passport Number Formats" icon="passport">
  Most countries follow these general rules:

  * Alphanumeric characters only
  * No special characters (except some legacy passports)
  * Length varies by country (typically 8-9 characters)
  * May include check digits
</Card>

<Callout icon="bell" color="#FFCA16" iconType="regular">
  Common validation issues:

  * Expired passports
  * Incorrect country codes
  * Missing or incorrect name format
  * Invalid date formats
</Callout>

<Callout icon="star" color="#3DD892" iconType="regular">
  ##### Best Practices

  When verifying passports:

  1. Use Machine Readable Zone (MRZ) data when available
  2. Include all name components exactly as shown
  3. Verify expiry date is in the future
  4. Check for country-specific format requirements
</Callout>

<Info>
  ##### Name Handling

  For names with special characters:

  * Remove diacritical marks
  * Convert to uppercase
  * Follow ICAO transliteration rules
  * Use exactly as shown in MRZ when available
</Info>