Retrieve a Review

get https://app.docupanda.io/review

This endpoint is used to retrieve a review object by either by its unique identifier or by its associated standardization ID.

Responses

Response body

object

standardizationId

string

required

Unique identifier of the standardization object.

documentId

string

required

Unique identifier of the document.

data

object

An exact copy of the original standardization JSON object, except every value is replaced with a dictionary with the following values:

value: The original value
review:
- page: (Under review) The page number on which the value was found
- confidence: (Under review) The confidence score of the value extraction
- boundingBox: (Under review) The bounding box of the value on the page. These will be normalized coordinates 0..1 for the page size, in the format:
  - x: The x-coordinate (starting from the left)
  - y: The y-coordinate (starting from the top)
  - width: The width of the bounding box
  - height: The height of the bounding box

Has additional fields

schemaId

string

Unique identifier of the schema used for standardization.

schemaName

string

Name of the schema used for standardization.

jobId

string

Unique identifier of the job that created the standardization.

dataset

string

Name of the dataset to which the document belongs

filename

string

Name of the file that was standardized.

timestamp

string

Timestamp of the standardization job.

metadata

object

Metadata associated with the document that originated this standardization. This just echoes any metadata you have previously posted on document creation.

Has additional fields

reviewId

string

Unique identifier of the review object.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.docupanda.io/review \
3
     --header 'accept: application/json'


xxxxxxxxxx
13
 
1
{
2
  "standardizationId": "string",
3
  "documentId": "string",
4
  "data": {},
5
  "schemaId": "string",
6
  "schemaName": "string",
7
  "jobId": "string",
8
  "dataset": "string",
9
  "filename": "string",
10
  "timestamp": "string",
11
  "metadata": {},
12
  "reviewId": "string"
13
}

200Successful Response

422Validation Error