Philippines UMID OCR Python SDK

Parsing UMID Challenges

1. Lamination & Wear: UMID cards are often laminated, causing glare that obstructs standard OCR engines. Years of use can also lead to faded text and scratches, making data extraction unreliable. 2. Unstructured Address: The address field on a UMID card is a multi-line, free-text block with various local abbreviations (e.g., Brgy., Blk, St.). Parsing this into structured components is a significant challenge for generic OCR tools.

Why StructOCR for Philippines

Our AI model is specifically pre-trained on tens of thousands of Filipino documents, including various generations of the UMID card, making it an effective national id ocr solution. It intelligently handles glare, wear-and-tear, and accurately performs information parsing for complex Filipino addresses. The Python SDK abstracts all the complexity, allowing you to integrate robust UMID OCR into your application in minutes.

Common Use Cases in Philippines

• Fintech & e-Wallet KYC: Onboard and verify users for financial apps in seconds, complying with BSP regulations.
• Automated SIM Registration: Streamline the mandatory SIM card registration process by extracting data from UMID.
• Digital Loan Applications: Accelerate loan processing by automatically populating applicant data from their ID.

Python SDK Integration

Install the SDK via pip: `pip install structocr`. Then use the following code to extract data.

Prerequisite: Python 3.6+ and the `structocr` library installed.

Prefer another stack? Open the Node.js SDK + Express integration.

from structocr import StructOCR

# 💰 Save 30%+ vs competitors. Get 200 free credits instantly:
# 👉 https://structocr.com/register
# Initialize with your API Key
client = StructOCR("YOUR_API_KEY_HERE")

def scan_philippines_id():
    # Note: Supports JPG, PNG, WebP (Max 4.5MB)
    # Target: UMID
    image_path = "philippines_national_id.jpg"

    try:
        print(f"Scanning {image_path}...")
        
        # The SDK handles file upload and API communication
        # It automatically detects that this is a Filipino document
        result = client.scan_national_id(image_path)

        # Check success flag (SDK returns a dict matching the JSON response)
        if result.get('success'):
            data = result['data']
            print("✅ Philippines Extraction Successful!")
            
            # Basic Identity
            print(f"Region:      {data.get('country_code')} (Series: {data.get('card_series')})")
            print(f"Name:        {data.get('given_names')} {data.get('surname')}")
            print(f"ID Number:   {data.get('document_number')}")
            
            # Critical Field: Personal Identity Number (CNP/CPF/NIN)
            print(f"Personal #:  {data.get('personal_number')}")
            
            # Demographics
            print(f"DOB:         {data.get('date_of_birth')} ({data.get('sex')})")
            print(f"Address:     {data.get('address')}")
        else:
            print(f"❌ Extraction Failed: {result.get('error')}")

    except Exception as e:
        # Handle SDK or Network errors
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    scan_philippines_id()

JSON Response Example

A successful API call returns a Python dictionary that mirrors this JSON structure. Note that UMID cards do not have expiry dates, issue dates, or a Machine Readable Zone (MRZ), so these fields are returned as null inside the response and the `additional_fields` object.

{
  "success": true,
  "data": {
    "type": "national_id",
    "country_code": "PHL",
    "nationality": "FILIPINO",
    "document_number": "CRN-0033-1234567-8",
    "card_series": "",
    "personal_number": "CRN-0033-1234567-8",
    "surname": "DELA CRUZ",
    "given_names": "JUAN",
    "sex": "M",
    "date_of_birth": "1988-11-23",
    "place_of_birth": "",
    "address": "123 RIZAL AVE, BRGY. SAN ROQUE, PASAY CITY, METRO MANILA",
    "date_of_issue": null,
    "date_of_expiry": null,
    "issuing_authority": "Republic of the Philippines",
    "additional_fields": {
      "mrz_line_1": null,
      "mrz_line_2": null,
      "mrz_line_3": null,
      "tramite_number": null,
      "ejemplar": null,
      "phone_number": null
    }
  }
}