Add Document

  1. API Docs
  2. Documents
  3. Add Document

This method adds a document to the system. The parameters and the JSON/XML nodes returned vary based on the specific document type. The Checkissuing API currently supports digital and printed checks, as well as ACH transfers (if enabled on your account). Pass the document parameter as an array in your post with the field names listed as the array's keys for their respective values. Once you successfully call this endpoint, you must confirm the document using the documents/confirm endpoint and the id returned in the result from this one. A document will not show in the panel or get processed/sent until it is confirmed.


For a full list of fields and they're purpose, see the table below.

Parameters
Parameter Type Required Default Description
wl_id String No N/A ID of the whitelabel to use
issue_ts String No N/A Date to send the statement on
recipient String Yes N/A The recipients name
address String Yes N/A The recipients address
return_address String No N/A The return address to print on the statement
file String No N/A Name of the pdf for this statement
ref String No N/A Internal Reference
cover String No N/A Boolean indicating if the statement requires a coversheet
color String No N/A Print in color
duplex String No N/A Print front and back
generic1 String No N/A Generic Field #1
generic2 String No N/A Generic Field #2
generic3 String No N/A Generic Field #3
generic4 String No N/A Generic Field #4
generic5 String No N/A Generic Field #5
generic6 String No N/A Generic Field #6
generic7 String No N/A Generic Field #7
generic8 String No N/A Generic Field #8
generic9 String No N/A Generic Field #9
generic10 String No N/A Generic Field #10
generic11 String No N/A Generic Field #11
generic12 String No N/A Generic Field #12
generic13 String No N/A Generic Field #13
generic14 String No N/A Generic Field #14
generic15 String No N/A Generic Field #15
generic16 String No N/A Generic Field #16
generic17 String No N/A Generic Field #17
generic18 String No N/A Generic Field #18
generic19 String No N/A Generic Field #19
generic20 String No N/A Generic Field #20
generic21 String No N/A Generic Field #21
generic22 String No N/A Generic Field #22
generic23 String No N/A Generic Field #23
generic24 String No N/A Generic Field #24
generic25 String No N/A Generic Field #25
generic26 String No N/A Generic Field #26
generic27 String No N/A Generic Field #27
generic28 String No N/A Generic Field #28
generic29 String No N/A Generic Field #29
generic30 String No N/A Generic Field #30
generic31 String No N/A Generic Field #31
generic32 String No N/A Generic Field #32
generic33 String No N/A Generic Field #33
generic34 String No N/A Generic Field #34
generic35 String No N/A Generic Field #35
generic36 String No N/A Generic Field #36
generic37 String No N/A Generic Field #37
generic38 String No N/A Generic Field #38
generic39 String No N/A Generic Field #39
generic40 String No N/A Generic Field #40
template_id String No N/A Template to use for mail merge style statements
address2 String No N/A The recipients address 2
city String No N/A The recipients city
state String No N/A The recipients state
zip String No N/A The recipients zip
date String No N/A Generic Date Field
ignore String No N/A Ignored and not saved
type_id String No N/A Type of document
Can be the numeric id or short_name of any defined document types
pdf_document File Yes N/A PDF uploaded as an HTTP file upload if not using a template id.
Sample Response
{
    "status": 1,
    "document": {
        "id": 4607,
        "client_id": "1100",
        "user_id": "1935",
        "wl_id": null,
        "type_id": 1,
        "status_id": 1,
        "postage_id": 1,
        "issue_ts": "2024-02-05 00:00:01",
        "recipient": "Rodney Jacobs",
        "address": "500 Rolling Mill Hill Rd, STE 500, Nashville TN 37210",
        "return_address": "500 Rolling Mill Hill Rd, STE 500, Nashville TN 37210",
        "pages": 2,
        "cover": 1,
        "color": 1,
        "duplex": 1,
        "confirmed": 1,
        "file_name": "1Page_Color 1.pdf",
        "reference": "Freeform-1PageDC wCover"
    },
    "errors": [],
    "error_message": null
}