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!

Form Data

{

Attribute

Data Type

Description

pk

PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints.

form_type

Text

Form Type code provided by your Implementations Lead

form_config_pk

Integer

PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints. of Form Configuration

raw_fields

Map of Field Data

An object that will contain one mapping for every field specified in the Form Configuration

tables

List of Tables

}

Field Data

{

Attribute

Data Type

Description

value

Text

Value captured for field

is_empty

Boolean

Confirms whether value was empty on source Document

alias_used

Text

Field alias used during capture, returned as null if not applicable

source_filename

Text

Filename for source Document

page_doc_pk

Page PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints.

}

Updated about a year ago


Form Data


Suggested Edits are limited on API Reference Pages

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