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

page integer

Default value: 1

The page number. The response is capped to maximum of 50 results per page.

page_size integer
Default value: 50
The number of Documents per page.
Example: 10

Responses

200

Veryfi's Get a Submitted PDF endpoint allows you to retrieve a collection of previously processed documents.

application/json

Schema

Schema

count integerrequired

The total number of results retrieved across all pages.

next (string | null)

The URL to the next page of results.

previous (string | null)

The URL to the previous page of results.

results object[]required
The collection of Document identifiers processed by the PDF Splitter.
Array [
id integerrequired
The unique identifier of the collections of processed documents.
documents_id integer[]
The unique identifiers of the documents created from processed PDF Splitter.
status stringrequired
Possible values: [processed, in_progress, deleted, failed]
]

Example (from schema)

{
  "count": 0,
  "results": [
    {
      "id": 0,
      "status": "processed"
    }
  ]
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

THIS_API_KEY_IS_NOT_PERMITTED_TO_ACCESS_THIS_ROUTE

status string

Default value: fail

error string

Default value: This API key is not permitted to access this route

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 120 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status stringrequired

Possible values: [fail, ok]

error (string | null)
message stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "message": "string"
}

Loading...