POST /tracking/{trackingNumber}/proof-of-delivery
This API allows users to request a proof of delivery record via email. -Proof of Delivery (POD) is a letter containing the delivery information, the recipient's name, the tracking number, an image of the recipient’s signature, and the printed name and address. Proof of Delivery is only available for items where a Signature Confirmation™ service has been purchased or is included in the mail class.
- Return Receipt (Electronic) is a proof of delivery record for items with Return Receipt (Electronic) service.
Servers
- https://apis.usps.com/tracking/v3r2
- https://apis-tem.usps.com/tracking/v3r2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
trackingNumber |
String | Yes |
The human-readable representation of trackable barcode data, commonly known as a tracking number. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
CRID |
String | No |
Unique 10-byte numeric value that’s associated to each user. A Customer Registration Identification number (CRID) is a USPS-generated numeric code that uniquely identifies a business at a location. |
uniqueTrackingID |
String | Yes |
The unique tracking identifier provided in the Tracking Detail API response. |
recipients[] |
Array | Yes |
The contact information for up to 3 recipients. |
recipients[].email |
String | Yes |
The email address of the recipient. |
recipients[].lastName |
String | Yes |
The notification recipient last name. |
recipients[].firstName |
String | Yes |
The notification recipient first name. |
letterType |
String | No |
The requested notification: Proof of Delivery (POD) or Return Receipt Electronic (RRE). Valid values:
Default value: "PROOF_OF_DELIVERY" |
mailingDate |
String | No |
The mailing date provided in the Tracking Detail API response. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.