Bulk address screening

The main request of Compliance Screening API is bulk address screening. This works for single addresses and for larger amounts of addresses as well. See also the chapter Bulk vs single address screening.

Technology

Link to documentation

REST

screenAddresses

SOAP

RexBF (WSDL)
batchMatch (JavaDoc)

Screening of addresses from master data

Usually, it is necessary to periodically screen all addresses which are part of the master data (e.g. customers, suppliers, or employees), e.g. once every night or once a week. You may have several thousand of such addresses, so performance is important. For this reason, there is a bulk screening request which allows you to screen multiple addresses with one call.

Processing too large amounts of addresses with one call can lead to timeouts, depending on the server and system configuration. A typical batch size could be 100 addresses. However, if you plan to use very big restricted party lists (e.g. from Dow Jones), it may be neccessary to choose smaller block sizes to get acceptable response times.

🚧

For performance reasons, it is not allowed to perform parallel calls of bulk address screening. However, if you absolutely need parallel calls, please contact AEB because in this case the system environment should be configured accordingly.

The response of a bulk address screening request contains the overall result of the address check for each address (if there were any matches found or not). Address checks also create log entries in Trade Compliance Management which can be accessed there. Logs include further details about matches like all the matching restricted party addresses found. The logs are also used for the match handling of address matches in Trade Compliance Management, i.e. definition of good guys, etc.

📘

If suppressLogging is set to 'true', no logs will be created and match handling in Trade Compliance Management will not be possible.

Screening of transaction data

If it is needed to screen transaction data (e.g. orders, deliveries) which also contain typically more than one address (e.g. customer, consignee, forwarder), you should perform a bulk address screening at an appropriate point in time (e.g. shortly before confirming an order or picking a delivery).

Example Request

{
  "addresses": [
    {
      "addressType": "entity",
      "name": "Abu Ahmed Group Inc.",
      "street": "Fuller street 5",
      "pc": "MK7 6AJ",
      "city": "Manchester",
      "district": "North",
      "countryISO": "GB",
      "telNo": "+4413859-489548",
      "postbox": "12345",
      "pcPostbox": "MK7 6AJ",
      "cityPostbox": "Manchester",
      "email": "[email protected]",
      "fax": "+4413859-4895497",
      "name1": "Abu Ahmed",
      "name2": "Group Inc.",
      "name3": "Factory for sweets of all kind",
      "name4": "Manchester",
      "title": "Haji",
      "surname": "Ahmed",
      "prenames": "Abu",
      "dateOfBirth": "1962",
      "passportData": "ID 385948495849",
      "cityOfBirth": "Dublin",
      "countryOfBirthISO": "IR",
      "nationalityISO": "IR",
      "position": "Senior official of the Islamic State in Iraq and the Levant (ISIL)",
      "niNumber": "Italian fiscal code SSYBLK62T26Z336L",
      "info": "UN Ref QDi.401",
      "aliasGroupNo": "12345",
      "free1": "free1",
      "free2": "free2",
      "free3": "free3",
      "free4": "free4",
      "free5": "free5",
      "free6": "free6",
      "free7": "free7",
      "referenceId": "CUSNO=4711;CLIENT=800;USER=BEN003;PC=PC-PHILIPP",
      "referenceComment": "Customer no.: 4711, Client: 800, User: BEN003, Pc: PC-PHILIPP",
      "condition": {
        "value": "ORDER_12345",
        "description": "Order no. 12345"
      }
    }
  ],
  "screeningParameters": {
    "clientIdentCode": "APITEST",
    "profileIdentCode": "DEFAULT",
    "threshold": 60,
    "clientSystemId": "API-TEST",
    "suppressLogging": false,
    "considerGoodGuys": true,
    "userIdentification": "BEN003",
    "addressTypeVersion": "1"
  }
}
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:de.aeb.xnsg.rex.bf">
  <soapenv:Header/>
  <soapenv:Body>
      <urn:batchMatch>
         <patterns>
            <addressType>entity</addressType>
            <aliasGroupNo>12345</aliasGroupNo>
            <city>Manchester</city>
            <cityOfBirth>Dublin</cityOfBirth>
            <cityPostbox>Manchester</cityPostbox>
            <countryISO>GB</countryISO>
            <countryOfBirthISO>IR</countryOfBirthISO>
            <dateOfBirth>1962</dateOfBirth>
            <district>North</district>
            <email>[email protected]</email>
            <fax>+4413859-4895497</fax>
            <free1>free1</free1>
            <free2>free2</free2>
            <free3>free3</free3>
            <free4>free4</free4>
            <free5>free5</free5>
            <free6>free6</free6>
            <free7>free7</free7>
            <info>UN Ref QDi.401</info>
            <name>Abu Ahmed Group Inc.</name>
            <name1>Abu Ahmed</name1>
            <name2>Group Inc.</name2>
            <name3>Factory for sweets of all kind</name3>
            <name4>Manchester</name4>
            <nationalityISO>IR</nationalityISO>
            <niNumber>Italian fiscal code SSYBLK62T26Z336L</niNumber>
            <passportData>ID 385948495849</passportData>
            <pc>MK7 6AJ</pc>
            <pcPostbox>MK7 6AJ</pcPostbox>
            <position>Senior official of the Islamic State in Iraq and the Levant (ISIL)</position>
            <postbox>12345</postbox>
            <prenames>Abu</prenames>
            <street>Fuller street 5</street>
            <surname>Ahmed</surname>
            <telNo>+4413859-489548</telNo>
            <title>Haji</title>
            <referenceComment>Customer no.: 4711, Client: 800, User: BEN003, Pc: PC-PHILIPP</referenceComment>
            <referenceId>CUSNO=4711;CLIENT=800;USER=BEN003;PC=PC-PHILIPP</referenceId>
            <condition>
               <value>ORDER_12345</value>
               <description>Order no. 12345</description>
            </condition>
         </patterns>
         <parms>
            <checkType></checkType>
            <clientIdentCode>APITEST</clientIdentCode>
            <clientSystemId>API-TEST</clientSystemId>
            <considerGoodGuys>true</considerGoodGuys>
            <profileIdentCode>DEFAULT</profileIdentCode>
            <threshold>60</threshold>
            <suppressLogging>false</suppressLogging>
            <userIdentification>BEN003</userIdentification>
            <addressTypeVersion>1</addressTypeVersion>
         </parms>
      </urn:batchMatch>
   </soapenv:Body>
</soapenv:Envelope>

Example Response

[
  {
    "matchFound": true,
    "wasGoodGuy": false,
    "referenceId": "CUSNO=4711;CLIENT=800;USER=BEN003;PC=PC-PHILIPP",
    "referenceComment": "Customer no.: 4711, Client: 800, User: BEN003, Pc: PC-PHILIPP"
  }
]
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:batchMatchResponse xmlns:ns2="urn:de.aeb.xnsg.rex.bf">
         <result>
            <matchFound>true</matchFound>
            <referenceComment>Customer no.: 4711, Client: 800, User: BEN003, Pc: PC-PHILIPP</referenceComment>
            <referenceId>CUSNO=4711;CLIENT=800;USER=BEN003;PC=PC-PHILIPP</referenceId>
            <wasGoodGuy>false</wasGoodGuy>
         </result>
      </ns2:batchMatchResponse>
   </S:Body>
</S:Envelope>