Our pay stub capture lets you make informed decisions involving a prospective borrower's recent income history. We identify and categorize the earnings and deductions listed on a pay stub, separating recurring base pay from one-time bonuses or commissions. Finally, the net pay distribution allows you to compare deposit amounts against bank statement transactions, giving you confidence in your lending decision.

🚧

Pay stubs work a little differently

Due to the bespoke nature of pay stubs, we do not support the PAYSTUB form type on any of the Form data endpoints. Please use one of the Pay stub data endpoints instead.

Usage guide

Here's how you can capture data from a pay stub:

1. If you haven't already, create a Book to hold the documents you'd like to capture.
2. Upload a pay stub to the Book with one of the following methods:
   • If your pay stub is contained in a PDF, you may upload it directly.
   • If your pay stub is contained in a sequence of images, upload them individually and finalize the resulting image group when you've finished.
3. Once the pay stub is processed, you can retrieve the captured data with one of the following methods:
   • You can retrieve a specific pay stub's captured data by calling this endpoint with its UUID.
   • You can retrieve the captured data for all pay stubs in a Book by providing the Book's UUID to this endpoint.

You can use webhook notifications to be immediately notified when we finish processing the pay stub. You can also poll the aforementioned endpoints.

Pay stub data structure

The pay stub full extraction output diagram is below.

The composite data type Pay stub, consists of several fields and composite data types. The items in blue denote a composite data type; for example, the Net Pay object consists of an array of Pay Distribution objects and a single Total object.

Details about the composite data structures can be found on the Pay stub composite data type page. You can find sample documents there as well.