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!

Identity Verification for PPP

Ocrolus enables lenders to verify the identity of a PPP applicant businesses main stakeholder(s). This identification document validation service supports both domestic US and international IDs.

The form_type parameter ID for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

πŸ“˜

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

id-Part1-General:documentType

PASSPORT
PASSPORT CARD
DRIVER'S LICENSE
STATE IDENTIFICATION CARD
OTHER

The type of the ID

id-Part1-General:documentExpirationDate

Date

Date of the ID's Expiration

id-Part1-General:documentNumber

Text

Number of the ID

id-Part1-General:issuingState

Text

Issuing State of the ID

id-Part1-General:countryName

UNITED STATES
OTHER

Issuing Country of the ID

id-Part2-Pii:firstName

Text

First name of the ID owner

id-Part2-Pii:lastName

Text

Last name of the ID owner

id-Part2-Pii:dateOfBirth

Date

Date of birth of the ID owner

id-Part2-Pii:addressLine1

Text

Address 1 of the ID owner

id-Part2-Pii:addressLine2

Text

Address 2 of the ID owner

id-Part2-Pii:city

Text

City of the ID owner

id-Part2-Pii:state

Text

State of the ID owner

id-Part2-Pii:zip

Text

5 digit Zip Code of the ID owner

Sample Form

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

Sample JSON Result

{
  "form_type": "ID",
  "pk": 4659787,
  "form_config_pk": 1671,
  "raw_fields": {
    "id-Part1-General:documentType": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "DRIVER'S LICENSE"
    },
    "id-Part1-General:documentExpirationDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "08/31/2014"
    },
    "id-Part1-General:documentNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "I1234568"
    },
    "id-Part1-General:issuingState": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "CA"
    },
    "id-Part1-General:countryName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "UNITED STATES"
    },
    "id-Part2-Pii:firstName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "IMA"
    },
    "id-Part2-Pii:lastName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "CARDHOLDER"
    },
    "id-Part2-Pii:dateOfBirth": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "08/31/1977"
    },
    "id-Part2-Pii:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "2570 24TH STREET"
    },
    "id-Part2-Pii:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": ""
    },
    "id-Part2-Pii:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "ANYTOWN"
    },
    "id-Part2-Pii:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "CA"
    },
    "id-Part2-Pii:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64212998,
      "source_filename": "Ocrolus Sample PDF - Identification.pdf",
      "value": "95818"
    }
  },
  "tables": []
}

Updated 6 months ago

Identity Verification for PPP


Suggested Edits are limited on API Reference Pages

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