Ocrolus API

Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication

Grant authentication tokenpost

Book Commands

Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries

Book informationget
Book listget
Book statusget

File Uploads

Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands

Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries

Retrieve Mixed Document statusget

Classify

Book classification summaryget
Mixed Doc classification summaryget

Capture

Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect

Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Object Definitions

Analyze

Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks

Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks

Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Ocrolus API

Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication

Grant authentication tokenpost

Book Commands

Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries

Book informationget
Book listget
Book statusget

File Uploads

Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands

Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries

Retrieve Mixed Document statusget

Classify

Book classification summaryget
Mixed Doc classification summaryget

Capture

Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect

Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Object Definitions

Analyze

Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks

Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks

Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Doc pay stub data

get https://api.ocrolus.com/v2/document/{doc_uuid}/paystub

Retrieve pay stub data for a given Document.

A detailed description of the response can be found on the Pay stub data type definition

Path Params

doc_uuid

string

required

The unique identifier of the Document that contains the pay stub data.

Responses

Response body

object

status

integer

A numerical code that indicates the status of the request.

message

string

A textual description that indicates details about this response's status.

response

object

An object received from the server that potentially contains data.

uuid

string

Universally unique identifier (UUID) for the pay stub.

book_uuid

string

Universally unique identifier (UUID) for the Book.

doc_uuid

string

Universally unique identifier (UUID) for the Document.

status

string

Verification status of the pay stub Document.

doc_page_numbers

array of integers

An array of numbers that indicate the number of pages in each Document uploaded to the Book.

doc_page_numbers

rejection_reason

string

An optional attribute that briefly explains why a Document was rejected.

uploaded_image_bucket_uuid

string

Universally unique identifier (UUID) for the image bucket.

net_pay

object

The net pay recorded in the pay stub.

earnings

object

Earnings recorded in the pay stub.

deductions

object

Deductions recorded in the paystub.

employer

object

The employer recorded in the pay stub.

employee

object

The employee recorded in the pay stub.

paystub_details

object

Details of the paystub.

employment_details

object

Details related to the employment.

confidence_scores

array of objects

An array containing information about the confidence scores associated with fields in this document.

confidence_scores

object

confidence

integer

A number representing the confidence score.

key

string

The value that this confidence score is attributed to.

Response body

object

status

integer

A numerical code that indicates the status of the request.

code

integer

A numerical code that indicates the nature of an error.

response

object

An object received from the server that potentially contains data.

Has additional fields

message

string

Defaults to OK

A textual description that indicates details about this response's status.

meta

object

An object received from the server that potentially contains data.

status

integer

A numerical code that indicates the status of the request.

message

string

A textual description that indicates details about this response's status.

code

integer

A numerical code that indicates the nature of an error.

Updated 2 days ago

Doc form data

Form data

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.ocrolus.com/v2/document/doc_uuid/paystub \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated 2 days ago

Doc form data

Form data

Did this page help you?

Ocrolus API
Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication
Grant authentication tokenpost

Book Commands
Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries
Book informationget
Book listget
Book statusget

File Uploads
Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands
Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries
Retrieve Mixed Document statusget

Classify
Book classification summaryget
Mixed Doc classification summaryget

Capture
Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect
Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Vendor authenticationput
Retrieve business verificationget
Create business verificationpost
Object Definitions
Supporting data values
Supporting data
Visualization region
Visualization
Signal
Form analysis
Document analysis
Signal analysis

Analyze
Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks
Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks
Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Ocrolus API
Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication
Grant authentication tokenpost

Book Commands
Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries
Book informationget
Book listget
Book statusget

File Uploads
Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands
Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries
Retrieve Mixed Document statusget

Classify
Book classification summaryget
Mixed Doc classification summaryget

Capture
Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect
Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Vendor authenticationput
Retrieve business verificationget
Create business verificationpost
Object Definitions
Supporting data values
Supporting data
Visualization region
Visualization
Signal
Form analysis
Document analysis
Signal analysis

Analyze
Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks
Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks
Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

200Success

400Client Errors