This article describes how to build an OCR API that extracts data from SS4 using our deep learning engine. If you want to automate your workflow, this article is for you.

Prerequisites

  1. You’ll need a free account. Sign up and confirm your email to login.
  2. You’ll need at least 20 SS4 images or pdfs to train your OCR.

Define your SS4 use case

First, we’re going to define what fields we want to extract from your SS4.

Set up your modelSet up your model

Set up your model

  • Entity Name: The legal name of the entity.
  • Address: The entity's full address (mailing, city, state)
  • SSN: The Social Security Number of the principal officer.
  • Type of entity: The type of entity.
  • Reason for applying: The reason why you apply for an employer identification number.

That’s it for our use case. Feel free to add any other relevant data to fit your requirements.

Deploy your API

Once you have defined the list of fields you want to extract from your SS4, head over to the platform and press the ‘Create a new API’ button.

You land now on the setup page. Here is the image you can use to set up the API. For instance, my setup is as follows:
Set up your modelSet up your model

Set up your model

Once you’re ready, click on the “next” button. We are going to specify the data types for each of the fields we want our API to extract.

Define your modelDefine your model

Define your model

To move forward, you have two possibilities:

Upload a json config
Copy the following JSON into a file and upload it on the interface

{
  "problem_type": {
    "classificator": { "features": [], "features_name": [] },
    "selector": {
      "features": [
        {
          "cfg": { "filter": { "alpha": -1, "numeric": 0 } },
          "handwritten": false,
          "name": "entity_name",
          "public_name": "Entity Name",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": -1 } },
          "handwritten": false,
          "name": "address",
          "public_name": "Address",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": 0, "numeric": -1 } },
          "handwritten": false,
          "name": "ssn",
          "public_name": "SSN",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": 0 } },
          "handwritten": false,
          "name": "type_of_entity",
          "public_name": "Type of entity",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": 0 } },
          "handwritten": false,
          "name": "reason_for_applying",
          "public_name": "Reason for applying",
          "semantics": "word"
        }
      ],
      "features_name": [
        "entity_name",
        "address",
        "ssn",
        "type_of_entity",
        "reason_for_applying"
      ]
    }
  }
}

Or build your data model manually
Using the interface, add up to your data model each field.

In our example, here are the different field configurations we used:

  • Entity Name: type String that never contains numeric characters.
  • Address: type String without specifications.
  • SSN: type String that never contains alpha characters.
  • Type of entity: type String that never contains numeric characters.
  • Reason for applying: type String that never contains numeric characters.

Once you’re done setting up your data model, press the Start training your model button at the bottom of the screen.

Ready to train modelReady to train model

Ready to train model

Train your SS4 OCR

Train your modelTrain your model

Train your model

You’re all set!

Now is the time to train your SS4 deep learning model in the Training section of our API.

In a few hours (minutes if you're fast), you’ll get your first model trained and will be able to use your custom OCR API for parsing SS4 in your application.

To get more information about the training phase, please refer to the Getting Started tutorial. If you have any question regarding your use case, feel free to reach out on our chat!

Updated 4 months ago


SS4 OCR


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.