Trade Compliance Management

AEB Trade Compliance API hub

Welcome to the AEB Trade Compliance API hub. You'll find comprehensive guides and documentation to help you start working with AEBs Trade Compliance Services as quickly as possible.
Trade Compliance Management offers comprehensive functionality for screening of addresses against restricted party lists, export control checks, license management and risk assessment.
Let's jump right in!

API Usage scenarios

The Export Controls API can be used in different scenarios depending on the amount of integration work to be done in the host system.

Simple Integration

Let's start with a typical simple workflow for an export control check in a transaction (e.g. sales order) as represented in the diagram below (Click on the image to see it enlarged).

A user (order processor) of a host system creates or updates a business transaction (eg. an order). The host system then calls, if all mandatory data was entered, a checkTransaction() request with a host-system-generated transactionid using the Export Controls API.

Export Controls performs all configured checks and creates a log entry. If a restriction was detected, a check transaction is generated and stored in Export Controls. A response is sent back to the host system. In this scenario the host system ignores the response and no lock is posed upon the order.

Depending on the configuration and check result, an export control officer is notified through an email from the Export Controls software.

Some time later, the export control officer then uses the Export Controls web application to check the created transaction and perhaps approves or rejects it. There is no automatic feedback to the host system for this action.

If the export control officer rejects the transaction, a block should be set (manual process) in the host system for that particular order, to avoid further business contacts.

📘

If a business transaction (eg. the order) is deleted in the host system, no action is required, as deletion of check transactions is not supported and not necessary.

Sophisticated Integration

In this scenario the host system integration will be tighter and the effort to implement it will be higher.

A user (order processor) of a host system creates or updates a business transaction (eg. an order). The host system then calls, if all mandatory data was entered, a checkTransaction() request with a host- system-generated transactionid using the Export Controls API.

Export Controls performs all configured checks and creates a log entry. If a restriction was detected, a check transaction is generated and stored in Export Controls. A response is sent back to the host system. The host system uses the response results to store the results along with the order. If the response suggested an export restriction, the host system blocks the order. Additionally, the order processor may be informed about the blocked order.

Some time later, the export control officer then uses the Export Controls web application to check the created transaction and perhaps approves or rejects it. There is no automatic feedback to the host system for this action.

Either the order processor manually triggers a re-check of the order, or a batch job can be created that runs, e.g., once a day to re-check all blocked/critical orders. Then the host system again calls checkTransaction() for the same order (using the same transactionid). Depending on whether the Export Control officer approved the transaction, the result of the check might now turn into "not critical".

The host system has to evaluate the new response result, and remove the previously created blocking of the order in case the result is uncritical. Additionally, the host system might inform the order processor about the update via a popup or other means of notification.

📘

Use the calls of checkTransaction() in moderation, as each call will be billed.

Updated about a year ago


API Usage scenarios


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.