Technical Specifications
      Back to home
      1. Help Center
      2. Technical Specifications

      JSON Specifications

      Letters

      Overview

      The letter object represents a single package being transferred.

      Below outlines the standard JSON configuration.

      KEY TYPE NULLABLE Required/ Optional DESCRIPTION
      id string not nullable Required  Unique record ID (Client's system of record)
      SubAccount string nullable Optional Client Sub Account / Division / Dept
      DocumentType string nullable Optional Meta-data added to reconcile the calls for different types of statements being printed.  (ie Deposit, Loan, Loan Payment)
      HouseholdIndicator boolean not nullable Required Represents whether or not this record is eligible to be householded with other records with matching HouseholdGroupID and consolidated into one envelope
      true : allow householding
      false : never household regardless of matching HouseholdGroupId
      HouseholdGroupId string nullable Optional Id used to group multiple documents into the same envelope / recipient
      to object not nullable Required An address object that specifies the recipient address of the resource.
      to.name string nullable Required unless to.Company is populated First line of the recipient address Either  to.name or to.company will always be present, you may also use both.
      to.company string nullable Optional unless to.Name isn't populated Second line of the recipient address to be printed under to.name . Either  to.name or to.company will always be present, you may also use both.
      to.address_line1 string not nullable Required First part of the address's primary line. Should be combined with to.address_line2 to form entire primary line of the address block.
      to.address_line2 string nullable Optional Second part of the address's primary line. Should be combined with  to.address_line1 to form the entire primary line of the address block.
      to.address_city string nullable Required Will always be present for US addresses
      to.address_state string nullable Required Will always be present for US addresses
      to.address_zip string nullable Required Will always be present for US addresses
      to.address_country string not nullable Optional Should be printed as the last line of the address for non US addresses.
      from object not nullable Required An address object that specifies the return address of the resource
      from.name string nullable Optional unless IMS is printing return address First line of the return address. Either  from.name or from.company will always be present, you may also receive both.
      from.company string nullable Optional unless IMS is printing return address Second line of the return address to be printed under  from.name Either  from.name or from.company will always be present, you may also receive both.
      from.address_line1 string not nullable Optional unless IMS is printing return address First part of the address's primary line. Should be combined with from.address_line2 to fo the entire primary line of the address block.
      from.address_line2 string nullable Optional Second part of the address's primary line. Should be combined with  from.address_line1 form the entire primary line of th address block.
      from.address_city string nullable Optional unless IMS is printing return address Will always be present for US addresses
      from.address_state string nullable Optional unless IMS is printing return address Will always be present for US addresses
      from.address_zip string nullable Optional unless IMS is printing return address Will always be present for US addresses
      from.address_country string not nullable Optional Should be printed as the last line of the address for non US addresses.
      imb_code string nullable Optional The code used to create the IMB
      mail_type enum not nullable Required Represents the postage mail class ("usps_first_class" / "usps_first_standard")
      extra_service enum nullable  Optional "certified" / "certified_return_receipt" /"certificate_of_mailing" 
      mail_date string nullable Optional The date in  YYYY-MM-DD at which a file should be sent out. When present, will be used instead of the normal SLA production window.
      object enum not nullable Required Represents the type of resource this order oject describes. Value will always be one of:
      check/ letter/ postcard.
      color boolean not nullable Required Represents color printing. true : print in color false : print in grayscale
      double_sided boolean not nullable Required Represents duplex or simplex printing.
      true : print duplex
      false : print simplex
      address_placement enum not nullable Required Represents location of the addr stamp. Will be one of:
      top_first_page : top of the first page
      insert_blank_page : top left of an additional blank page
      bottom_first_page : bottom of the first page centered or left-aligned depending on the envelope
      sheets integer not nullable Required Represents the number of sheets for the final piece.
      return_envelope enum nullable Optional Represents a return envelope is included in the mailing. Will be one of:
      null : Do not include any return envelope
      no_9_single_window : Include a standard Number Single Window return envelope
      Any other  id : use the associated envelope from inventory
      perforated_sheet integer nullable Optional Perforate the specified sheet of integer passed. If  null , do no perforate any sheet.
      envelope_ID enum nullable Required Represents the envelope used for the mail piece. (IMS assigned SKU)
      size enum not nullable Required The final size of the letter. IMS default:  "us_letter". Optional integration: "us_legal"
      sla integer nullable Required Expected production SLA in business days. For example, if
      sla=2 , the order should be produced and mailed within 2
      business days.

      Example JSON (Letter)