Denied Party Screening

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.

SecuritybearerAuth

Request

Request Body schema: application/json

required

Array of objects (ScreeningAddress)

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

Responses

200

The requested screening report has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

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

post/api/v1/deniedPartyScreening

Request samples

application/json

{"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"
}
}
]
}

Response samples

application/json

{"addresses": [{"addressType": "CONSIGNEE",
"address": {"name": "Pablo Escobar",
"company": "Pitney Bowes",
"addressLine1": "27 Waterview Dr",
"addressLine2": "Warborough",
"addressLine3": "Wallingford",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4675",
"countryCode": "US",
"email": "john.doe@example.com",
"phone": "123-456-7890",
"residential": false
},
"screeningResult": {"status": "APPROVED",
"message": "Consignee details are completely verified.",
"restrictionPartyList": [{"restrictionParty": "EMBARGOED-COUNTRY",
"country": "UA",
"matchScore": 1,
"matchType": "name and/or company",
"matchValue": "Pablo Escobar"
}
]
}
}
]
}