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
- API_V8_PARTNER_ANYDOCUMENTS_ANYDOCUMENTRESPONSE
- Array [
- ]
- Array [
- CheckFraudPage
- Array [
- ]
- ]
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.
meta object
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.
pages object[]
Possible values: <= 1
The average OCR score of the page.
The width of the page.
The height of the page.
Possible values: non-empty
Default value: ``
Tags associated with the document.
Possible values: <= 1
The average OCR score of the whole document.
Possible values: non-empty
The version of the model used to process the document.
fraud object
An object that contains additional information to help check for fraud.
Possible values: <= 1
Confidence of Fraud Detector in it's prediction
Possible values: [LCD photo, not a document, duplicate, screenshot, generated document, aspect ratio mismatch]
List of attributions which marked the document as fraud
pages object[]
An array containing fraud info about each extracted page
is_lcd object
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
The extracted value.
flags object[]
List of flags which marked the document as fraud
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
Possible values: non-empty
Indicates that all four corners of the check are visible and within the boundaries of the image.
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 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
Deprecated. The blueprint name which was used to extract the data. Same as blueprint_name.
{}