Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Hurricane Services

Denied Parties

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.

post/v4/DeniedParties

Request body

ShippingAccountIdstring 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.

Referencestring 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.

Example request

{
  "ShippingAccountId": "AccountAlias1",
  "Reference": "ABC1234",
  "Address": {
    "ContactName": "Joe Blogs",
    "CompanyName": "Big Tech Ltd",
    "Line1": "Flat 4",
    "Line2": "123 Main Street",
    "Town": "Westminster",
    "County": "Central London",
    "CountryCode": "GB"
  }
}

Response

Returns denied parties response.

ShippingAccountIdstring 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.

Referencestring 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.

DeniedPartyScoreinteger

A numerical score reflecting the highest match found against the denied parties list, indicating the level of risk associated with the entity.

CountryDeniedPartyScoreThresholdinteger

A threshold score for denied party checks specific to the country, setting a limit above which a match is considered significant for the country.

IsErrorboolean 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.

ErrorDescriptionstring nullable

A description of the error during the request (if encountered), providing insights into what went wrong and how it can be addressed.

Notesstring 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.

GeneratedDatestring nullable

A timestamp in Coordinated Universal Time (UTC) returned by Hurricane, indicating when the call was performed, aiding in tracking and logging activities.

Example response

{
  "ShippingAccountId": "AccountAlias1",
  "Reference": "ABCD1234",
  "DeniedPartyScore": 90,
  "CountryDeniedPartyScoreThreshold": 75,
  "Matches": [
    {
      "DeniedPartyScore": 90,
      "NameMatch": true,
      "AddressMatch": true
    }
  ],
  "GeneratedDate": "2019-02-12T15:27:01Z"
}