Skip to end of banner
Go to start of banner

Check Processing Status and Get Document Information

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Once the document is submitted and processed, check its processing status by examining the document information. It is retrieved with a GET request containing the document URI. When the document is processed, retrieve its extractions and layout.

Request
Headers

Header

Value

Accept

application/vnd.gini.v1+json

Response
Headers

Status Code

Description

200 (OK)

Operation is successful.

Header

Value

Content-Type

application/vnd.gini.v1+.json

Body (application/vnd.gini.v1+json)

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. found extractions or document layout.

extractions

string

Document extractions URI

layout

string

Document layout URI.

processed

string

Processed document URI.

document

string

Document URI.

Errors

Status Code

Description

404 (Not Found)

Returned when no document can be found under specific URI.

  • No labels