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
document[wl_id] String No N/A ID of the whitelabel to use
document[issue_ts] String No N/A Date to send the statement on
document[recipient] String Yes N/A The recipients name
document[address] String Yes N/A The recipients address
document[return_address] String No N/A The return address to print on the statement
document[file] String No N/A Name of the pdf for this statement
document[ref] String No N/A Internal Reference
document[cover] String No N/A Boolean indicating if the statement requires a coversheet
document[color] String No N/A Print in color
document[duplex] String No N/A Print front and back
document[generic1] String No N/A Generic Field #1
document[generic2] String No N/A Generic Field #2
document[generic3] String No N/A Generic Field #3
document[generic4] String No N/A Generic Field #4
document[generic5] String No N/A Generic Field #5
document[generic6] String No N/A Generic Field #6
document[generic7] String No N/A Generic Field #7
document[generic8] String No N/A Generic Field #8
document[generic9] String No N/A Generic Field #9
document[generic10] String No N/A Generic Field #10
document[generic11] String No N/A Generic Field #11
document[generic12] String No N/A Generic Field #12
document[generic13] String No N/A Generic Field #13
document[generic14] String No N/A Generic Field #14
document[generic15] String No N/A Generic Field #15
document[generic16] String No N/A Generic Field #16
document[generic17] String No N/A Generic Field #17
document[generic18] String No N/A Generic Field #18
document[generic19] String No N/A Generic Field #19
document[generic20] String No N/A Generic Field #20
document[generic21] String No N/A Generic Field #21
document[generic22] String No N/A Generic Field #22
document[generic23] String No N/A Generic Field #23
document[generic24] String No N/A Generic Field #24
document[generic25] String No N/A Generic Field #25
document[generic26] String No N/A Generic Field #26
document[generic27] String No N/A Generic Field #27
document[generic28] String No N/A Generic Field #28
document[generic29] String No N/A Generic Field #29
document[generic30] String No N/A Generic Field #30
document[generic31] String No N/A Generic Field #31
document[generic32] String No N/A Generic Field #32
document[generic33] String No N/A Generic Field #33
document[generic34] String No N/A Generic Field #34
document[generic35] String No N/A Generic Field #35
document[generic36] String No N/A Generic Field #36
document[generic37] String No N/A Generic Field #37
document[generic38] String No N/A Generic Field #38
document[generic39] String No N/A Generic Field #39
document[generic40] String No N/A Generic Field #40
document[template_id] String No N/A Template to use for mail merge style statements
document[template_id] String No N/A Template to use for mail merge style statements
document[address] String Yes N/A The recipients address
document[recipient] String Yes N/A The recipients name
document[ref] String No N/A Internal Reference
document[generic1] String No N/A Generic Field #1
document[generic2] String No N/A Generic Field #2
document[generic3] String No N/A Generic Field #3
document[generic4] String No N/A Generic Field #4
document[generic5] String No N/A Generic Field #5
document[generic6] String No N/A Generic Field #6
document[generic7] String No N/A Generic Field #7
document[generic8] String No N/A Generic Field #8
document[generic9] String No N/A Generic Field #9
document[generic10] String No N/A Generic Field #10
document[generic11] String No N/A Generic Field #11
document[generic12] String No N/A Generic Field #12
document[address2] String No N/A The recipients address 2
document[city] String No N/A The recipients city
document[state] String No N/A The recipients state
document[zip] String No N/A The recipients zip
document[date] String No N/A Generic Date Field
document[address2] String No N/A The recipients address 2
document[city] String No N/A The recipients city
document[state] String No N/A The recipients state
document[zip] String No N/A The recipients zip
document[date] String No N/A Generic Date Field
document[ignore] String No N/A Ignored and not saved
document[ignore] String No N/A Ignored and not saved
document[type_id] String No N/A Type of document
Can be the numeric id or short_name of any defined document types
insert File No N/A PDF uploaded as an HTTP file upload if you wish to upload an insert to use with this document.
Sample Response
{"status": 1, "document": { "id": 4197, "client_id": "1100", "user_id": "1", "wl_id": "6", "type_id": "5", "status_id": 1, "postage_id": "1", "issue_ts": "2023-07-25 00:00:01", "recipient": "xsdfsdf", "address": null, "return_address": null, "file_path": "c2/47/1b/1page_color.61.pdf", "pages": 1, "ref": "", "cover": 0, "color": 0, "duplex": 0, "confirmed": 1 }}