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!

The first call to Export Controls

To allow you to start quickly, you will find here a complete call to do an export control check and receive a typical response.

๐Ÿ“˜

The REST API v2 currently supports only this one type of API call.

Check transaction

You can use the following example and copy/paste it into your favorite tool to test REST and/or SOAP API calls. Our test environment is prepared to work with the data in this example.

๐Ÿ“˜

To reuse this example for your login details, replace the field clientIdentCode with your client, the field profileIdentCode with your Compliance profile and the field clientSystemId with an ID for your calling system.

When using REST, the URL for the request in our API test environment will be
https://rz3.aeb.de/test4ce/rest/ExportControl/v2/checkTransaction.
When using SOAP, the URL for the request in our API test environment will be
https://rz3.aeb.de:443/test4ce/servlet/bf/ExportControl40V2BF.

๐Ÿ“˜

To test REST API manually you can use this link to our REST API documentation and click the "Try it out" button for the desired request. Do not forget to use the โ€œAuthorizeโ€ button for authentication (at the top of the web page). Otherwise, you will get a 403 HTTP error.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:de.aeb.xnsg.expctrl.bf.v40">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:checkTransaction>
         <request>
            <clientSystemId>API-TEST</clientSystemId>
            <clientIdentCode>APITEST</clientIdentCode>
            <userName>BEN003</userName>
            <resultLanguageIsoCodes>en</resultLanguageIsoCodes>
            <transaction>
               <transactionIdHost>TRANS_001</transactionIdHost>
               <transactionLabelHost>My Order</transactionLabelHost>
               <items>
                  <itemIdHost>POS_001</itemIdHost>
                  <itemLabelHost>My first Position</itemLabelHost>
                  <partners>
                     <roleIdentCode>CONSIGNOR_STD</roleIdentCode>
                     <name1>Exporter AG</name1>
                     <countryIso>DE</countryIso>
                     <companyReference>N012345</companyReference>
                  </partners>
                  <partners>
                     <roleIdentCode>SELLER_STD</roleIdentCode>
                     <name1>Seller AG</name1>
                     <countryIso>DE</countryIso>
                     <companyReference>N0654321</companyReference>
                  </partners>
                  <partners>
                     <roleIdentCode>CONSIGNEE_STD</roleIdentCode>
                     <name1>Consignee AG</name1>
                     <countryIso>IR</countryIso>
                     <companyReference>N03333</companyReference>
                  </partners>
                  <partners>
                     <roleIdentCode>BUYER_STD</roleIdentCode>
                     <name1>Buyer AG</name1>
                     <countryIso>IR</countryIso>
                     <companyReference>N04444</companyReference>
                  </partners>
                  <partners>
                     <roleIdentCode>ENDUSER_STD</roleIdentCode>
                     <name1>USER AG</name1>
                     <countryIso>IR</countryIso>
                     <companyReference>N02222</companyReference>
                  </partners>
                  <decisiveDate>2020-01-18T00:00:00+02:00</decisiveDate>
                  <productClassifications>
                     <classificationIdentCode>ClassificationAusfuhrliste</classificationIdentCode>
                     <classificationNumber>1A001</classificationNumber>
                  </productClassifications>
                  <productClassifications>
                     <classificationIdentCode>CLASSIFICATION_US_EAR_CCL</classificationIdentCode>
                     <classificationNumber>1A001</classificationNumber>
                  </productClassifications>
                  <valueOfGoods>
                     <value>100000</value>
                     <currencyIso>EUR</currencyIso>
                  </valueOfGoods>
                  <orderNumber>ORDER_NO12345</orderNumber>
                  <quantity>100</quantity>
                  <quantityUnit>ST</quantityUnit>
               </items>
            </transaction>
            <profileIdentCode>DEFAULT</profileIdentCode>
            <isAutoCreateClearings>false</isAutoCreateClearings>
         </request>
      </urn:checkTransaction>
   </soapenv:Body>
