API Reference

Python ID Card OCR

Overview

This guide will help you extract data from ID Cards using Butler's OCR APIs in Python. In 15 minutes you'll be ready to add Python ID Card OCR into your product or workflow!

Before getting started, you'll want to make sure to do the following:

  1. Signup for a free Butler account at https://app.butlerlabs.ai
  2. Write down your Butler API key from the Settings menu. Follow the Getting Started guide for more details about how to do that.

Get your API ID

Sign into the Butler product, go to the Library and search for the ID Card model:

2854

Click on the ID Cards card, then press the Create button to create a new ID Card model:

2852

Once on the model details page, go to the APIs tab:

2854

Copy the API ID (also known as the Queue ID) and write it down. We'll use it in our code below.

Sample Python ID Card OCR Code

You can copy and paste the following Python sample code to process documents with OCR using the API.

# Ensure it's installed in your environment with pip install butler-sdk
from butler import Client

# Get API Key from https://docs.butlerlabs.ai/reference/uploading-documents-to-the-rest-api#get-your-api-key
api_key = '<api-key>'
# Get Queue ID from https://docs.butlerlabs.ai/reference/uploading-documents-to-the-rest-api#go-to-the-model-details-page
queue_id = '<queue_id>'

# Response is a strongly typed object
response = Client(api_key).extract_document(queue_id, 'id_card.jpeg')
# Convert to a dictionary for printing
print(response.to_dict())

📘

In-Product Sample Code

You can also copy the sample code directly from the product. This code will have your API ID and API Key already pre-populated for you!

Extracted ID Card Fields

Here is an example of what an ID Card JSON response looks like:

{
  "documentId": "1abb9c69-628c-43b7-bf51-c2a1380ab8f4",
  "documentStatus": "Completed",
  "fileName": "alabama.jpeg",
  "mimeType": "image/jpeg",
  "documentType": "ID Cards",
  "confidenceScore": "High",
  "formFields": [
    {
      "fieldName": "First Name",
      "value": "CONNOR",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Last Name",
      "value": "SAMPLE",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Middle Name",
      "value": "HUGH B",
      "confidenceScore": "Low"
    },
    {
      "fieldName": "Document Number",
      "value": "1234567",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Type",
      "value": "DRIVER LICENSE FRONT",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Class",
      "value": "D",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Issue Date",
      "value": "01-05-2010",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Expiration Date",
      "value": "01-05-2014",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Date of Birth",
      "value": "01-05-1948",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Address - City",
      "value": "MONTGOMERY",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Address - Zip Code",
      "value": "361041234",
      "confidenceScore": "High"
    },
    {
      "fieldName": "Address - State",
      "value": "AL",
      "confidenceScore": "High"
    },
    {
      "fieldName": "State",
      "value": "ALABAMA",
      "confidenceScore": "Low"
    },
    {
      "fieldName": "Restrictions",
      "value": "A",
      "confidenceScore": "High"
    }
  ],
  "tables": []
}

📘

Full ID Card API Response

The above JSON does not include all of the values that can be extracted from ID Cards. For full details, see the ID Card page.