DOCUMENTS

By Mailing File ID

Retrieve the documents associated with a mailing file ID.

Class: documents

Method: by-mailing-file-id

POST/documents/by-mailing-file-id

Parameters

  • client_id*
  • akey*
  • mailing_file_id* - unique document mailing file identifier

JSON response

JSONResponse example
{
  "documents": [
    {
      "id": "120604",
      "confirmed": false,
      "document_type": "single",
      "print_type": "black_white",
      "mail_to": "",
      "address": "",
      "address2": "",
      "city": "",
      "state": "",
      "zip": "",
      "country": "",
      "trans_id": "PAY-2026-001042",
      "address_position_type": "single_top_left",
      "document_return_address_option": "custom",
      "document_return_address": "Northstar Supply Co.|1800 Meridian Avenue|Suite 200|Denver, CO 80202",
      "status": {
        "id": "1",
        "name": "Pending Release"
      }
    }
  ]
}

XML response

XMLResponse example
<wmc-response status="1">
	<documents>
		<document id='120605'>
			<id>120605</id>
			<confirmed>0</confirmed>
			<document_type>single</document_type>
			<print_type>black_white</print_type>
			<mail_to></mail_to>
			<address></address>
			<address2></address2>
			<city></city>
			<state></state>
			<zip></zip>
			<country></country>
			<trans_id>PAY-2026-001042</trans_id>
			<address_position_type>single_top_left</address_position_type>
			<document_return_address_option>custom</document_return_address_option>
			<document_return_address>Northstar Supply Co.|1800 Meridian Avenue|Suite 200|Denver, CO 80202</document_return_address>
			<status_id>1</status_id>
		</document>
	</documents>
</wmc-response>

Search documentation