Affidavit of Residence

This section describes how to build your custom OCR API to extract data from Affidavits of Residence using the API Builder. An Affidavits of Residence is a legal document that you can use to verify your residence and the residency of anyone living with you.


You’ll need at least 20 Affidavit of Residence images or pdfs to train your OCR.

Define Your Affidavit of Residence Use Case

Using the image below, we’re going to define the fields we want to extract from the Affidavit of Residence.

Affidavit of Residence

  • Full name: The full name of the resident
  • Current Address: The current address of the citizen
  • Date: The letter date

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 Affidavit of Residence, 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 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.

Data 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": "full_name",
          "public_name": "Full name",
          "semantics": "word"
          "cfg": { "filter": { "alpha": -1, "numeric": -1 } },
          "handwritten": false,
          "name": "current_address",
          "public_name": "Current Address",
          "semantics": "word"
          "cfg": { "filter": { "convention": "US" } },
          "handwritten": false,
          "name": "date",
          "public_name": "Date",
          "semantics": "date"
      "features_name": ["full_name", "current_address", "date"]
  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 filled

Manually Add Data

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

  • Full name: type String that never contains numeric characters.
  • Current Address: type String without specifications.
  • Date: type String with no specifications.

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

Document Data Model filled

Train Your Affidavit of Residence OCR

You’re all set! Now it's time to train your Affidavit of Residence deep learning model in the Training section of our API.

Train 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.


Slack Logo Icon  Join our Slack