Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Verification of Employment

An employment verification letter confirms the employment status of an individual for either a current or a previous employer. It is often provided upon request for information from a potential bank government agency or lender.

JSON Attribute

Data Type

Description

verification_of_employment-Part1-General:employeeName

Text

Employee Name

verification_of_employment-Part1-General:last4OfSocialSecurityNumber

Text

Last 4 Of Social Security Number

verification_of_employment-Part1-General:employer/companyName

Text

Employer/Company Name

verification_of_employment-Part1-General:currentAsOf

Date

Current As Of

verification_of_employment-Part1-General:verifiedOn

Date

Verified On

verification_of_employment-Part1-General:year

Integer

Year

verification_of_employment-Part2-EmploymentInformation:employmentStatus

Text

Employment Status

verification_of_employment-Part2-EmploymentInformation:mostRecentStartDate

Date

Most Recent Start Date

verification_of_employment-Part2-EmploymentInformation:originalHireDate

Date

Original Hire Date

verification_of_employment-Part2-EmploymentInformation:presentPosition

Text

Present Position

verification_of_employment-Part2-EmploymentInformation:rateOfPayAmount

Money

Rate Of Pay Amount

verification_of_employment-Part2-EmploymentInformation:rateOfPayFrequency

WEEKLY
MONTHLY
ANNUAL
SEMI-MONTHLY
BI-WEEKLY
HOURLY
DAILY

Rate Of Pay Frequency

verification_of_employment-Part2-EmploymentInformation:averageHoursPerPayPeriod

Number

Average Hours Per Pay Period

verification_of_employment-Part2-EmploymentInformation:amountOfLastPayIncrease

Money

Amount Of Last Pay Increase

verification_of_employment-Part2-EmploymentInformation:dateOfApplicantsLastIncrease

Date

Date Of Applicants Last Increase

verification_of_employment-Part2-EmploymentInformation:grossBasePay

Money

Gross Base Pay

verification_of_employment-Part2-EmploymentInformation:grossBasePayType

Text

Gross Base Pay Type

verification_of_employment-Part2-EmploymentInformation:wvoeThruDate

Date

WVOE Thru Date

verification_of_employment-Part3-IncomeInformation:year1

Integer

Year 1

verification_of_employment-Part3-IncomeInformation:baseSalary1

Money

Base Salary 1

verification_of_employment-Part3-IncomeInformation:overtime1

Money

Overtime 1

verification_of_employment-Part3-IncomeInformation:commission1

Money

Commission 1

verification_of_employment-Part3-IncomeInformation:bonus1

Money

Bonus 1

verification_of_employment-Part3-IncomeInformation:otherIncome1

Money

Other Income 1

verification_of_employment-Part3-IncomeInformation:totalPay1

Money

Total Pay 1

verification_of_employment-Part3-IncomeInformation:year2

Integer

Year 2

verification_of_employment-Part3-IncomeInformation:baseSalary2

Money

Base Salary 2

verification_of_employment-Part3-IncomeInformation:overtime2

Money

Overtime 2

verification_of_employment-Part3-IncomeInformation:commission2

Money

Commission 2

verification_of_employment-Part3-IncomeInformation:bonus2

Money

Bonus 2

verification_of_employment-Part3-IncomeInformation:otherIncome2

Money

Other Income 2

verification_of_employment-Part3-IncomeInformation:totalPay2

Money

Total Pay 2

verification_of_employment-Part3-IncomeInformation:year3

Integer

Year 3

verification_of_employment-Part3-IncomeInformation:basePay3

Money

Base Pay 3

verification_of_employment-Part3-IncomeInformation:overtime3

Money

Overtime 3

verification_of_employment-Part3-IncomeInformation:commission3

Money

Commission 3

verification_of_employment-Part3-IncomeInformation:bonuses3

Money

Bonuses 3

verification_of_employment-Part3-IncomeInformation:otherIncome3

Money

Other Income 3

verification_of_employment-Part3-IncomeInformation:totalPay3

Money

Total Pay 3

verification_of_employment-Part4-Signature:signatureOfEmployer

SIGNED
NOT SIGNED

Signature Of Employer

verification_of_employment-Part4-Signature:signatureDate

Date

Signature Date

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Sample JSON Result

{
    "status": 200,
    "response": {
        "pk": 25751435,
        "uuid": "8309f90a-78ca-4bca-b16b-c3604aeccfca",
        "forms": [
            {
                "pk": 27722220,
                "uuid": "33daaf30-959e-457f-851e-f77808e78e0b",
                "form_type": "VERIFICATION_OF_EMPLOYMENT",
                "form_config_pk": 11142,
                "tables": [],
                "raw_fields": {
                    "verification_of_employment-Part3-IncomeInformation:year1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:year2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:year3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part4-Signature:signatureDate": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:bonus1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:bonus2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:basePay3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:bonuses3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:overtime1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:overtime2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:overtime3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:totalPay1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:totalPay2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:totalPay3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:baseSalary1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:baseSalary2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:commission1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:commission2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:commission3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part4-Signature:signatureOfEmployer": {
                        "value": "NOT SIGNED",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:otherIncome1": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:otherIncome2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part3-IncomeInformation:otherIncome3": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:wvoeThruDate": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:year": {
                        "value": "2020",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:verifiedOn": {
                        "value": "08/28/2020",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:currentAsOf": {
                        "value": "08/21/2020",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:employeeName": {
                        "value": "BRYAN ARCHIBALD",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:employer/companyName": {
                        "value": "HATTEN AND HATTEN LLP",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:grossBasePay": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part1-General:last4OfSocialSecurityNumber": {
                        "value": "6782",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:presentPosition": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:rateOfPayAmount": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:employmentStatus": {
                        "value": "ACTIVE",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:grossBasePayType": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:originalHireDate": {
                        "value": "11/01/2018",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:rateOfPayFrequency": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:mostRecentStartDate": {
                        "value": "11/01/2018",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:amountOfLastPayIncrease": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:averageHoursPerPayPeriod": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    },
                    "verification_of_employment-Part2-EmploymentInformation:dateOfApplicantsLastIncrease": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Verification of Employment.pdf"
                    }
                }
            }
        ]
    },
    "message": "OK"
}

Updated 12 days ago


Verification of Employment


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.