SaudiNationalIdValidator 1.0.0

Saudi National ID Validator

A comprehensive .NET library for validating Saudi National IDs (including both Citizen IDs and Resident/Iqama IDs) with support for data annotations and helper methods.

Features

• ✅ Validates Saudi National ID format (10 digits)
• ✅ Verifies checksum using Luhn algorithm
• ✅ Identifies ID type (Citizen or Resident)
• ✅ Data annotation support for ASP.NET models
• ✅ Helper methods for programmatic validation
• ✅ .NET Standard 2.0 (compatible with .NET Framework 4.6.1+ and .NET Core 2.0+)

Installation

Install via NuGet Package Manager:

dotnet add package SaudiNationalIdValidator

Or via Package Manager Console:

Install-Package SaudiNationalIdValidator

Usage

1. Data Annotation (Recommended for ASP.NET Models)

Use the [SaudiNationalId] attribute to validate model properties:

using SaudiNationalIdValidator;

public class UserRegistrationModel
{
    [Required]
    [SaudiNationalId(ErrorMessage = "Please enter a valid Saudi National ID")]
    public string NationalId { get; set; }
}

Advanced Options

Validate Citizen IDs Only:

public class CitizenModel
{
    [SaudiNationalId(CitizenOnly = true)]
    public string CitizenId { get; set; }
}

Validate Resident IDs Only:

public class ResidentModel
{
    [SaudiNationalId(ResidentOnly = true)]
    public string ResidentId { get; set; }
}

2. Helper Methods (Programmatic Validation)

Use the static helper methods for manual validation:

using SaudiNationalIdValidator;

// Simple validation (returns true/false)
string id = "1234567890";
bool isValid = ValidateSaudiNationalId.IsValid(id);

if (isValid)
{
    Console.WriteLine("Valid ID");
}
else
{
    Console.WriteLine("Invalid ID");
}

Get ID Type:

// Validate and get ID type
SaudiIdType idType = ValidateSaudiNationalId.Validate(id);

switch (idType)
{
    case SaudiIdType.Citizen:
        Console.WriteLine("Valid Saudi Citizen ID");
        break;
    case SaudiIdType.Resident:
        Console.WriteLine("Valid Resident/Iqama ID");
        break;
    case SaudiIdType.Invalid:
        Console.WriteLine("Invalid ID");
        break;
}

Using Out Parameter:

// Validate and get ID type via out parameter
if (ValidateSaudiNationalId.Validate(id, out SaudiIdType type) != SaudiIdType.Invalid)
{
    Console.WriteLine($"Valid ID of type: {type}");
}

Validation Rules

A valid Saudi National ID must:

1. Be exactly 10 digits
2. Start with 1 (Citizen) or 2 (Resident)
3. Pass the Luhn algorithm checksum validation

Examples

• 1234567890 - Valid if checksum passes (Citizen)
• 2234567890 - Valid if checksum passes (Resident)
• 3234567890 - Invalid (must start with 1 or 2)
• 123456789 - Invalid (must be 10 digits)
• 12345678AB - Invalid (must be all digits)

API Reference

SaudiIdType Enum

ValidateSaudiNationalId Class

SaudiNationalIdAttribute Class

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.