Signature Image ERR

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.
SecuritybearerAuth
Request
path Parameters
shipmentId
required
string

Shipment ID is a unique identifier for an individual shipment.

header Parameters
X-PB-Developer-Partner-ID
string

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.

Responses
200

Signature image as proof of delivered shipment.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/err/shipments/{shipmentId}/signaturefile
Request samples 
Response samples 
application/json
{}