---
title: "Denied Parties"
method: POST
path: "/v4/DeniedParties"
tags: ["Hurricane Services"]
---

# Denied Parties

`POST /v4/DeniedParties`

Identify if a person, organisation or company is not permitted to engage in transactions such as sending products or goods, because they have been proven to be in violation of international law, and have links with a range of criminal activities including terrorism, organised crime, financial crimes, weapons trading, and others.
<br />
<br />With this endpoint, you can check and validate whether a specific entity involved in shipping is on a denied list, which may include sanctions, watch lists, or restricted firms, thereby ensuring proper compliance during shipping.

## Request body

- DeniedPartiesRequest — Denied Parties Request
  - `ShippingAccountId` string, nullable — A unique identifier for the shipping account, which can either be generated by the system or provided by you (alias) during shipping account creation. <br />This ID helps associate the request with a specific shipping account.
  - `Reference` string, nullable — A reference string that is used to trace the response of the request. <br />This allows users to keep track of their requests and facilitates easier follow-up if needed.
  - `Address` DeniedPartiesAddress, required — The complete address information for the party being checked against the denied parties list. This field is crucial for accurate matching and validation processes.
    - `ContactName` string, nullable — The name of the contact person being checked. This is necessary for identifying the specific individual involved in the shipping process. <br /> <br />***Note:** The **ContactName** or **CompanyName** must be provided. If both are supplied, then the **ContactName** will be utilised.*
    - `CompanyName` string, nullable — The name of the company being checked. <br />This is used to check if the business is listed as a denied party. <br /> <br /><b>Note:</b> The <b>Contact Name</b> or <b>Company Name</b> must be provided. If both are supplied, then the <b>Contact Name</b> will be utilised.
    - `Line1` string, required — The first line of the address being checked, typically containing the primary address information such as house number and street name.
    - `Line2` string, nullable — The optional second line for the address being checked, often used for additional details like apartment numbers or suite designations.
    - `Line3` string, nullable — The third optional line of the address being checked, to include any further address specifications, allowing for more detailed address information.
    - `Town` string, required — The name of the town or city being checked. indicating the specific locality where the address is located.
    - `Postcode` string, nullable — The postal or ZIP code corresponding to the address being checked, used to identify specific geographic areas.
    - `County` string, nullable — The county, state, or province of the address being checked, providing additional geographical context for the address.
    - `CountryCode` string, required — An abbreviation representing the country of the address, following the ISO 3166-1 alpha-2 standard, for example, "US" for the United States of America.

## Response `200`

Returns denied parties response.

- DeniedPartiesResponse — Denied Parties Response
  - `ShippingAccountId` string, nullable — The unique identifier for the shipping account used in the request, returned for confirmation of the matched account. <br /> <br /><b>Note:</b> If an empty value was sent in the request, then this field will return as blank.
  - `Reference` string, nullable — The reference string supplied in the request, returned in the response for tracing the request. <br /> <br /><b>Note:</b> If an empty value was sent in the request, then this field will return as blank.
  - `DeniedPartyScore` integer — A numerical score reflecting the highest match found against the denied parties list, indicating the level of risk associated with the entity.
  - `CountryDeniedPartyScoreThreshold` integer — A threshold score for denied party checks specific to the country, setting a limit above which a match is considered significant for the country.
  - `Matches` DeniedPartiesMatch[], nullable — An array of potential matches found in the denied parties list associated with the given name and address, or null for compliance verification.
    - `DeniedPartyScore` integer — The score for the highest match within the matched entities, providing insight into the strength of the match against the denied party criteria.
    - `NameMatch` boolean — A boolean value indicating whether there was an exact name match with a denied party entity independent of the address, essential for verification.
    - `PartialNameMatch` boolean — A boolean value indicating if a partial name match occurred (that is, a check for initials, first, and last names independent of the address) which assesses the relevance of similar names.
    - `OrderNameMatch` boolean — A boolean value that identifies whether there was a match based on the order in which the names were presented, for example, John Joseph and Joseph John, reflecting strict checking criteria.
    - `AddressMatch` boolean — A boolean value that signifies if an exact address match was found with a denied party, crucial for accurate compliance checking.
    - `PartialAddressMatch` boolean — A boolean value indicating whether a partial match of the address was found, indicating a potential issue if further verification is needed.
  - `IsError` boolean, nullable — A boolean indicating whether an error occurred during the request processing. <br />It helps users quickly identify if there was an issue with their request. <br /> <br /><b>Note:</b> This field returns true only if the requested root elements generated an error, indicating that Hurricane cannot process the request.
  - `ErrorDescription` string, nullable — A description of the error during the request (if encountered), providing insights into what went wrong and how it can be addressed.
  - `Notes` string, nullable — Additional information returned by the system containing any notes or notifications, for example, further details on the error or notes about forthcoming changes on duty rates.
  - `GeneratedDate` string, nullable — A timestamp in Coordinated Universal Time (UTC) returned by Hurricane, indicating when the call was performed, aiding in tracking and logging activities.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)