US Employment Authorization

This section describes how to build your custom OCR API to extract data from US Employment Authorization Card using the API Builder. A US Employment Authorization Card is an identification card that U.S. Citizenship and Immigration Services (USCIS) issues to certain qualifying foreign nationals to work in the United States

Prerequisites

You’ll need at least 20 US Employment Authorization images or pdfs to train your OCR.

Define your US Employment Authorization Card Use Case

Using the US Employment Authorization Card below, we’re going to define the fields we want to extract from it.
US Employment Authorization CardUS Employment Authorization Card

  • Surname: The last name of the work permit holder
  • Given Name: The first name of the work permit holder
  • Category: The US Employment Authorization category
  • Valid from: The starting date of the validity of your US employment authorization card
  • Card expires: The expiration date of your US employment authorization card

That’s it for this example. Feel free to add any other relevant data that fits your requirement.

Deploy your API

Once you have defined the list of fields you want to extract from your US Employment Authorization Card, head over to the platform and follow these steps:

  1. Click on the Create a new API button on the right.

  2. Next, fill in the basic information about the API you want to create as seen below.

Set up your APISet up your API

  1. Click on the Next button. The following page allows you to define and add your data model.

Define Your Model

There are two ways to add fields to your data model.

  • Upload a JSON config file
  • Manually add data

Data ModelData Model

Upload a JSON Config

To add data fields using JSON config upload.

  1. Copy the following JSON into a file.
{
  "problem_type": {
    "classificator": { "features": [], "features_name": [] },
    "selector": {
      "features": [
        {
          "cfg": { "filter": { "alpha": -1, "numeric": 0 } },
          "handwritten": false,
          "name": "surname",
          "public_name": "Surname",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": 0 } },
          "handwritten": false,
          "name": "given_name",
          "public_name": "Given Name",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": -1 } },
          "handwritten": false,
          "name": "category",
          "public_name": "Category",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "convention": "US" } },
          "handwritten": false,
          "name": "valid_from",
          "public_name": "Valid from",
          "semantics": "date"
        },
        {
          "cfg": { "filter": { "convention": "US" } },
          "handwritten": false,
          "name": "card_expires",
          "public_name": "Card expires",
          "semantics": "date"
        }
      ],
      "features_name": [
        "surname",
        "given_name",
        "category",
        "valid_from",
        "card_expires"
      ]
    }
  }
}
  1. Click on Upload a JSON config.
  2. The data model will be automatically filled.
  3. Click on Create API at the bottom of the screen.

Document Data Model filledDocument Data Model filled

Manually Add Data

Using the interface, you can manually add each field for the data you are extracting. For this example, here are the different field configurations used:

  • Surname: type String that never contains numeric characters.
  • Given Name: type String that never contains numeric characters.
  • Category: type String without specifications.
  • Valid from: type Date in US format.
  • Card expires: type Date in US format.

Once you’re done setting up your data model, click the Create API button at the bottom of the screen.

Document Data Model filledDocument Data Model filled

  1. Click on Upload a JSON config.
  2. The data model will be automatically filled.
  3. Click on Create API at the bottom of the screen.

Document Data Model filledDocument Data Model filled

Manually Add Data

Using the interface, you can manually add each field for the data you are extracting. For this example, here are the different field configurations used:

  • Surname: type String that never contains numeric characters.
  • Given Name: type String that never contains numeric characters.
  • Category: type String without specifications.
  • Valid from: type Date in US format.
  • Card expires: type Date in US format.

Once you’re done setting up your data model, click the Create API button at the bottom of the screen.

Document Data Model filledDocument Data Model filled

Train your US Employment Authorization OCR

You’re all set! Now it's time to train your US Employment Authorization deep learning model in the Training section of our API.
Train your modelTrain your model

  1. Upload one file at a time or a zip bundle of many files.
  2. Click on the field input on the right, and the blue box on the left highlights all the corresponding field candidates in the document.
  3. Next, click on the validate arrow for all the field inputs.
  4. Once you have selected the proper box(es) for each of your fields as displayed on the right-hand side, click on the validate button located at the right-side bottom to send an annotation for the model you have created.
  5. Repeat this process until you have trained 20 documents to create a trained model.

To get more information about the training phase, please refer to the Getting Started tutorial.

 

Questions?
Slack Logo IconSlack Logo Icon  Join our Slack


Did this page help you?