Address Fields

Check-Relevant Address Fields

An address check request should at least contain a name. The compliance profile used determines for which name or names an address check is performed. First, a so-called name block is checked, which can either be the name explicitly passed in the field "name", or a combination of any of the fields "name1" to "name4", as configured in the compliance profile. If the configured combination of "name1" to "name4" is empty, the field "name" will still be checked as a fallback.

In addition to the check of the name block, an additional separate check for each of the fields "name1" to "name4" can also be configured in the compliance profile. For further details, please refer to the help for your compliance profile setting in the web application and Basic concepts.

The fields "addressType", "street", "pc", "postbox", "city" and "country" are optional, but contribute to the accuracy of the check. It is recommended to always fill these fields - if the data is available - to make the check more precise.

  "addresses": [
      "addressType": "entity",
      "name": "Abu Ahmed Group Inc.",
      "referenceId": "CUSNO=4711;CLIENT=800;USER=BEN003;PC=PC-PHILIPP"
      "addressType": "individual",
      "name": "John Doe",
      "name1": "John",
      "name2": "not Existing",
      "name3": "Doe",
      "street": "Example Street 123",
      "pc": "12345",
      "city": "Example City",
      "countryISO": "DE",
      "referenceId": "CUSNO=4712;CLIENT=800;USER=BEN003;PC=PC-PHILIPP",
      "referenceComment": "Customer no.: 4712, Client: 800, User: BEN003, Pc: PC-PHILIPP"
  "screeningParameters": {
    "clientIdentCode": "APITEST",
    "profileIdentCode": "DEFAULT",
    "clientSystemId": "API-TEST",
    "userIdentification": "BEN003",
    "addressTypeVersion": "1"
<soapenv:Envelope xmlns:soapenv="" xmlns:urn="">
        <name>Abu Ahmed Group Inc.</name>
        <name>John Doe</name>
        <name2>not Existing</name2>
        <street>Example Street 123</street>
        <city>Example City</city>
        <referenceComment>Customer no.: 4712, Client: 800, User: BEN003, Pc: PC-PHILIPP</referenceComment>



The field "addressTypeVersion" determines the address types that can be used in an address check. The current standard is ADDRESS_TYPE_VERSION_1. This version corresponds to the typical qualification of sanction list addresses and should always be used.

ADDRESS_TYPE_VERSION_0 is currently only supported to ensure backward compatibility.

Additional Address Fields

In addition to the address fields described above, which are relevant for the address comparison, you will also find fields that are purely informative. These include the fields "title", "surname", "prenames", "telNo", "district", "email", "position", "info" and "free1" to "free7". These parameters are not relevant for the address comparison itself, but can provide useful meta-information for your users when analysing an address match or defining a good guy.

The field "referenceId" is intended for internal, technical use. It can be used to to build references between the compliance protocols and the client system.