International National IDs

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.

Implementation Example

1{
2 "identityDocs": [
3 {
4 "idType": "NATIONAL_ID",
5 "country": "SGP", // Singapore
6 "idNumber": "S1234567A",
7 "extraData": []
8 }
9 ]
10}

Required Fields

  • Name: Must match ID exactly
    • Given name(s)
    • Middle name(s)
    • Family name(s)
  • Date of Birth: Format: YYYY-MM-DD
  • ID Type: Must be NATIONAL_ID
  • Country: ISO-3166-alpha3 country code
  • Document Number: Provided in idNumber field
Common Country Codes

Frequently used ISO-3166-alpha3 codes:

  • SGP - Singapore
  • MYS - Malaysia
  • IND - India
  • CHN - China
  • GBR - United Kingdom
  • USA - United States

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

International Passport Verification

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

1{
2 "identityDocs": [
3 {
4 "idType": "Passport",
5 "country": "GBR", // United Kingdom
6 "idNumber": "123456789",
7 "idExpiry": "2030-12-31"
8 }
9 ]
10}

Required Fields

  • Name: Must match passport exactly
    • Given name(s)
    • Middle name(s)
    • Family name(s)
  • Date of Birth: Format: YYYY-MM-DD
  • ID Type: Must be PASSPORT
  • Country: ISO-3166-alpha3 country code
  • Document Number: Provided in idNumber field
  • Expiry Date: Format: YYYY-MM-DD
Passport Number Formats

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

Common validation issues:

  • Expired passports
  • Incorrect country codes
  • Missing or incorrect name format
  • Invalid date formats
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
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
Built with