Get Documents from PDF

GET 
/api/v8/partner/documents-set/:document_id

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

Request

Path Parameters

document_id int64required

The unique identifier of the Document processed by the PDF Document Splitter.

Responses

200

The processed Document response.

application/json

Schema

Schema

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)

{
  "id": 0,
  "documents_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)

{}

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)

{}

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)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

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

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

status stringrequired

Possible values: [fail, ok]

error string
message stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "message": "string",
  "details": [
    {}
  ]
}

Loading...