Get a document

Get a document for Shipper

This object is used to get the document(s) with the help of the shipper hash and the document hash.

URL Config

Endpoint: https://api.dps.io/api
APIVersion: v1
route: documents
path: <YOUR_SHIPPER_HASH>/<YOUR_DOCUMENT_HASH>

Method

GET

URL

https://api.dps.io/api/v1/documents/Hlr******************jbV

Request Headers

{
  "Content-Type": "application/json",
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR_SHIPPER_HASH>"
}

Request Body

Curl request

curl --location --request GET 'https://api.dps.io/api/v1/documents/Hlr******************jbV' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9************BJG6a'

Response

[
    {
        "CreatedDate": "2022-11-08 19:24:45.631531",
        "LastModified": "2022-11-08 19:28:13.739444",
        "Id": 1868,
        "DocumentHash": "Hlr************************jbV",
        "ShipperHash": "05K9*****************JG6a",
        "useddocumenthashes": "Hlr******************jbV",
        "printerdocumentid": "",
        "FileHash": "4b41a************************a56a",
        "FileName": "sample.pdf",
        "Tags": "sample, pdf",
        "Description": "Sample PDF document to upload",
        "Path": "multi_file_pdf/dev/Hlr******************jbV.pdf",
        "PageCount": 2,
        "DocSize": 2.96,
        "DocType": "SingleDoc",
        "isdeleted": false,
        "isencrypted": false,
        "status": "Document is ready.",
        "Weight": 0.44,
        "DocumentName": "PUMA SOFT RIDE ENZO",
        "DocInfo": [
            {
                "Dimension": "8.5*11.0",
                "Print2MailAcceptable": true,
                "Pages": 2
            }
        ],
        "ItemId": "PU45856AAA84p1",
        "Category": "test document",
        "uniquedocumentid": "DPSDI-00051-00004"
    }
]