Overview

Current Endpoint: https://api.simplecertifiedmail.com/RESTv4.0

SimpleCertifiedMail.com's REST API exposes a number of methods that support third party integration with our service. Integrators may create certified or priority labels, and follow up by looking for status updates via our suite of tracking methods. The REST API also supports our partners who need outsourced printing services by exposing the "queuePrintItem" method that accepts a PDF representation of the piece to be printed and mailed. For more information please choose the name of a method on the left for sample input and output formats as well as additional details on required fields.

Get Access Token

Purpose

The SCM REST API utilizes bearer token authentication. Calls to each method require users to present a valid token in the header. To generate the token you will need to set User Name, Password, Client Code, and Partner Key and hit the /token service.

Route

https://api.simplecertifiedmail.com/RESTv4.0/token

Sample Inputs

Sample Outputs

Get Certified Label

Purpose

Fetch a USPS Certified Mail label. Users must pass along the sender and recipient data as well as the information related to label size and weight. The return will contain the tracking code and a base64 encoded representation of the label.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getcertifiedlabel

Sample Inputs

Sample Outputs

Get Priority Label

Purpose

Fetch a USPS Priority Mail label. Users must pass along the sender and recipient data as well as the information related to label size and weight. The return will contain the tracking code and a base64 encoded representation of the label.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getprioritylabel

Sample Inputs

Sample Outputs

Queue Print Item

Purpose

This method is at the heart of SCM’s outsourced printing offering. Users of this method can enqueue mail pieces for third party printing and mailing via a variety of services. If Certified Mail is chosen as an additional service, SCM will perform the same tracking/reporting/retention on these items as those labels produced via the web application or our two “Get Label” API methods. With “Queue Print Item” the user must transmit a base64 encoded PDF representation of the letter for printing along with the sender and recipient information.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/queueprintitem

Sample Inputs

Sample Outputs

Get Document Status

Purpose

Get the currently-available tracking status for the specified piece(s). User may pass in either a single tracking code in the PIC field, or specify a date range (no greater than 1 month) to retrieve tracking data on a set of items created within the date range. If both a PIC and a date range are passed in, the single PIC is used and the date range is ignored.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getdocumentstatus

Sample Inputs

Sample Outputs

Get Document Status By Ref

Purpose

This method is similar to “Get Document Status”, but performs a search by the “ToReference” parameter instead of tracking number or date range.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getdocumentstatusbyref

Sample Inputs

Sample Outputs

Get Document Status By Item Id

Purpose

Another means of searching for document status, in this case by the “Item ID” parameter.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getdocumentstatusbyitemid

Sample Inputs

Sample Outputs

Get Production Report

Purpose

Provides a report on production across a timeframe, or a daily snapshot. The results are transmitted as a base64 encoded Excel document with a row per item printed.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getproductionreport

Sample Inputs

Sample Outputs

Get Print Status Update

Purpose

Meant as a supplementary method for “Queue Print Item”, this method returns a set of all unviewed status messages related to pieces sent via “Queue Print Item”. Requesting these messages then flags the status entries as “viewed” so they will not be retransmitted.

Route

https://api.simplecertifiedmail.com/RESTv4.0/api/scm/getprintstatusupdate

Sample Inputs

Sample Outputs