Get Submitted PDF
GET/api/v8/partner/documents-set
Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents.
Request
Query Parameters
Default value: 1
The page number. The response is capped to maximum of 50 results per page.
Default value: 50
The number of Documents per page.
Responses
- 200
- 400
- 404
- 429
- 499
- 503
- default
Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The total number of results retrieved across all pages.
The URL to the next page of results.
The URL to the previous page of results.
results object[]required
The collection of Document identifiers processed by the PDF Splitter.
The unique identifier of the collections of processed documents.
The unique identifiers of the documents created from processed PDF Splitter.
Possible values: [processed
, in_progress
, deleted
, failed
]
{
"count": 0,
"next": "string",
"previous": "string",
"results": [
{
"id": 0,
"documents_id": [
0
],
"status": "processed"
}
]
}
User error
- application/json
- Schema
- Example (from schema)
Schema
- MALFORMED_PARAMETERS
Default value: fail
Default value: Malformed parameters
Default value: [object Object]
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [fail
, ok
]
{
"status": "fail",
"error": "string",
"message": "string",
"details": [
{}
]
}