Denied Party Screening

Request

This API operation is used to submit shipper and/or consignee address information for denied party screening and receive a compliance status indicating whether the address is approved, potentially matched, or matched to a restricted entity. The API does not approve or reject shipments; instead, it provides actionable compliance insights that clients can use to determine next steps.

Security

bearerAuth

Bodyapplication/json

addressesArray of objects(ScreeningAddress)required

List of addresses to be screened. It includes a consignee and/or shipper.

Example:

[
  {
    "addressType": "CONSIGNEE",
    "address": { … }
  },
  {
    "addressType": "SHIPPER",
    "address": { … }
  }
]

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/denied-party-screening \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "addresses": [
      {
        "addressType": "CONSIGNEE",
        "address": {
          "addressLine1": "27 Waterview Dr",
          "cityTown": "Shelton",
          "company": "Pitney Bowes",
          "countryCode": "US",
          "email": "john.doe@example.com",
          "name": "pablo Escobar",
          "phone": "123-456-7890",
          "postalCode": "06484-4675",
          "residential": false,
          "stateProvince": "CT"
        }
      },
      {
        "addressType": "SHIPPER",
        "address": {
          "name": "Jason Henley",
          "addressLine1": "74 Thame rd",
          "addressLine2": "Warborough",
          "addressLine3": "Wallingford",
          "cityTown": "Oxfordshire",
          "stateProvince": "TX",
          "postalCode": "OX10 7DG",
          "countryCode": "UA",
          "email": "ovidiu131183@yahoo.com",
          "phone": "123-456-7891"
        }
      }
    ]
  }'

Responses

The requested screening report has been retrived successfully.

Bodyapplication/json

addressesArray of objects(AdditionalAddressResponse)required

List of addresses that were screened for denied party restrictions. Each address is evaluated independently and includes the screening outcome.

Response

{
  "addresses": [
    { … }
  ]
}