Edit

Share via

Document Intelligence pay stub model

  • Article

The Document Intelligence pay stub model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract compensation and earnings data from pay slips. The API analyzes documents and files with payroll related information; extracts key information and returns a structured JSON data representation.

Feature version Model ID
Pay stub model • v4.0:2024-07-31 (preview) prebuilt-payStub.us

Try pay stub data extraction

Pay stubs are essential documents issued by employers to employees, providing earnings, deductions, and net pay information for a specific pay period. See how data is extracted using prebuilt-payStub.us model. You need the following resources:

  • An Azure subscription—you can create one for free

  • A Document Intelligence instance in the Azure portal. You can use the free pricing tier (F0) to try the service. After your resource deploys, select Go to resource to get your key and endpoint.

    Screenshot of keys and endpoint location in the Azure portal.

Document Intelligence Studio

  1. On the Document Intelligence Studio home page, select payStub.

  2. You can analyze the sample pay stub or upload your own files.

  3. Select the Run analysis button and, if necessary, configure the Analyze options :

Input requirements

  • Supported file formats:

    Model PDF Image:
    JPEG/JPG, PNG, BMP, TIFF, HEIF    		 Microsoft Office:
    Word (DOCX), Excel (XLSX), PowerPoint (PPTX), HTML
    Read ✔ ✔ ✔
    Layout ✔ ✔ ✔ (2024-07-31-preview, 2024-02-29-preview, 2023-10-31-preview)
    General Document ✔ ✔
    Prebuilt ✔ ✔
    Custom extraction ✔ ✔
    Custom classification ✔ ✔ ✔ (2024-07-31-preview, 2024-02-29-preview)

  • For best results, provide one clear photo or high-quality scan per document.

  • For PDF and TIFF, up to 2,000 pages can be processed (with a free tier subscription, only the first two pages are processed).

  • The file size for analyzing documents is 500 MB for paid (S0) tier and 4 MB for free (F0) tier.

  • Image dimensions must be between 50 pixels x 50 pixels and 10,000 pixels x 10,000 pixels.

  • If your PDFs are password-locked, you must remove the lock before submission.

  • The minimum height of the text to be extracted is 12 pixels for a 1024 x 768 pixel image. This dimension corresponds to about 8 point text at 150 dots per inch (DPI).

  • For custom model training, the maximum number of pages for training data is 500 for the custom template model and 50,000 for the custom neural model.

    • For custom extraction model training, the total size of training data is 50 MB for template model and 1 GB for the neural model.

    • For custom classification model training, the total size of training data is 1 GB with a maximum of 10,000 pages. For 2024-07-31-preview and later, the total size of training data is 2 GB with a maximum of 10,000 pages.

Supported languages and locales

See our Language Support page for a complete list of supported languages.

Field extractions

Name Type Description Standardized output
EmployeeAddress address Address of the employee 123 Maple Street, Springfield, IL, 62701
EmployeeName string Name of the employee John A. Doe
EmployeeSSN string Social security number of the employee 123-45-6789
EmployerAddress address Address of the employer 456 Oak Avenue, Metropolis, NY, 10101
EmployerName string Listed name of the employer Contoso Corporation
PayDate date Date of salary payment Feb. 26, 2020
PayPeriodStartDate date Start date of the pay period Feb. 19, 2020
PayPeriodEndDate date End date of the pay period Feb. 25, 2020
CurrentPeriodGrossPay number Gross pay of the current period $744.10
YearToDateGrossPay number Year-to-date gross pay $2744.10
CurrentPeriodTaxes number Taxes of the current period $410.10
YearToDateTaxes number Year-to-date taxes $855.90
CurrentPeriodDeductions number Deductions of the current period $410.10
YearToDateDeductions number Year-to-date deductions $855.90
CurrentPeriodNetPay number Net pay of the current period $744.10
YearToDateNetPay number Year-to-date net pay $2744.10

Supported locales

The prebuilt-payStub.us version 2027-07-31-preview supports the en-us locale.

Next steps