Skip to content
Shipping APIs
/
/
Signature Image ERR

Signature Image ERR

Request

This API provides a downloadable link containing the signature image for a specific ERR (Electronic Return Receipt) shipment. This signature image serves as Proof of Delivery (POD).
What is Proof of Delivery (POD)?
Proof of Delivery is a document or file that acts as evidence of successful shipment delivery. This file contains a digital copy of the recipient's signature, provided as a downloadable link or URL.

Key Considerations:

  • It provides the recipient's signature image captured at the time of delivery as proof that the shipment was successfully delivered.
  • The API provides the recipient's signature image as Proof of Delivery (POD) to confirm successful shipment delivery.
  • A request requires the mandatory shipmentId.
  • If a signature is captured by the carrier, the API returns it as a downloadable link of the PDF in the signatureFileURL field.
  • The signatureFileURL provided in the API response expires after 60 minutes.
  • If no signature is available, the API returns an error.
  • Signature Image ERR is supported for USPS carrier only.
Security
bearerAuth
Path
shipmentIdstringrequired

Shipment ID is a unique identifier for an individual shipment.

Headers
X-PB-Developer-Partner-IDstring

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required.

curl -i -X GET \
  'https://api-dev.sendpro360.pitneycloud.com/shipping/api/v1/err/shipments/{shipmentId}/signaturefile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-ID: string'

Responses

Signature image as proof of delivered shipment.

Bodyapplication/json
shipmentIdstring

Indicates the shipment identifier, a unique identifier for an individual shipment.

Example:"USPS2200592809609000"
signatureFileURLstring

A link or URL that consists of Proof of Delivery (POD) - Recipient's Signature image file. Clicking the link will download the POD Signature.

Example:"https://api-sandbox.pitneybowes.com/shippingservices/v1/shipments/210000000000000000/sig.jpg"
Response
{
  "shipmentId": "USPS2200592809609000",
  "signatureFileURL": "https://api-sandbox.pitneybowes.com/shippingservices/v1/shipments/210000000000000000/sig.jpg"
}