</soapenv:Envelope>
{
    "clientSystemId": "API-TEST",
    "clientIdentCode": "APITEST",
    "userName": "BEN003",
    "resultLanguageIsoCodes": [
        "en"
    ],
    "transaction": {
        "transactionIdHost": "TRANS_001",
        "transactionLabelHost": "My Order",
        "items": [
            {
                "itemIdHost": "POS_001",
                "itemLabelHost": "My first position",
                "partners": [
                    {
                        "roleIdentCode": "CONSIGNOR_STD",
                        "name1": "Exporter AG",
                        "countryIso": "DE",
                        "companyReference": "N012345"
                    },
                    {
                        "roleIdentCode": "SELLER_STD",
                        "name1": "Seller AG",
                        "countryIso": "DE",
                        "companyReference": "N0654321"
                    },
                    {
                        "roleIdentCode": "CONSIGNEE_STD",
                        "name1": "Consignee AG",
                        "countryIso": "IR",
                        "companyReference": "N03333"
                    },
                    {
                        "roleIdentCode": "BUYER_STD",
                        "name1": "Buyer AG",
                        "countryIso": "IR",
                        "companyReference": "N04444"
                    },
                    {
                        "roleIdentCode": "ENDUSER_STD",
                        "name1": "USER AG",
                        "countryIso": "IR",
                        "companyReference": "N02222"
                    }
                ],
                "decisiveDate": "2020-01-29T09:01:48.669Z",
                "productClassifications": [
                    {
                        "classificationIdentCode": "ClassificationAusfuhrliste",
                        "classificationNumber": "1A001"
                    },
                    {
                        "classificationIdentCode": "CLASSIFICATION_US_EAR_CCL",
                        "classificationNumber": "1A001"
                    }
                ],
                "valueOfGoods": [
                    {
                        "value": 100000,
                        "currencyIso": "EUR"
                    }
                ],
                "orderNumber": "ORDER_NO12345",
                "quantity": 100,
                "quantityUnit": "ST"
            }
        ]
    },
    "profileIdentCode": "DEFAULT",
    "isAutoCreateClearings": false
}

Response

The response contains the information whether an export is allowed, something has to be done still, or the export is prohibited. See also Results.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:checkTransactionResponse xmlns:ns2="urn:de.aeb.xnsg.expctrl.bf.v40">
         <result>
            <hasErrors>false</hasErrors>
            <hasOnlyRetryableErrors>false</hasOnlyRetryableErrors>
            <hasWarnings>false</hasWarnings>
            <totalResultType>RESTRICTION</totalResultType>
            <itemResults>
               <itemIdHost>POS_001</itemIdHost>
               <resultType>RESTRICTION</resultType>
               <pluginResults>
                  <pluginIdentCode>DE-EU-Plugin</pluginIdentCode>
                  <resultType>RESTRICTION</resultType>
               </pluginResults>
               <pluginResults>
                  <pluginIdentCode>US-EAR-Plugin</pluginIdentCode>
                  <resultType>RESTRICTION</resultType>
               </pluginResults>
            </itemResults>
         </result>
      </ns2:checkTransactionResponse>
   </S:Body>
</S:Envelope>
{
   "hasErrors": false,
   "hasOnlyRetryableErrors": false,
   "hasWarnings": false,
   "messages": [],
   "totalResultType": "RESTRICTION",
   "itemResults": [   {
      "itemIdHost": "POS_001",
      "resultType": "RESTRICTION",
      "pluginResults":       [
                  {
            "pluginIdentCode": "DE-EU-Plugin",
            "resultType": "RESTRICTION",
            "clearings": []
         },
                  {
            "pluginIdentCode": "US-EAR-Plugin",
            "resultType": "RESTRICTION",
            "clearings": []
         }
      ]
   }]
}

Updated 5 months ago

The first call to Export Controls


Suggested Edits are limited on API Reference Pages

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