GET
/
letters
/
{id}
curl --request GET \
  --url https://api.posta.co/letters/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "ltr_9a32a8b5a96c880c",
  "status": "queued",
  "externalId": "0013i00002YyVvSAAV",
  "sendDate": "2023-12-25",
  "description": "Compliance notice",
  "sender": {
    "individual": {
      "fullName": "TODO",
      "prefix": "TODO",
      "firstName": "TODO",
      "middleName": "TODO",
      "lastName": "TODO",
      "postfix": "TODO",
      "title": "TODO"
    },
    "organization": "Veezla, Inc.",
    "address": {
      "addressLine1": "1900 Reston Metro Plz",
      "addressLine2": "Ste 600",
      "lastLine": "Reston, VA 20194-5952"
    },
    "addressComponents": {
      "cassType": "none",
      "urbanization": "TODO",
      "city": "TODO",
      "state": "TODO",
      "zipCode": "TODO",
      "plus4Code": "TODO"
    },
    "addressAnalysis": {
      "dpvMatchCode": "TODO",
      "dpvFootnotes": [
        "TODO"
      ],
      "dpvCmra": "TODO",
      "dpvVacant": "TODO",
      "dpvNoStat": "TODO",
      "dpvActive": "TODO",
      "dpvInactiveReason": "TODO",
      "dpvThrowback": "TODO",
      "dpvNonDeliveryDayIndicator": "TODO",
      "dpvNonDeliveryDayValues": "TODO",
      "dpvNoSecureLocation": "TODO",
      "dpvDoorNotAccessible": "TODO",
      "lacslinkCode": "TODO",
      "lacslinkIndicator": "TODO",
      "suitelinkIndicator": "TODO",
      "ewsIndicator": true
    },
    "addressCorrections": [
      {
        "name": "TODO",
        "input": "TODO",
        "corrected": "TODO"
      }
    ],
    "addressMetadata": {
      "recordType": "TODO",
      "addressType": "TODO",
      "zipCodeType": "TODO",
      "county": "TODO",
      "countyFips": "TODO",
      "carrierRoute": "TODO",
      "carrierRouteType": "TODO",
      "congressionalDistrict": "TODO",
      "defaultBuildingAddress": true,
      "elotSequence": "TODO",
      "elotSort": "TODO",
      "latitude": 0,
      "longitude": 0,
      "precision": "TODO",
      "uspsFinanceNumber": "TODO",
      "timeZone": "TODO"
    }
  },
  "recipient": {
    "nonAddressData": "<string>",
    "individual": {
      "fullName": "TODO",
      "prefix": "TODO",
      "firstName": "TODO",
      "middleName": "TODO",
      "lastName": "TODO",
      "postfix": "TODO",
      "title": "TODO"
    },
    "organization": "Posta Customer, Inc.",
    "address": {
      "addressLine1": "1900 Reston Metro Plz",
      "addressLine2": "Ste 600",
      "lastLine": "Reston, VA 20194-5952"
    },
    "addressComponents": {
      "cassType": "none",
      "urbanization": "TODO",
      "city": "TODO",
      "state": "TODO",
      "zipCode": "TODO",
      "plus4Code": "TODO"
    },
    "addressAnalysis": {
      "dpvMatchCode": "TODO",
      "dpvFootnotes": [
        "TODO"
      ],
      "dpvCmra": "TODO",
      "dpvVacant": "TODO",
      "dpvNoStat": "TODO",
      "dpvActive": "TODO",
      "dpvInactiveReason": "TODO",
      "dpvThrowback": "TODO",
      "dpvNonDeliveryDayIndicator": "TODO",
      "dpvNonDeliveryDayValues": "TODO",
      "dpvNoSecureLocation": "TODO",
      "dpvDoorNotAccessible": "TODO",
      "lacslinkCode": "TODO",
      "lacslinkIndicator": "TODO",
      "suitelinkIndicator": "TODO",
      "ewsIndicator": true
    },
    "addressCorrections": [
      {
        "name": "TODO",
        "input": "TODO",
        "corrected": "TODO"
      }
    ],
    "addressMetadata": {
      "recordType": "TODO",
      "addressType": "TODO",
      "zipCodeType": "TODO",
      "county": "TODO",
      "countyFips": "TODO",
      "carrierRoute": "TODO",
      "carrierRouteType": "TODO",
      "congressionalDistrict": "TODO",
      "defaultBuildingAddress": true,
      "elotSequence": "TODO",
      "elotSort": "TODO",
      "latitude": 0,
      "longitude": 0,
      "precision": "TODO",
      "uspsFinanceNumber": "TODO",
      "timeZone": "TODO"
    }
  },
  "content": {
    "type": "asset",
    "assetId": "ast_1234567890abcdef",
    "assetVersionId": "astv_1234567890abcdef"
  },
  "url": "https://api.posta.co/letters/ltr_9a32a8b5a96c880c/download",
  "variables": [
    {
      "name": "customerName",
      "value": "John Doe"
    }
  ],
  "options": {
    "print": {
      "color": true
    },
    "mail": {
      "service": "firstClass",
      "extraServices": [
        "acs"
      ]
    },
    "variableHandling": {
      "validationScope": "asset"
    },
    "addressProcessing": {
      "cassSender": {
        "type": "basic",
        "casing": "proper"
      },
      "cassRecipient": {
        "type": "basic",
        "casing": "proper"
      },
      "ncoaRecipient": "newAddress"
    },
    "deliverabilityThreshold": "normal",
    "deliverabilityValues": [
      "deliverable"
    ]
  },
  "useType": "marketing",
  "events": [
    {
      "id": "evt_1234567890abcdef",
      "timestamp": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "type": "tracking",
      "status": "inTransit",
      "description": "TODO",
      "operationCode": "TODO",
      "actionRequired": true,
      "trackingEventDetails": {
        "notes": "TODO",
        "facility": "TODO",
        "facilityType": "TODO",
        "facilityZip": "TODO",
        "additionalData": {}
      },
      "location": "TODO"
    }
  ],
  "issueMessage": "Recipient address could not be validated",
  "metadata": [
    {
      "key": "salesforceId",
      "value": "0013i00002YyVvSAAV"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

The unique identifier of the letter.

Query Parameters

includeCass
boolean
default:false

Include CASS processing details in the response.

Response

200
application/json

Generic response for a resource request

A letter.