Get a ∀Doc
GET/api/v8/partner/any-documents/:document_id
Veryfi's Get a ∀Doc endpoint allows you to retrieve a previously processed ∀Doc.
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 ∀Doc.
- application/json
- Schema
- Example (from schema)
Schema
- AnyDocumentResponse
Possible values: non-empty and <= 2083 characters
A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.
The unique number created to identify the document.
Possible values: non-empty
A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.
Possible values: non-empty and <= 2083 characters
A signed URL to access the auto-generated thumbnail created for the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.
Possible values: non-empty
The blueprint name which was used to extract the data. Sample blueprints: [ "auto_insurance_card", "bill_of_lading", "flight_itinerary", "goods_received_note", "incorporation_document", "incorporation_document_latam", "indian_passport", "latam_passport", "prescription_medication_label", "product_nutrition_facts", "restaurant_menu", "shipping_label", "uk_drivers_license", "us_driver_license", "us_health_insurance_card", "us_passport", "vehicle_registration", "vendor_statement", "work_order"]
Possible values: non-empty
The blueprint name which was used to extract the data. Same as blueprint_name.
{}