Introduction
Restrictions Screening service includes Import Restrictions Screening and Denied Parties .
Note:
All the API links below are for the Integration Environment. To access the links to Production Environment, just replace the api.eurora.com part with api.integration.eurora.com.
Integrating with Eurora
Import Restrictions Screening
The Restrictions service provides a feature: Get Restrictions associated to declarable code at given date. It helps customers to get some relevant restriction information of goods NomenclatureCode.
1. Open the API "Get Restrictions associated to declarable code at given date" on Postman, and set up your token.
2. Set up the parameters. All the parameters are required.
3. Then click the Send on Postman
4. If the request is successful, it will return a 200(OK) status and information that is relevant to goodsNomenclatureCode.
Import Restrictions Screening Request Specification | ||||
Order/Shipment info | ||||
goodsNomenclatureCode | required | string | Harmonized system code. (Must be a declarable code) | |
goodsWeight | optional | number | > 0 | Items total NET weight |
originCountryCode | required | string | 2 char | Goods country of origin. ISO-3166-1 alpha-2, uppercase Example: ES=Spain |
destinationCountryCode | required | string | 2 char | Order/Shipment consignee country. ISO-3166-1 alpha-2, uppercase |
transactionDate | required | string | <date> | Date of transaction formatted 'yyyy-MM-dd' |
requirementType | optional | string | Enum: "H1" "H7" | Parameter indicating whether restrictions should be applicable for goods of low value or high value in the response. |
Import Restrictions Screening Request Specification | ||||
Order/Shipment info | ||||
goodsNomenclatureCode | required | string | Harmonized system code. (Must be a declarable code) | |
goodsWeight | optional | number | > 0 | Items total NET weight |
originCountryCode | required | string | 2 char | Goods country of origin. ISO-3166-1 alpha-2, uppercase Example: ES=Spain |
destinationCountryCode | required | string | 2 char | Order/Shipment consignee country. ISO-3166-1 alpha-2, uppercase |
transactionDate | required | string | <date> | Date of transaction formatted 'yyyy-MM-dd' |
requirementType | optional | string | Enum: "H1" "H7" | Parameter indicating whether restrictions should be applicable for goods of low value or high value in the response. |
Import Restrictions Screening Request Specification | ||||
Order/Shipment info | ||||
goodsNomenclatureCode | required | string | Harmonized system code. (Must be a declarable code) | |
goodsWeight | optional | number | > 0 | Items total NET weight |
originCountryCode | required | string | 2 char | Goods country of origin. ISO-3166-1 alpha-2, uppercase Example: ES=Spain |
destinationCountryCode | required | string | 2 char | Order/Shipment consignee country. ISO-3166-1 alpha-2, uppercase |
transactionDate | required | string | <date> | Date of transaction formatted 'yyyy-MM-dd' |
requirementType | optional | string | Enum: "H1" "H7" | Parameter indicating whether restrictions should be applicable for goods of low value or high value in the response. |
Denied Parties
The Denied Parties provides one feature so far: Denied Parties. It helps customers to search for the risk information of a person, entity or both.
1. Open the API "Search for denied parties" on Postman, and set up your token.
3. Then click the Send on Postman.
4. If the request is successful, it will return a 200(OK) status and risk information.
API Documentation
Environment | API Documentation for Restrictions | API Documentation for Denied Parties | API Collection for Restrictions | API Collection for Denied Parties |
Production | Link | Link | Link | Link |
Integration | Link | Link | Link | Link |
Denied Parties Screening Request Specification | ||||
firstName | required | string | [ 2 .. 500 ] characters | searched individual's First name |
lastName | required | string | [ 2 .. 500 ] characters | serached individual's Last name |
entityName | required | string | [ 2 .. 500 ] characters | searched entity full name |
countryCode | required | string | Country to screen for sanctions imposed by the government of this country or any international community against the searched individual/entity. The ISO 3166 alpha-2 code of the country Must be uppercase Example:ES (Spain) |
|
region | optional | string | [ 2 .. 500 ] characters | country state or administrative area of searched individuals' residency |
city | optional | string | [ 2 .. 500 ] characters | city of searched individual's residency |
dateOfBirth | optional | string | [ 2 .. 500 ] characters | searched individual's date of birth |
Denied Parties Screening Response Specification | ||||
riskLevel | string | enum | Low' - no match with the looked up individual/entity 'Moderate' - partial match with the looked up individual/entity 'High' - close match with the looked up individual/entity |
|
individuals | array of objects | List of matching individuals and additional details based on the sanction list information | ||
firstName | string | First name of the matched individual based on the sanction list information | ||
lastName | string | Last name of the matched individual based on the sanction list information | ||
wholeName | string | Full name of the matched individual based on the sanction list information | ||
countryCode | string | Residency country ISO 3166 alpha-2 code of the matched individual based on the sanction list information | ||
region | string | Residency state/area/region of the matched individual based on the sanction list information | ||
city | string | Residency city of the matched individual based on the sanction list information | ||
source | string | name of the sanction list | ||
sourceProvider | string | Country or organisation which has imposed the sanction list | ||
sourceComments | string | |||
description | string | Sanction list description | ||
sourceUrl | string | Sanction list Url | ||
dateOfBirth | string | Matched individual date of birth | ||
entities | array of objects | List of matching entities and additional details based on the sanction list information | ||
name | string | legal name of the matched entity based on the sanction list information | ||
countryCode | string | Country of registration ISO 3166 alpha-2 code of the matched entity based on the sanction list information | ||
region | string | State/area/region of registration of the matched entity based on the sanction list information | ||
city | string | City of registration of the mathced entity based on the sanction list information | ||
source | string | name of the sanction list | ||
sourceProvider | string | Country or organisation which has imposed the sanction list | ||
sourceComments | string | |||
description | string | Sanction list description | ||
sourceUrl | string | Sanction list Url | ||
Denied Parties Screening Errors Specification | ||||
Response Status | Error Field | Error Message | Possible Root Cause | Possible Solution |
400 | firstName | {"type":"ARGUMENT_NOT_VALID","rows":[{"field":"firstName","reason":"Size","message":"size must be between 2 and 500"}]} | Provided First Name is too short/long or is missing (< 2 characters) | Please make sure the First Name contains at least 2 and does not exceed 500 symbols and re-submit. |
400 | lastname | {"type":"ARGUMENT_NOT_VALID","rows":[{"field":"lastName","reason":"Size","message":"size must be between 2 and 500"}]} | Provided Last Name is too short/long or is missing (< 2 characters) | Please make sure the Last Name contains at least 2 and does not exceed 500 symbols and re-submit. |
400 | region | {"type":"ARGUMENT_NOT_VALID","rows":[{"field":"region","reason":"Size","message":"size must be between 2 and 500"}]} | Provided Region is too short/long or is missing (< 2 characters) | Please make sure the Region contains at least 2 and does not exceed 500 symbols and re-submit. |
400 | entityName | {"type":"ARGUMENT_NOT_VALID","rows":[{"field":"entityName","reason":"Size","message":"size must be between 2 and 500"}]} | Provided Entity Name is too short/long or is missing (< 2 characters) | Please make sure the Entity Name contains at least 2 and does not exceed 500 symbols and re-submit. |