Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Key

Child Key

Type

Description

id

string

Document qnique identifier (such as UUID Version 1).

name

string

Document name (as stated in upload).

pageCount

number

Number of pages.

creationDate

number

Document creation unix timestamp (in milliseconds).

origin

string

Document source channel: UPLOAD (if uploaded via Gini Pay API) or UNKNOWN.

progress

string

Document processing status: PENDING, COMPLETED or ERROR.

sourceClassification

string

Classification of the source file: SCANNED, SANDWICH, NATIVE or TEXT.

pageNumber

number

Document page number.

images

object

Pre-rendered page image URIs.

_links

array

List of related resources, e.g. for example, found extractions or document layout.

extractions

string

Document extractions URI

layout

string

Document layout URI.

processed

string

Processed document URI.

document

string

Document URI.

...