Introduction

Example Requests

Example 1 Screening a single client name against the OFAC SDN list with a minimum similarity score of 95.

{
	"apiKey": "your-api-key",
	"minScore": 95,
	"source": ["SDN"],
	"cases": [{
		"name": "Abu Abbas"
	}]
}				
												

Example 2 Screening 2 client names against the OFAC SDN and UK OFSI lists with a minimum similarity score of 95.

{
	"apiKey": "your-api-key",
	"minScore": 95,
	"source": ["SDN", "UK"],
	"cases": [
	    {
			"name": "Abu Abbas"
		},
		{
			"name": "Sergei Vladilenovich"
		}
	]
}			
												

Example 3 Screening a clients name, passport or address against the default data sources and minimum similarity score.
Note Sanction results may be returned based on name, address or passport alone.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Jose Orejuela",
		"passport": {
			"passportNumber": "10545599",
			"passportCountry": "Venezuela"

		},
		"address": {
			"address1": "1234 Ranch Street",
			"city": "Cali",
			"country": "Columbia"
		}
	}]
}		
												

Example 4. Screening a vessel based on IMO number.
Note

• The ID type field vessel is not required, but will filter results to include only vessels.
• The client IMO number must only be contained within the sanctioned vessel's IMO number for a match to be returned.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Client Vessel",
		"type": "vessel",
		"ids": [{
			"id": "9167291"
		}]
	}]
}	
												

Example 5. Screening a client name and generic ID - phone number.
Note The ID type field is optional. OFAC API will return any match in which the ID id field is found in the sanction data.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Mehr-e Eqtesad",
		"ids": [{
			"type": "phone number",
			"id": "982188526302"
		}]
	}]
}			
												

Example 6. Screening a client based on email address.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Tidewater Co",
		"ids": [{
			"type": "email",
			"id": "info@tidewaterco.com"
		}]
	}]
}			
												

Example 7. Screening a client based crypto wallet or email address.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Xiaobing Yan",
		"ids": [{
				"type": "bitcoin wallet",
				"id": "12QtD5BFwRsdNsAZY76UVE1xyCGNTojH9h"
			},
			{
				"type": "email address",
				"id": "xiaobing@email.com"
			}
		]
	}]
}		
												

Example 8. Screening a client business (entity) based on address or website.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Iranian Shipping",
		"type": "entity",
		"ids": [{
			"id": "www.irisl.net"
		}],
		"address": {
			"address1": "Pasdaran Street",
			"city": "Tehran",
			"country": "Iran"
		}
	}]
}		
												

Example 9 Screening a client name and date of birth.

{
	"apiKey": "your-api-key",
	"cases": [{
		"name": "Alexander Vasilevich",
		"dob": "1971-10-16"
	}]
}