{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-tracking-proof-of-delivery-request-schema.json",
  "title": "Proof of delivery request",
  "description": "Proof of Delivery is a letter that includes the recipient's name and a copy of their signature. ",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-tracking-openapi.yml#/components/schemas/TrackingProofOfDeliveryRequest",
  "required": [
    "email",
    "firstName",
    "lastName",
    "mailPieceIntakeDate",
    "requestType",
    "tableCode",
    "uniqueMailPieceID"
  ],
  "type": "object",
  "properties": {
    "uniqueTrackingID": {
      "type": "string",
      "description": "Unique mail piece ID (mp-suffix) value, unique to each TrackID, located in Tracking Information Fields API response data. The 'expand' field in the original tracking request must be set to \"DETAIL\" in order to display this value.",
      "deprecated": true
    },
    "uniqueMailPieceID": {
      "type": "string",
      "description": "Unique mail piece ID (mp-suffix) value, unique to each TrackID, located in Tracking Information Fields API response data. The 'expand' field in the original tracking request must be set to \"DETAIL\" in order to display this value."
    },
    "approximateIntakeDate": {
      "type": "string",
      "description": "Approximate Intake Date (mp-date) value, unique to each TrackID, located in Tracking Information Fields API response data. The 'expand' field in the original tracking request must be set to \"DETAIL\" in order to display this value. ",
      "format": "date-time",
      "deprecated": true
    },
    "mailPieceIntakeDate": {
      "type": "string",
      "description": "Mail piece intake date (mp-date) value, unique to each TrackID, located in Tracking Information Fields API response data. The 'expand' field in the original tracking request must be set to \"DETAIL\" in order to display this value.\n\nAccepted formats:\n- Date and time: `2024-04-04 14:03:12:000`\n- ISO 8601 date only (yyyy-mm-dd): `2024-04-04`\n- Compact numeric (mmddyyyy), month and day must include leading 0: `04042024`\n- Slash-delimited (mm/dd/yyyy), month and day must include leading 0: `04/04/2024`\n"
    },
    "tableCode": {
      "type": "string",
      "description": "Table code value located in Tracking Information Fields API response data. Unique to each TrackID."
    },
    "requestType": {
      "type": "string",
      "description": "Enter a notification request type. Currently, email is the only request type available this time. ",
      "enum": [
        "email"
      ]
    },
    "firstName": {
      "type": "string",
      "description": "Recipient first name. "
    },
    "lastName": {
      "type": "string",
      "description": "Recipient last name. "
    },
    "email": {
      "maxItems": 3,
      "minItems": 1,
      "type": "array",
      "description": "Upto 3 Email addresses may be provided to receive the proof of delivery documentation.",
      "items": {
        "$ref": "#/$defs/Email"
      }
    },
    "faxNumber": {
      "type": "string",
      "description": "Recipient fax number "
    },
    "streetAddress": {
      "type": "string",
      "description": "The number of a building along with the name of the road or street on which it is located."
    },
    "secondaryAddress": {
      "type": "string",
      "description": "The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building.  For more information please see [Postal Explorer](https://pe.usps.com/text/pub28/28c2_003.htm)."
    },
    "city": {
      "type": "string",
      "description": "This is the city name of the address."
    },
    "state": {
      "maxLength": 2,
      "minLength": 2,
      "pattern": "^(AA|AE|AL|AK|AP|AS|AZ|AR|CA|CO|CT|DE|DC|FM|FL|GA|GU|HI|ID|IL|IN|IA|KS|KY|LA|ME|MH|MD|MA|MI|MN|MS|MO|MP|MT|NE|NV|NH|NJ|NM|NY|NC|ND|OH|OK|OR|PW|PA|PR|RI|SC|SD|TN|TX|UT|VT|VI|VA|WA|WV|WI|WY)$",
      "type": "string",
      "description": "This is two-character state code of the address."
    },
    "ZIPCode": {
      "pattern": "^\\d{5}",
      "type": "string",
      "description": "This is the 5-digit ZIP code."
    },
    "ZIPPlus4": {
      "description": "This is the 4-digit component of the ZIP+4 code. Using the correct Zip+4 reduces the number of times your mail is handled and can decrease the chance of a misdelivery or error."
    },
    "CRID": {
      "maxLength": 18,
      "minLength": 2,
      "type": "string",
      "description": "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."
    }
  },
  "$defs": {
    "Email": {
      "maxLength": 50,
      "pattern": "^[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}$",
      "type": "string",
      "description": "Email address used for redirect notification via email. ",
      "format": "email"
    }
  }
}