API Usage Scenarios

In the following pages, we demonstrate typical scenarios of how the Compliance Screening API may be called. The scenarios represent standard use cases which involve partner systems (e.g. ERP) that trigger the API calls and receive the respective response.

API calls to AEB's Compliance Screening require log in credentials. We have prepared a test system, which you can use for testing purposes for free. You can find more information on the required credentials under The First Address Screening .

These are the three most common use cases:

Simple integrated screening

A simple integration which runs AEB's Compliance Screening on one or more addresses you would like to screen. The response is typically processed by your partner system and you may configure a notification via e-mail. This lightweight integration use case would require subsequent action by a natural person through AEB's Compliance Screening GUI.

Screening with integrated status syncronization

The most common integration that runs AEB's Compliance Screening. The applications screening response is handled by a partner system, followed by subsequent action by a natural person through AEB's web GUI. This integration is more suited to you, if you are planning on maintaining your business partners in your partner system. In this case, you would typically set up a second API call to syncronize all statuses between AEB's Compliance Screening and your partner system.

Screening with integrated good guy definition

A complex integration which runs AEB's Compliance Screening and allows to handle the response entirely through a partner system. This includes multiple individual API calls to different endpoints and therefor requires integration of different responses into a partner system.

In case you missed it

AEB's Compliance Screening API offers two interfaces: REST and SOAP . The equivalent endpoints for both interfaces are mentioned in the following pages.
Depending on the number of addresses you want to screen and the information that is required for the partner system to run appropriate processes, we recommend you read Bulk vs. Single Address Screening. When a screened address results in a potential match, action is required, which is referred to as "Match Handling" and is explained here Match Handling and Good Guys.