French Payslips

This section describes how to build your custom OCR API to extract data from French Payslips using the API Builder. A French Payslips is a document provided by the employer proving the salary paid to the employee,

Prerequisites

You’ll need at least 20 French payslips images or PDFs to train your OCR.

Define Your French Payslips Use Case

Using the French Payslips below, we’re going to define the fields we want to extract from it.
French Payslips

  • Employee full name: First and last names of the employee
  • Employee SSN: Employee social security number
  • Employer SIRET: Employer SIRET number
  • Payslip period: Payslip month and year
  • Net paid: Total net paid
  • Gross salary: Total gross salary before taxes

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 French Payslips, 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": "employee_full_name",
          "public_name": "Employee Full Name",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": -1 } },
          "handwritten": false,
          "name": "employee_ssn",
          "public_name": "Employee SSN",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "alpha": -1, "numeric": -1 } },
          "handwritten": false,
          "name": "company_siret",
          "public_name": "Company SIRET",
          "semantics": "word"
        },
        {
          "cfg": { "filter": { "convention": "FR" } },
          "handwritten": false,
          "name": "payslip_period",
          "public_name": "Payslip period",
          "semantics": "date"
        },
        {
          "cfg": { "filter": { "is_integer": -1 } },
          "handwritten": false,
          "name": "net_paid",
          "public_name": "Net Paid",
          "semantics": "amount"
        },
        {
          "cfg": { "filter": { "is_integer": -1 } },
          "handwritten": false,
          "name": "gross_salary",
          "public_name": "Gross salary",
          "semantics": "amount"
        }
      ],
      "features_name": [
        "employee_full_name",
        "employee_ssn",
        "company_siret",
        "payslip_period",
        "net_paid",
        "gross_salary"
      ]
    }
  }
}
  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. For this example, here are the different field configurations used:

  • Employee full name: type String with no numeric characters
  • Employee SSN: type String, we haven't checked the "It never contains alpha characters" as social security numbers can contain 'a' or 'b' for Corsican.
  • Employer company SIRET: type String that never contains alpha characters.
  • Payslip period: type Date
  • Net paid: type Number
  • Gross salary: type Number

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 French Payslip OCR

You’re all set! Now it's time to train your French Payslip 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.

 

Questions?
Slack Logo Icon  Join our Slack