Restricted/denied party screening, export control and risk assessment as an API. Screens addresses and transactions against sanctions lists, manages good-guy releases and match handling, runs export control checks and licence management, and exposes compliance foundation master data.
{
"openapi" : "3.0.1",
"info" : {
"title" : "Trade Compliance Management HTTP API",
"description" : "Thank you for using our HTTP API documentation.",
"version" : "4.0"
},
"servers" : [ {
"url" : "https://rz3.aeb.de/test4ce/rest"
} ],
"security" : [ {
"SWAGGER_AUTH_KEY" : [ ]
}, {
"BASIC_AUTH" : [ ]
} ],
"tags" : [ {
"name" : "Compliance Foundation",
"description" : "API for the compliance foundation."
}, {
"name" : "CoreBFBean",
"description" : "API for the XNSGFoundation"
}, {
"name" : "Export Control Applications",
"description" : "Get URLs to various parts of the Export Controls application."
}, {
"name" : "Export Control Internal",
"description" : "Internal API for export control"
}, {
"name" : "Export Control",
"description" : "API for export control"
}, {
"name" : "FoundationAFBean",
"description" : "Business facade for the XNSGFoundation UI API"
}, {
"name" : "Logon",
"description" : "Authentication handler for the XNSGFoundation"
}, {
"name" : "DataFeedBFBean",
"description" : "DataFeedBFBean"
}, {
"name" : "ExternalTelemetryBFBean",
"description" : "API for sending telemetry data from a third party system."
}, {
"name" : "FoundationBFBean",
"description" : "REST endpoint for FoundationBF"
}, {
"name" : "RemoteAdminBFBean",
"description" : " Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR)."
}, {
"name" : "SyncBFBean",
"description" : "API for synchronizing data asynchronous from an engine to a client system."
}, {
"name" : "License Management",
"description" : "API for License Management"
}, {
"name" : "Companies",
"description" : "Rest API for companies"
}, {
"name" : "Compliance Screening Applications",
"description" : "Get URLs to various parts of the Compliance Screening application."
}, {
"name" : "Compliance Screening Internal",
"description" : "Internal API for compliance screening"
}, {
"name" : "Compliance Screening",
"description" : "API for restricted party list screening"
}, {
"name" : "Risk Assessment Applications",
"description" : "Get URLs to various parts of the Risk Assessment application."
}, {
"name" : "Risk Assessment",
"description" : "API for Risk Assessment"
}, {
"name" : "WorkstationServiceAgent",
"description" : "Connection handler for the Workstation Service Agent"
}, {
"name" : "GenericAFBean",
"description" : "API to open views that support this generic interface."
}, {
"name" : "TariffContent20BFBean",
"description" : "API for the tariff content solution (version 2.0)."
}, {
"name" : "CustomsContentServiceBF",
"description" : "API providing services around customs content (nomenclatures, export control lists)."
} ],
"paths" : {
"/ComplianceFoundation/getMasterdataIdentifiers" : {
"post" : {
"tags" : [ "Compliance Foundation" ],
"summary" : "Returns the identifiers of master data for a client.",
"description" : "Returns the identifiers of master data for a client. The available types of master data are the following:<ul><li>Partner roles: <code>PARTNER_ROLE_IDENTIFIERS</code></li><li>Goods attributes: <code>GOODS_ATTRIBUTE_IDENTIFIERS</code></li><li>Transaction types: <code>TRANSACTION_TYPE_IDENTIFIERS</code></li><li>Jurisdictions: <code>JURISDICTION_IDENTIFIERS</code></li><li>All value lists and their entries: The <code>identCode</code> of the requested value list</li></ul> The result will include all client independent identifiers plus the identifiers of the specified client.",
"operationId" : "getMasterdataIdentifiers",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMasterdataIdentifiersRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/GetMasterdataIdentifiersRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK. The operation response. See response schema documentation for details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMasterdataIdentifiersResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/GetMasterdataIdentifiersResponseDTO"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"405" : {
"description" : "Method not allowed. Use POST.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"406" : {
"description" : "Not Acceptable. This resource produces application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"415" : {
"description" : "Unsupported Media Type. This resource accepts application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"500" : {
"description" : "Internal server error. See errorMessage for details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
}
}
}
},
"/CoreBFBean/checkBFFunctionExists" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Can be called to know if a BF function exist.",
"operationId" : "checkBFFunctionExists",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BFFunctionDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BFFunctionExistsDTO"
}
}
}
}
}
}
},
"/CoreBFBean/echo" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the given echo parameter value.",
"operationId" : "echo",
"parameters" : [ {
"name" : "echo",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/echoUpperCase" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the given echo parameter value in uppercase.",
"operationId" : "echoUpperCase",
"parameters" : [ {
"name" : "echo",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getAllMonitoringValues" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns all available monitoring values of the server.",
"operationId" : "getAllMonitoringValues",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MonitoringDataProviderDTO"
}
}
}
}
}
}
}
},
"/CoreBFBean/getBuildForSolution" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_BLDSOL\\\".",
"operationId" : "getBuildForSolution",
"parameters" : [ {
"name" : "solutionName",
"in" : "query",
"description" : "solutionName the name of the solution for which version information is to be obtained",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getMonitoringValue" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the current monitoring value for the given group and name.",
"operationId" : "getMonitoringValue",
"parameters" : [ {
"name" : "groupName",
"in" : "query",
"schema" : {
"type" : "string"
}
}, {
"name" : "valueName",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getProductInfo" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \\\"/AEB/XNSG_IF_PRINFO\\\".",
"operationId" : "getProductInfo",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getRuntimeInfo" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \\\"/AEB/XNSG_IF_RTINFO\\\".",
"operationId" : "getRuntimeInfo",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getRuntimeState" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installation repository The RFC name of this function is \\\"/AEB/XNSG_IF_RTSTATE\\\".",
"operationId" : "getRuntimeState",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeStateParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeStateResultDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getThreadDump" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Generate Thread-Dump.",
"operationId" : "getThreadDump",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getVersionForSolution" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_VERSOL\\\".",
"operationId" : "getVersionForSolution",
"parameters" : [ {
"name" : "solutionName",
"in" : "query",
"description" : "solutionName the name of the solution for which version information is to be obtained",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VersionInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/restartRFCServer" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure definitions had changed, e.g. after installing a transport. The RFC name of this function is \\\"/AEB/XNSG_IF_RSTRFCSRV\\\".",
"operationId" : "restartRFCServer",
"responses" : {
"200" : {
"description" : "No result.",
"content" : {
"application/json" : { }
}
}
}
}
},
"/ExportControlApplications/commerceControlList" : {
"post" : {
"tags" : [ "Export Control Applications" ],
"summary" : "Get application for the Commerce Control List.",
"description" : "Returns an URL for an application, which displays the Commerce Control List appliaction.",
"operationId" : "getCommerceControlList",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CommerceControlListRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/CommerceControlListRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK. URL to the Commerce Control List.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"405" : {
"description" : "Method not allowed. Use POST.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"406" : {
"description" : "Not Acceptable. This resource produces application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"415" : {
"description" : "Unsupported Media Type. This resource accepts application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"500" : {
"description" : "Internal server error. See errorMessage for details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
}
}
}
},
"/ExportControlApplications/ecTransaction" : {
"post" : {
"tags" : [ "Export Control Applications" ],
"summary" : "Get application for displaying an export control transaction.",
"description" : "Returns an URL for an application, which displays an export control transaction. Since 2022/11.",
"operationId" : "getECTransaction",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ECTransactionRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ECTransactionRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK. URL to displaying a transaction.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"405" : {
"description" : "Method not allowed. Use POST.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"406" : {
"description" : "Not Acceptable. This resource produces application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"415" : {
"description" : "Unsupported Media Type. This resource accepts application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"500" : {
"description" : "Internal server error. See errorMessage for details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
}
}
}
},
"/ExportControlApplications/euExportControlList" : {
"post" : {
"tags" : [ "Export Control Applications" ],
"summary" : "Get application for the EU export control list.",
"description" : "Returns an URL for an application, which displays the EU export control list.",
"operationId" : "getEUExportControlList",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EUExportControlListRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/EUExportControlListRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK. URL to the EU export control list application.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"405" : {
"description" : "Method not allowed. Use POST.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"406" : {
"description" : "Not Acceptable. This resource produces application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"415" : {
"description" : "Unsupported Media Type. This resource accepts application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"500" : {
"description" : "Internal server error. See errorMessage for details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
}
}
}
},
"/ExportControlApplications/expCtrlLogs" : {
"post" : {
"tags" : [ "Export Control Applications" ],
"summary" : "Get application for the overview of Export Controls log entries.",
"description" : "Returns an URL for an application, which displays the overview of Export Controls log entries.",
"operationId" : "getExpCtrlLogs",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExpCtrlLogsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ExpCtrlLogsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK. URL to an overview of Export Controls log entries.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"405" : {
"description" : "Method not allowed. Use POST.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"406" : {
"description" : "Not Acceptable. This resource produces application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
}
}
},
"415" : {
"description" : "Unsupported Media Type. This resource accepts application/json or application/xml.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorData"
}
},
"application/xml" : {
"schema" : {
# --- truncated at 32 KB (722 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-trade-compliance-management-openapi.json