Retrieves document artifacts. Ex: VRBL XML, PDF, etc.

Use this request to retrieve additional raw data related to the document.

Path Params
string
required

Document Id

string
required

Indicates the format of the artifact to download. The following formats are supported:

    VRBL
    The full representation of the invoice in the canonical form described by the VRBL Reference Guide


    PDF
    A human-readable version of selected information in the invoice


    LegalDocument
    The legal representation of the invoice. For Inbound invoices, this will be the exact document received. For Outbound invoices, this is the invoice as transmitted to the network


    Archive
    A ZIP file containing all artifacts related to the invoice. For a completed invoice, this will always include the VRBL, PDF, and legal document, and may include additional files like confirmations, acknowledgments, signature files, or timestamps depending on the jurisdiction


    Attachments
    A ZIP file containing any attachment files which are embedded in the VRBL document


    All
    All of the formats are retrieved
    Multiple formats can be retrieved in a single request by specifying "All" or by specifying a comma-delimited list of formats (like VRBL,PDF). If multiple downloads are requested, the response will have Content-Type: multipart/mixed and a Content-ID header will be included with the format for that part
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Internal Server Error

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/octet-stream
application/json