Get Document By ID

  1. API Docs
  2. Documents
  3. Get Document By ID

This allows the user to retrieve a document using it's id.

Parameters
Parameter Type Required Default Description
id Int | String Yes N/A The document's ID found in your CheckIssuing dashboard or in the document's information returned from various API calls
To obtain the file information, pass the file ID prefixed with the "file-" string, e.g., file-245.
Sample Response
Document
{
    "status": 1,
    "document": {
        "id": "4398",
        "client_id": "1100",
        "user_id": "1935",
        "file_id": "244",
        "wl_id": null,
        "status_id": "2",
        "postage_id": "1",
        "type_id": "1",
        "created_ts": "2024-01-18 12:45:13",
        "issue_ts": "2024-01-18 12:45:13",
        "updated_ts": null,
        "sent_ts": null,
        "recipient": "Test C1_CS_1P_P1",
        "address": "417 hall st, warren oh 44483417 Hall st, Warren OH 44483",
        "return_address": null,
        "file_path": "c2/47/1b/1page_color.146.pdf",
        "pages": "1",
        "ref": "",
        "cover": "1",
        "color": "1",
        "duplex": "0",
        "fees": "0.00",
        "confirmed": "1",
        "deleted": "0"
    },
    "errors": [],
    "error_message": null
}
File
{
    "status": 1,
    "document": [
        {
            "id": "4403",
            "client_id": "1100",
            "user_id": "1935",
            "file_id": "245",
            "wl_id": null,
            "status_id": "2",
            "postage_id": "1",
            "type_id": "1",
            "created_ts": "2024-01-18 12:48:43",
            "issue_ts": "2024-01-18 12:48:43",
            "updated_ts": null,
            "sent_ts": null,
            "recipient": "BTest C1_CS_1P_P1",
            "address": "417 hall st, warren oh 44483417 Hall st, Warren OH 44483",
            "return_address": null,
            "file_path": "c2/47/1b/1page_color.147.pdf",
            "pages": "1",
            "ref": "",
            "cover": "1",
            "color": "1",
            "duplex": "0",
            "fees": "0.00",
            "confirmed": "1",
            "deleted": "0"
        },
        {
            "id": "4404",
            "client_id": "1100",
            "user_id": "1935",
            "file_id": "245",
            "wl_id": null,
            "status_id": "2",
            "postage_id": "1",
            "type_id": "1",
            "created_ts": "2024-01-18 12:48:43",
            "issue_ts": "2024-01-18 12:48:43",
            "updated_ts": null,
            "sent_ts": null,
            "recipient": "BTest C1_BD_2P_P2",
            "address": ",   ",
            "return_address": null,
            "file_path": "0b/15/c2/2page_bw.102.pdf",
            "pages": "2",
            "ref": "",
            "cover": "1",
            "color": "0",
            "duplex": "1",
            "fees": "0.00",
            "confirmed": "1",
            "deleted": "0"
        },
        {
            "id": "4405",
            "client_id": "1100",
            "user_id": "1935",
            "file_id": "245",
            "wl_id": null,
            "status_id": "2",
            "postage_id": "1",
            "type_id": "1",
            "created_ts": "2024-01-18 12:48:43",
            "issue_ts": "2024-01-18 12:48:43",
            "updated_ts": null,
            "sent_ts": null,
            "recipient": "BTest C1_CS_3P_P5",
            "address": "100 Fulton Ct, Paducah KY 42001",
            "return_address": null,
            "file_path": "ba/45/c1/3page_color.26.pdf",
            "pages": "3",
            "ref": "",
            "cover": "1",
            "color": "1",
            "duplex": "0",
            "fees": "0.00",
            "confirmed": "1",
            "deleted": "0"
        },
        {
            "id": "4406",
            "client_id": "1100",
            "user_id": "1935",
            "file_id": "245",
            "wl_id": null,
            "status_id": "2",
            "postage_id": "1",
            "type_id": "1",
            "created_ts": "2024-01-18 12:48:43",
            "issue_ts": "2024-01-18 12:48:43",
            "updated_ts": null,
            "sent_ts": null,
            "recipient": "BTest C0_BD_4P_P1",
            "address": "100 HRESAN BLVD, FAYETTEVILLE WV 25840-1333",
            "return_address": null,
            "file_path": "12/e6/2c/4page_bw.26.pdf",
            "pages": "4",
            "ref": "",
            "cover": "0",
            "color": "0",
            "duplex": "1",
            "fees": "0.00",
            "confirmed": "1",
            "deleted": "0"
        },
        {
            "id": "4407",
            "client_id": "1100",
            "user_id": "1935",
            "file_id": "245",
            "wl_id": null,
            "status_id": "2",
            "postage_id": "1",
            "type_id": "1",
            "created_ts": "2024-01-18 12:48:43",
            "issue_ts": "2024-01-18 12:48:43",
            "updated_ts": null,
            "sent_ts": null,
            "recipient": "",
            "address": "100 Purity RdSuite 3, Pittsburgh PA 15235",
            "return_address": null,
            "file_path": "dd/e3/5e/7page_color.23.pdf",
            "pages": "7",
            "ref": "",
            "cover": "1",
            "color": "1",
            "duplex": "1",
            "fees": "0.00",
            "confirmed": "1",
            "deleted": "0"
        }
    ],
    "files": {
        "id": "245",
        "client_id": "1100",
        "user_id": "1935",
        "tpl_id": null,
        "uploaded_ts": "2024-01-18 12:48:43",
        "processed_ts": "2024-01-18 12:48:43",
        "confirmed_ts": "2024-01-18 11:48:43",
        "orig_fname": "MixedDocTestFAILURE.csv",
        "file_path": "4b/c9/cb/mixeddoctestfailure.csv",
        "num_docs": "5",
        "errors": null,
        "processed": "1",
        "confirmed": "1",
        "deleted": "0"
    },
    "errors": [],
    "error_message": null
}