Get a Markdown Document
GET/api/v8/partner/document-to-markdown/:document_id
Veryfi's Get a Markdown Document endpoint allows you to retrieve a previously processed Markdown Document.
Request
Path Parameters
The unique identifier of the document.
Query Parameters
A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.
A field used to determine whether or not to return the score and ocr_score fields in the Document response.
Responses
- 200
Returns a processed Markdown Document.
- application/json
- Schema
- Example (from schema)
Schema
- API_V8_PARTNER_DOCUMENTTOMARKDOWN_DOCUMENTTOMARKDOWNRESPONSE
The database ID of the markdown document
The markdown content of the converted document.
Page structures returned when details is true.
Type of document
External reference ID
Processing status
S3 path to the markdown document
S3 URL to the PDF file
S3 URL to the image file
Creation timestamp
Last update timestamp
Default value: ``
Document tags
{}