Perform Check

You can use the Compliance API to check a business object. This check contains Compliance Screening and Export Controls.

To perform a check, you can use the following function:

API	Function
REST	POST requestCheck
SOAP	ComplianceBF (WSDL) \| requestCheck (JavaDoc)

To execute a check, use the request body below and adapt the fields businessObjectType, mappingProfile, and orgUnits to match your specific use case.

{
  "boIdClientSystem": "SAP_JNH_080_SALES_ORDER_1",
  "boIdClientSystemLabel": "SAP JNH 080 Sales order 1",
  "referenceNumber": "1",
  "businessObjectType": "SAP_SALES_ORDER",
  "businessObjectSubType": "OR",
  "mappingProfile": "SAP",
  "parties": [
    {
      "orgUnits": [
        "SalesOrganization1010"
      ],
      "roleIdentCode": "SP",
      "name1": "Ausländischer Kunde 50 (US)",
      "name2": "",
      "name3": "",
      "name4": "",
      "street": "Confederate Ave 15400",
      "district": "",
      "city": "Baton Rouge",
      "postalCode": "70817-3609",
      "countryIso": "US",
      "poBox": "",
      "postalCodePoBox": "",
      "companyReference": "10100050",
      "addressType": "2",
      "telephoneNo": "+19992365237",
      "email": "[email protected]",
      "ids": []
    },
    {
      "orgUnits": [
        "SalesOrganization1010"
      ],
      "roleIdentCode": "BP",
      "name1": "Ausländischer Kunde 50 (US)",
      "name2": "",
      "name3": "",
      "name4": "",
      "street": "Confederate Ave 15400",
      "district": "",
      "city": "Baton Rouge",
      "postalCode": "70817-3609",
      "countryIso": "US",
      "poBox": "",
      "postalCodePoBox": "",
      "companyReference": "10100050",
      "addressType": "2",
      "telephoneNo": "+19992365237",
      "email": "[email protected]",
      "ids": []
    },
    {
      "orgUnits": [
        "SalesOrganization1010"
      ],
      "roleIdentCode": "PY",
      "name1": "Ausländischer Kunde 50 (US)",
      "name2": "",
      "name3": "",
      "name4": "",
      "street": "Confederate Ave 15400",
      "district": "",
      "city": "Baton Rouge",
      "postalCode": "70817-3609",
      "countryIso": "US",
      "poBox": "",
      "postalCodePoBox": "",
      "companyReference": "10100050",
      "addressType": "2",
      "telephoneNo": "+19992365237",
      "email": "[email protected]",
      "ids": []
    },
    {
      "orgUnits": [
        "SalesOrganization1010"
      ],
      "roleIdentCode": "SH",
      "name1": "Ausländischer Kunde 50 (US)",
      "name2": "",
      "name3": "",
      "name4": "",
      "street": "Confederate Ave 15400",
      "district": "",
      "city": "Baton Rouge",
      "postalCode": "70817-3609",
      "countryIso": "US",
      "poBox": "",
      "postalCodePoBox": "",
      "companyReference": "10100050",
      "addressType": "2",
      "telephoneNo": "+19992365237",
      "email": "[email protected]",
      "ids": []
    },
    {
      "orgUnits": [
        "CompanyCode1010",
        "SalesOrganization1010"
      ],
      "roleIdentCode": "SalesOrganization",
      "name1": "DE Company Code",
      "city": "Walldorf",
      "countryIso": "DE",
      "companyReference": "1010"
    }
  ],
  "items": [
    {
      "orderNumber": "1",
      "idClientSystem": "10",
      "idClientSystemLabel": "FIN111, MTS-DI, PD",
      "orgUnits": [
        "ProductionPlant1010"
      ],
      "materialNo": "FG111",
      "quantity": {
        "value": 2,
        "unit": "PCE"
      },
      "values": [
        {
          "value": 0.00,
          "currencyIso": "USD"
        }
      ],
      "parties": [
        {
          "orgUnits": [
            "SalesOrganization1010",
            "ProductionPlant1010"
          ],
          "roleIdentCode": "ProductionPlant",
          "name1": "Werk 1010 als Geschäftspartner",
          "name2": "",
          "name3": "",
          "name4": "",
          "street": "Dietmar-Hopp-Alle 1",
          "district": "",
          "city": "Walldorf",
          "postalCode": "69190",
          "countryIso": "DE",
          "poBox": "",
          "postalCodePoBox": "",
          "companyReference": "1010",
          "addressType": "2",
          "telephoneNo": "+4999907770",
          "email": "[email protected]",
          "ids": [
            {
              "idType": "DE0",
              "idValue": "DE154512324"
            }
          ]
        }
      ],
      "decisiveDate": "2024-06-13",
      "ctryProductOrigin": ""
    }
  ],
  "monitorParty": {
    "roleIdentCode": "SH",
    "companyReference": "10100050"
  },
  "forceCheck": false,
  "clientSystemId": "SAP_JNH_080",
  "clientIdentCode": "API_TEST_CLIENT",
  "userName": "API_TEST",
  "resultLanguageIsoCodes": [
    "EN"
  ]
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:requestCheck>
         <request>
            <clientSystemId>BRUYES</clientSystemId>
            <clientIdentCode>API_TEST_CLIENT</clientIdentCode>
            <userName>API_TEST</userName>
            <resultLanguageIsoCodes>EN</resultLanguageIsoCodes>
            <boIdClientSystem>UNIQUE_BO_ID</boIdClientSystem>
            <boIdClientSystemLabel>UNIQUE_BO_ID_READBLE</boIdClientSystemLabel>
            <referenceNumber>REFERENCE_NUMBER</referenceNumber>
            <businessObjectType>BUSINESS_OBJECT_TYPE</businessObjectType>
            <mappingProfile>CMP_MAPPING_PROFILE</mappingProfile>
            <parties>
               <orgUnits>ORG_UNIT</orgUnits>
               <roleIdentCode></roleIdentCode>
               <name1>United Aircraft Corporation</name1>
               <street>Ulansky side-street 22</street>
               <city>Moscow</city>
               <postalCode>101000</postalCode>
               <countryIso>RU</countryIso>
               <companyReference>United_Aircraft_Corporation</companyReference>
            </parties>
           <monitorParty>
             <roleIdentCode></roleIdentCode>
             <companyReference>United_Aircraft_Corporation</companyReference>
           </monitorParty>
           <forceCheck>false</forceCheck>
         </request>
      </urn:requestCheck>
   </soapenv:Body>
</soapenv:Envelope>

You'll receive a response similar to the example shown below:

{
  "hasErrors": false,
  "hasOnlyRetryableErrors": false,
  "hasWarnings": false,
  "messages": [],
  "boIdClientSystem": "SAP_JNH_080_SALES_ORDER_1",
  "boIdClientSystemLabel": "SAP JNH 080 Sales order 1",
  "referenceNumber": "1",
  "orgUnitResults": [
    {
      "orgUnit": "DEFAULT",
      "resultType": "NOT_CRITICAL",
      "screeningStatus": "NOT_CRITICAL",
      "exportControlsStatus": "NOT_CRITICAL",
      "lastScreeningCheck": "2026-04-27T10:08:45",
      "lastExportControlsCheck": "2026-04-27T10:08:45"
    }
  ],
  "items": [
    {
      "idClientSystem": "10",
      "orgUnitResults": [
        {
          "orgUnit": "DEFAULT",
          "resultType": "NOT_CRITICAL"
        }
      ]
    }
  ],
  "blockMemories": []
}

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:requestCheckResponse xmlns:ns2="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
            <result>
                <hasErrors>false</hasErrors>
                <hasOnlyRetryableErrors>false</hasOnlyRetryableErrors>
                <hasWarnings>false</hasWarnings>
                <boIdClientSystem>SAP_JNH_080_SALES_ORDER_1</boIdClientSystem>
                <boIdClientSystemLabel>SAP JNH 080 Sales order 1</boIdClientSystemLabel>
                <referenceNumber>1</referenceNumber>
                <orgUnitResults>
                    <orgUnit>DEFAULT</orgUnit>
                    <resultType>NOT_CRITICAL</resultType>
                    <screeningStatus>NOT_CRITICAL</screeningStatus>
                    <exportControlsStatus>NOT_CRITICAL</exportControlsStatus>
                    <lastScreeningCheck>2026-04-27T10:45:00</lastScreeningCheck>
                    <lastExportControlsCheck>2026-04-27T10:45:00</lastExportControlsCheck>
                </orgUnitResults>
                <items>
                    <idClientSystem>10</idClientSystem>
                    <orgUnitResults>
                        <orgUnit>DEFAULT</orgUnit>
                        <resultType>NOT_CRITICAL</resultType>
                    </orgUnitResults>
                </items>
            </result>
        </ns2:requestCheckResponse>
    </S:Body>
</S:Envelope>

The response body includes the compliance status, the screening status, and the export controls status for each org unit. If you have performed an export controls check, the response will additionally contain the check result for each item.