Schema

Data types for API resources

FolderReference

Field Name

Data Type

Comment

id

String

Unique identifier

name

String

Display name of the folder

File

Field Name

Data Type

Comment

id

String

Unique identifier

folder_reference

FolderReference

Folder the file belongs to

documents

Array<Document>

Logical documents in the file

created_at

String

RFC 3339 date time

Document

Field Name

Data Type

Comment

id

String

Unique identifier

type

String

Extracted document type

version

Integer

Schema version of the extracted data specific to the document type

structured_data

Union

See the Structured Data table for mapping the type and version to the corresponding schema.

Structured Data

Type

Version

Schema

accounts_payable_invoice

1

AccountsPayableInvoiceV1

bill_of_lading

1

BillOfLadingV1

air_waybill

1

AirWaybillV1

commercial_invoice

1

CommercialInvoiceV1

PostalAddressV1

Field Name

Data Type

Comment

address_lines

Array<String>

Text lines of the address