Skip to main content

Get a ∀Doc

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

Retrieve a previously processed blueprinted document.

Request​

Path Parameters

    document_id int64required

    The unique identifier of the document.

Responses​

The processed Document.

Schema
    pdf_url uri

    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.

    id integerrequired

    The unique number created to identify the document.

    created_date date-timerequired
    updated_date date-timerequired
    img_thumbnail_url uri

    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.

    template_name stringrequired

    Possible values: non-empty

    The template name which was used to extract the data.

    external_id string

    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.

    property name* any
Loading...