How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB Trade Compliance Management API

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.

AEB Trade Compliance Management API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Trade Compliance, Sanctions Screening, Denied Party Screening, Export Control, and Customs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a GitHub repository.

This API exposes 137 operations across 131 paths, organized into 23 resource areas, and defines 303 schemas. It is described by OpenAPI 3.0.1, at version 4.0.

Requests are made against a single base URL, https://rz3.aeb.de/test4ce/rest.

137 operations 131 paths 303 schemas 3 DELETE38 GET95 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.0
Base URL
https://rz3.aeb.de/test4ce/rest
Authentication
API Key, HTTP Basic
Resource Areas
23

Authentication & Security 2

AEB Trade Compliance Management API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY). It accepts HTTP basic authentication (BASIC_AUTH). By default, every request must be authenticated.

Paths & Operations 137

Across 131 paths, the API surfaces 137 operations — 3 DELETE, 38 GET, 95 POST, 1 PUT. They span 23 resource areas, including Compliance Foundation, CoreBFBean, Export Control Applications, Export Control Internal, Export Control, FoundationAFBean, Logon, DataFeedBFBean, and 15 more. Each is listed below with its method, path, parameters, and response codes.

Compliance Foundation 1

API for the compliance foundation.

POST
/ComplianceFoundation/getMasterdataIdentifiers
Returns the identifiers of master data for a client.
getMasterdataIdentifiers body → 200400401405406415500
CoreBFBean 12

API for the XNSGFoundation

POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
checkBFFunctionExists body → 200
POST
/CoreBFBean/echo
Returns the given echo parameter value.
echo 1 param → 200
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
echoUpperCase 1 param → 200
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
getAllMonitoringValues → 200
GET
/CoreBFBean/getBuildForSolution
Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFBLDSOL\".
getBuildForSolution 1 param → 200
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
getMonitoringValue 2 params → 200
GET
/CoreBFBean/getProductInfo
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/XNSGIFPRINFO\".
getProductInfo → 200
GET
/CoreBFBean/getRuntimeInfo
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/XNSGIF…
getRuntimeInfo → 200
POST
/CoreBFBean/getRuntimeState
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 installati…
getRuntimeState body → 200
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
getThreadDump → 200
GET
/CoreBFBean/getVersionForSolution
Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFVERSOL\".
getVersionForSolution 1 param → 200
POST
/CoreBFBean/restartRFCServer
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 def…
restartRFCServer → 200
Export Control Applications 6

Get URLs to various parts of the Export Controls application.

POST
/ExportControlApplications/commerceControlList
Get application for the Commerce Control List.
getCommerceControlList body → 200400401405406415500
POST
/ExportControlApplications/ecTransaction
Get application for displaying an export control transaction.
getECTransaction body → 200400401405406415500
POST
/ExportControlApplications/euExportControlList
Get application for the EU export control list.
getEUExportControlList body → 200400401405406415500
POST
/ExportControlApplications/expCtrlLogs
Get application for the overview of Export Controls log entries.
getExpCtrlLogs body → 200400401405406415500
POST
/ExportControlApplications/goodsAttributeValuesList
Get application for the list of all known values of the specified goods attribute.
getGoodsAttributeValuesList body → 200400401405406415500
POST
/ExportControlApplications/quickCheck
Get application for a Quick check.
getQuickCheck body → 200400401405406415500
Export Control Internal 1

Internal API for export control

POST
/ExportControlInternal/setFinalTransactionLabelHost
Update existing transaction labels.
setFinalTransactionLabelHost body → 200400401405406415500
Export Control 8

API for export control

POST
/ExportControl/v2/acknowledgeGetChangedTransactions
Acknowledge changed results of EC check transactions.
acknowledgeGetChangedTransactions body → 200400401405406415500
POST
/ExportControl/v2/checkTransaction
Check a transaction in Export Controls.
checkTransaction body → 200400401405406415500
POST
/ExportControl/v2/createQuestionnaireForTransaction
Create a new questionnaire for a transaction in Export Controls
createQuestionnaireForTransaction body → 200400401405406415500
POST
/ExportControl/v2/deleteTransaction
To be invoked when a transaction in the partner system is deleted.
deleteTransaction body → 200400401405406415500
POST
/ExportControl/v2/finalizeApproval
Finalize an approval.
finalizeApproval body → 200400401405406415500
POST
/ExportControl/v2/getChangedTransactions
Get the changed results of EC check transactions.
getChangedTransactions body → 200400401405406415500
POST
/ExportControl/v2/getTransactionCheckResult
Gets the check result for a certain EC check transaction.
getTransactionCheckResult body → 200400401405406415500
POST
/ExportControl/v2/updateCustomsInfo
Update customs info.
updateCustomsInfo body → 200400401405406415500
FoundationAFBean 2

Business facade for the XNSGFoundation UI API

POST
/FoundationAFBean/releaseApplicationFacade
Release a UI API which is no longer needed. This call will save resources in the server, because the server must not wait for the timeout of the UI API session but can release it earlier. The method…
releaseApplicationFacade 1 param → 200
POST
/FoundationAFBean/workplace
Creates an UI API to be able to display the workplace. The difference of this method compared to the the method \"IFoundationBF.getWorkplaceURL()\" is the fact, that no logon mask will be dipsplayed…
workplace body → 200
Logon 2

Authentication handler for the XNSGFoundation

GET
/logon/authToken
Logon from the "Authorization" header (e.g. type "Basic"). The generated authentication token can be used in subsequent calls in the "Authorization" header, type "Bearer".
authToken → 200401
POST
/logon/user
Logon with classical procedure: user, client and password.
logonUser body → 200
DataFeedBFBean 3

DataFeedBFBean

POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
acknowledgePublishedDataFeedParts body → 200
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
getDataFeedPartContentForRest 2 params → 200
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
getPublishedDataFeedParts body → 200
ExternalTelemetryBFBean 3

API for sending telemetry data from a third party system.

POST
/ExternalTelemetryBFBean/getStatus
Returns the current status of the telemetry system. The external system id must be sent with the request.
getTelemetryStatus body → 200
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
getTelemetryStatusByParams 2 params → 200
POST
/ExternalTelemetryBFBean/telemetryReport
Submits telemetry data for a new telemetry report. The external system id must be sent with the request, a client IdentCode only if client dependent.
sendTelemetryReport body → 200
FoundationBFBean 31

REST endpoint for FoundationBF

POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
acknowledgeFile body → 200
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
announceStop body → 200
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
cancelAnnounceStop body → 200
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
changeAdminPassword body → 200
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
queryClients 2 params → 200
POST
/FoundationBFBean/client
Create a client.
createClient body → 200
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
downloadFile body → 200
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
generateClientIdentCode body → 200
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
getAllActiveClients → 200
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
getAllMonitoringValues_1 → 200
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
getBuildForSolution_1 1 param → 200
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
getDownloadableFilesRefs body → 200
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
getMonitoringValue_1 2 params → 200
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
getNumberOfClients → 200
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
getProductInfo_1 → 200
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
getRuntimeInfo_1 → 200
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
getScriptExecutionState body → 200
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
getTableUpdateState body → 200
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
getUploadSettings body → 200
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
getVersionForSolution_1 1 param → 200
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
getWorkplaceURL → 200
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
isDebtorNumberKnown 1 param → 200
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
publishUserMessage body → 200
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
requestReport → 200
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
requestReport_1 1 param → 200400404
POST
/FoundationBFBean/restartRFCServer
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 def…
restartRFCServer_1 → default
POST
/FoundationBFBean/sendMail
Sends a mail.
sendMail body → 200
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
startScriptExecution body → 200
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
startTableUpdate body → 200
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
systemSearch 1 param body → 200
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
uploadFileMultiPart body → 200
RemoteAdminBFBean 2

Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR).

GET
/RemoteAdminBFBean/clientRoles/{clientId}
getRoles
getRolesForClient 1 param → 200404
GET
/RemoteAdminBFBean/roles
getRoles
getRolesGET 3 params → 200
SyncBFBean 6

API for synchronizing data asynchronous from an engine to a client system.

POST
/SyncBFBean/acknowledgeEvents
Acknowledge events got with {@link getNotAcknowledgedEvents(SyncEventsRequestDTO)}. Since XNSG 4.0, Nov. FP, 2017 .
acknowledgeEvents body → 200
POST
/SyncBFBean/getNotAcknowledgedEvents
Poll any not acknowledged events for the client system. This method does not require, that the client system fills {@link SyncEventsRequestDTOsyncId}. However, it requires, that a call to {@link ackn…
getNotAcknowledgedEvents body → 200
POST
/SyncBFBean/getPartnerSystemSubscriptions
Fetch a list of registered subscriptions (either all or filtered by the business object type). Only subscription belonging to the provided clientSystemId are returned (mandatory field) Since XNSG 4.0…
getPartnerSystemSubscriptions body → 200
POST
/SyncBFBean/subscribePartnerSystem
Subscribe a partner system to be able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fi…
subscribePartnerSystem body → 200
POST
/SyncBFBean/synchronizeEvents
Poll the next events for the client system. This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTOsyncId} See {@…
synchronizeEvents body → 200
POST
/SyncBFBean/unsubscribePartnerSystem
Unsubscribe a partner system from being able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both manda…
unsubscribePartnerSystem body → 200
License Management 1

API for License Management

POST
/LicenseManagement/getTransactionApprovalsCustomsData
Get the customs data of the approvals for one or more check transactions.
getTransactionApprovalsCustomsData body → 200400401405406415500
Companies 5

Rest API for companies

GET
/companies/{id}
Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique . In this case an error is returned.
getCompany 1 param → 200400404
PUT
/companies/{id}
Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updat…
createOrUpdateCompany 1 param body → 200400404409
DELETE
/companies/{id}
Delete the company with the specified ID (company number). The ID is in some AEB services not unique , in this case a conflict (409) is returned.
deleteCompany 1 param → 200400404409
GET
/companies
Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If th…
searchCompanies 9 params → 200400
GET
/company-roles
Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
getCompanyRoles → 200
Compliance Screening Applications 11

Get URLs to various parts of the Compliance Screening application.

POST
/ComplianceScreeningApplications/manualAddressScreening
Manual address screening UI
manualAddressScreening body → 200400401405406415500
POST
/ComplianceScreeningApplications/manualLogEntry
Manual log entry editor
manualLogEntry body → 200400401405406415500
POST
/ComplianceScreeningApplications/matchHandlingView
Match handling overview
matchHandlingView body → 200400401405406415500
POST
/ComplianceScreeningApplications/matchHandlingViewEntry
Match handling entry
matchHandlingViewEntry body → 200400401405406415500
POST
/ComplianceScreeningApplications/restrictedPartyAddress
Restricted party address
restrictedPartyAddress body → 200400401405406415500
POST
/ComplianceScreeningApplications/restrictedPartyList
Restricted party list
restrictedPartyList body → 200400401405406415500
POST
/ComplianceScreeningApplications/screeningLogEntry
Screening log entry editor
screeningLogEntry body → 200400401405406415500
POST
/ComplianceScreeningApplications/screeningLogs
Screening logs overview
screeningLogs body → 200400401405406415500
POST
/ComplianceScreeningApplications/screeningProtocolEntrydeprecated
Screening log entry editor
screeningProtocolEntry body → 200400401405406415500
POST
/ComplianceScreeningApplications/statisticalData
Statistical overview application
statisticalData body → 200400401405406415500
POST
/ComplianceScreeningApplications/statisticalKeyFigures
Statistical key figures application
statisticalKeyFigures body → 200400401405406415500
Compliance Screening Internal 1

Internal API for compliance screening

POST
/ComplianceScreeningInternal/setFinalReferenceComment
Update existing reference comments.
setFinalReferenceComment body → 200400401405406415500
Compliance Screening 11

API for restricted party list screening

POST
/ComplianceScreening/acknowledgeMatchHandlingChanges
Acknowledge changed match handling results.
acknowledgeMatchHandlingChanges body → 200400401405406415500
GET
/ComplianceScreening/aliasAddresses
Get aliases of an address
aliasAddresses 3 params → 200400401405406415500
POST
/ComplianceScreening/countMatchHandlingMatches
Match count
countMatchHandlingMatches body → 200400401405406415500
POST
/ComplianceScreening/findMatchingAddresses
Find matching addresses
findMatchingAddresses body → 200400401405406415500
POST
/ComplianceScreening/goodGuy
A Good Guy
goodGuy body → 200400401405406415500
GET
/ComplianceScreening/lastRestrictedPartyListUpdate
Get last update date of a restricted party list
lastRestrictedPartyListUpdate 2 params → 200400401405406415500
POST
/ComplianceScreening/logEntry
Create a log entry
logEntry body → 204400401405406415500
POST
/ComplianceScreening/matchHandlingChanges
Returns all match handling updates since the last synchronization.
matchHandlingChanges body → 200400401405406415500
GET
/ComplianceScreening/profiles
Get the Compliance profiles of a client
profiles 1 param → 200400401405406415500
POST
/ComplianceScreening/screenAddresses
Address screening
screenAddresses body → 200400401405406415500
POST
/ComplianceScreening/screeningStatisticData
Find statistic data
screeningStatisticData body → 200400401405406415500
Risk Assessment Applications 2

Get URLs to various parts of the Risk Assessment application.

POST
/RiskAssessmentApplications/questionnaire
Questionnaire
questionnaire body → 200400401405406415500
POST
/RiskAssessmentApplications/searchQuestionnaires
Questionnaire overview
searchQuestionnaires body → 200400401405406415500
Risk Assessment 3

API for Risk Assessment

POST
/RiskAssessment/countQuestionnaires
Questionnaire count
countQuestionnaires body → 200400401405406415500
POST
/RiskAssessment/getQuestionnaireSummary
Questionnaire summary
getQuestionnaireSummary body → 200400401405406415500
POST
/RiskAssessment/invalidateQuestionnaires
Invalidate questionnaires
invalidateQuestionnaires body → 200400401405406415500
WorkstationServiceAgent 6

Connection handler for the Workstation Service Agent

GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
connect 1 param → 200401
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
disconnect0 1 param → 204401
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
status0 2 params → 200404401
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
connect0 5 params → 200401
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
disconnect1 1 param → 204401
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
status 2 params → 200401
GenericAFBean 2

API to open views that support this generic interface.

GET
/GenericAFBean/getGenericApplicationFacadeInfo
getGenericApplicationFacadeInfo → default
POST
/GenericAFBean/applications/{applicationName}
open 1 param body → default
TariffContent20BFBean 15

API for the tariff content solution (version 2.0).

POST
/TariffContent20BFBean/getAESCertificateTypes
Gets all certificates for a specific country.
getAESCertificateTypes body → default
POST
/TariffContent20BFBean/getAdditionalCodeProposals
Gets proposals additional codes for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
getAdditionalCodeProposals body → default
POST
/TariffContent20BFBean/getCertificateProposals
Gets proposals for certificates/documents for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
getCertificateProposals body → default
POST
/TariffContent20BFBean/getCommodityCode
Gets the data of exactly one commodity code. This function can also be used to check the validity of a commodity code.
getCommodityCode body → default
POST
/TariffContent20BFBean/getCommodityCodeSubstitutions
A list of commodity code substitutions, normally relevant for a turn of the year.
getCommodityCodeSubstitutions body → default
POST
/TariffContent20BFBean/getCommodityCodes
All valid commodity codes for the given decisive date.
getCommodityCodes body → default
POST
/TariffContent20BFBean/getContents
A list of contents which are licensed for the given client.
getContents body → default
POST
/TariffContent20BFBean/getCountriesForCountryGroup
A list of countries referenced in the given country group.
getCountriesForCountryGroup body → default
POST
/TariffContent20BFBean/getCountryGroups
A list of all country groups related in the tariff content.
getCountryGroups body → default
POST
/TariffContent20BFBean/getExportControlNumber
Gets the data of exactly one export control number. This function can also be used to check the validity of a export control number.
getExportControlNumber body → default
POST
/TariffContent20BFBean/getExportControlNumberMapping
Gets the mapping data of a commodity code to a list of export control numbers.
getExportControlNumberMapping body → default
POST
/TariffContent20BFBean/getExportControlNumbers
All valid export control numbers for the given decisive date.
getExportControlNumbers body → default
POST
/TariffContent20BFBean/getImportMeasures
Gets all valid import measures for a commodity code, country, content and decisive date.
getImportMeasures body → default
POST
/TariffContent20BFBean/getKnCodeCertificateProposalsdeprecated
Gets the proposals for certificates/documents for a specific combination of commodity code, decisive date, destination country's ISO-code and a descriptions' language ISO-code. @deprecated This metho…
getKnCodeCertificateProposals body → default
POST
/TariffContent20BFBean/getKnCodeCertificateTypes
Gets all certificates for a specific knCode/country/destination-id/decisive date combination.
getKnCodeCertificateTypes body → default
CustomsContentServiceBF 3

API providing services around customs content (nomenclatures, export control lists).

GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCode/{code}
Requests one final code from a catalog.
getFinalCode 7 params → default
GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCodes
Requests final codes from a catalog. Result may be resticted with a prefix.
getFinalCodes 7 params → default
GET
/CustomsContentServiceBF/content/{contentIdentCode}/search/{searchTerm}
Searches for codes matching the given criteria.
searchCodes 7 params → default

Schemas 303

The contract defines 303 schemas that model the data the API accepts and returns. The most detailed are RestrictedPartyAddressDTO (51 properties), GoodGuyAddressDTO (46 properties), AddressToCheckDTO (41 properties), Company (24 properties). Each schema is shown below with its type and property counts.

GetMasterdataIdentifiersResponseDTO
object
Response object for /ComplianceFoundation/getMasterdataIdentifiers
5 properties
MasterdataIdentifierDTO
object
Represents a master data identifier.
2 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
ErrorData
object
2 properties
GetMasterdataIdentifiersRequestDTO
object
Request object for /ComplianceFoundation/getMasterdataIdentifiers
5 properties 1 required
BFFunctionExistsDTO
object
Result DTO for the checkBusinessFacadeFunctionExists function
2 properties
BFFunctionDTO
object
Describe a API to be called.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
RuntimeStateResultDTO
object
This class holds various information items of the server which serves this request.
5 properties
RuntimeStateParmDTO
object
This class contains parameter about asking the server about its runtime state.
AFExecuteProcessParmsDTO
object
Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
3 properties
AFShellExecuteParmsDTO
object
Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the co…
2 properties
ApplicationFacadeDTO
object
A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of th…
5 properties
ApplicationFacadeParmsDTO
object
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
16 properties
CommerceControlListRequestDTO
object
Request object for Commerce Control List application.
2 properties
EccnListParmsDTO
object
Parameters for the Commerce Control List application.
1 property
ECTransactionParmsDTO
object
Parameters for the export control transaction application.
2 properties 2 required
ECTransactionRequestDTO
object
Request object for opening the export control transaction application.
2 properties 2 required
EUExpCtrlListParmsDTO
object
Parameters for the EU export control list application
1 property
EUExportControlListRequestDTO
object
Request object for the EU export control list application.
2 properties
ExpCtrlLogsAFParmsDTO
object
Data transfer object with filter options for the export control logs application.
4 properties
ExpCtrlLogsRequestDTO
object
Request object for the export control logs application.
2 properties
GoodsAttributeValuesListRequestDTO
object
Request object for the list of goods attribute values application.
2 properties
GoodsAttributeValuesParmsDTO
object
Parameters for the goods attribute application.
1 property
ECClassificationDTO
object
An attribute with a value for a transaction item.
2 properties
QuickCheckParmsDTO
object
Parameters for the Quick check application.
10 properties
QuickCheckRequestDTO
object
Request object for the Quick check application.
2 properties
SetFinalLabelRequestDTO
object
Request DTO for /ExportControlInternal/setFinalTransactionLabelHost containing identifying data for the entries to be updated as well as the new transaction la…
6 properties 2 required
SetFinalLabelResponseDTO
object
On success this response will be empty. In case of failure see messages for error details.
4 properties
AcknowledgeGetChangedTransactionsResponseDTO
object
Response for /ExportControl/v2/acknowledgeGetChangedTransactions .
4 properties
AcknowledgeGetChangedTransactionsRequestDTO
object
Request to acknowledge changed results of EC check transactions.
5 properties
CheckTransactionResponseDTO
object
Represents a response of checking a transaction in Export Controls.
6 properties
ECApprovalInfoDTO
object
DTO representing an approval used in the current item to release a restriction or a required license.
7 properties
ECItemCheckResultDTO
object
The export control result for one item of the transaction.
4 properties
ECLicenseReferenceDTO
object
DTO used for referencing a real license and license item.
2 properties
ECLocalizedTextDTO
object
Encapsulates a text in one language.
2 properties
ECPluginCheckResultDTO
object
The export control result of a jurisdiction checked for a transaction item.
3 properties
CheckTransactionRAParmsDTO
object
Parameters to integrate Risk Assessment in an export control check.
4 properties
CheckTransactionRequestDTO
object
Represents a request to check a transaction in Export Controls. clientIdentCode and clientSystemId are mandatory fields. Client system ID "COMPLIANCE SERVER" i…
9 properties 2 required
CreateRAQuestionnaireDataDTO
object
Initial data for a new questionnaire.
5 properties
ECAmountDTO
object
A pair of a value with a currency.
2 properties
ECCompletionStatusDTO
object
The completion status of the product data for a specific jurisdiction.
2 properties
ECIdentityOfGoodsDTO
object
Specifies the identity of goods.
2 properties
ECItemDTO
object
One item of a transaction to be checked for export control restrictions.
22 properties 2 required
ECJurisdictionFilterDTO
object
Allows to filter (, i.e., restrict) the jurisdictions to consider in export control checks. This is possible in the following ways: Limiting filter mode (value…
2 properties 1 required
ECPartnerDTO
object
DTO for a partner (typically a company) related to this export process. A partner can be the seller, the buyer, the receiver the final user, ...
19 properties 1 required
ECTransactionDTO
object
Data about the transaction.
6 properties 2 required
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
CreateQuestionnaireForTransactionResponseDTO
object
The response to a request to explicitly create a questionnaire. Empty on success.
4 properties
CreateQuestionnaireForTransactionRequestDTO
object
A request to explicitly create a questionnaire for an EC check transaction.
8 properties 3 required
DeleteTransactionResponseDTO
object
Response of /ExportControl/v2/deleteTransaction .
4 properties
DeleteTransactionRequestDTO
object
Represents a request to delete a check transaction in Export Controls. clientIdentCode and clientSystemId are mandatory fields. Client system ID "COMPLIANCE SE…
5 properties 1 required
FinalizeApprovalResponseDTO
object
Response of /ExportControl/v2/finalizeApproval .
4 properties
FinalizeApprovalRequestDTO
object
Represents a request to finalize an approval in Export Controls. clientIdentCode is a mandatory field.
7 properties 3 required
GetChangedTransactionsRequestDTO
object
Request to get the changed results of EC check transactions.
4 properties
ECApprovalInfoV2DTO
object
DTO representing an approval used to release a restriction or a required license in a jurisdiction for a transaction item.
6 properties
ECItemCheckResultV2DTO
object
The export control result for one item of the transaction.
4 properties
ECPluginCheckResultV2DTO
object
The export control result of a jurisdiction checked for a transaction item.
3 properties
ECTransactionCheckResultV2DTO
object
The export control result for a whole transaction. Note that this DTO is inspired by ECTotalCheckResultDTO and CheckTransactionResponseDTO. There is no explici…
4 properties
GetChangedTransactionsResponseDTO
object
Response when getting the changed results of EC check transactions.
7 properties
GetTransactionCheckResultResponseDTO
object
Response when getting the check result of a certain EC check transaction.
6 properties
GetTransactionCheckResultRequestDTO
object
Request to get the check result of a certain EC check transaction.
5 properties 1 required
UpdateCustomsInfoResponseDTO
object
Response of /ExportControl/v2/updateCustomsInfo .
4 properties
UpdateCustomsInfoRequestDTO
object
Represents a request to update customs information in Export Controls. clientIdentCode is a mandatory field.
12 properties 3 required
LogonResponse
object
5 properties
LogonArgument
object
4 properties
AcknowledgePublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
4 properties
AcknowledgePublishedDataFeedPartsRequestDTO
object
Request parameter for Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
5 properties
GetPublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
7 properties
PublishedDataFeedPartDTO
object
DTO to hold the data of a published data feed part.
9 properties
GetPublishedDataFeedPartsRequestDTO
object
Request parameter for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
4 properties
ExternalTMStatusResponseDTO
object
Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.
8 properties
ExternalTMIdentificationRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
6 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
ExternalTMResponseDTO
object
Response DTO for all calls to ExternalTelemetryBFBean.
10 properties
ExternalTMRDateEntryDTO
object
telemetry report entry for date values
3 properties
ExternalTMRDoubleEntryDTO
object
telemetry report entry for string double
3 properties
ExternalTMRIntegerEntryDTO
object
telemetry report entry for integer values
3 properties
ExternalTMRLongEntryDTO
object
telemetry report entry for long values
3 properties
ExternalTMRStringArrayEntryDTO
object
telemetry report entry for string array values
3 properties
ExternalTMRStringEntryDTO
object
telemetry report entry for string values
3 properties
ExternalTMReportRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
8 properties
ExternalTelemetryReportDTO
object
report dto to ship the telemetry data to an XNSG engine
6 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
ActivationDataFlavor
object
2 properties
CommandInfo
object
2 properties
CommandMap
object
1 property
DataHandler
object
The content of a file
10 properties
DataSource
object
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
LinkDTO
object
links associated with the tip
3 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
RoleInfoDTO
object
dto for roles
9 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
StartTableUpdateResultDTO
object
Contains the result information of the start table update bf
StartTableUpdateParmDTO
object
parameter necessary for the table update
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
RoleDTO
object
data about a role
6 properties
RoleTextDTO
object
language dependent values of a role
2 properties
RolesOfClientDTO
object
Response DTO for listing roles assignable to users of a client.
2 properties
ClientRolesDTO
object
Response DTO for listing client specific roles in GetRolesResponseDTO.
2 properties
GetRolesResponseDTO
object
DTO for GetRoles response
6 properties
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties 2 required
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties 1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties 1 required
ApprovalCustomsDataDTO
object
For every jurisdiction there may be zero or 1 approval for a transaction item. For every approval, at least one ApprovalCustomsDataDTO is returned. For approva…
11 properties
ApprovalCustomsDataExtensionDTO
object
Country specific property (field and value) in a ApprovalCustomsDataDTO .
2 properties
TransactionApprovalsCustomsDataDTO
object
Provides the customs data (based on approvals) of the transaction with the specified transactionIdHost .
2 properties
TransactionApprovalsCustomsDataResponseDTO
object
Response DTO for /LicenseManagementBF/getTransactionApprovalsCustomsData
5 properties
TransactionItemApprovalsCustomsDataDTO
object
Provides the customs data (based on approvals) of the item with the specified itemIdHost .
2 properties
TransactionApprovalsCustomsDataRequestDTO
object
Request DTO for /LicenseManagementBF/getTransactionApprovalsCustomsData
5 properties 1 required
Company
object
A complete address of a company.
24 properties 3 required
CompanyRole
object
A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.
2 properties 1 required
CompanyPage
object
2 properties 2 required
CompanyRoleList
object
1 property 1 required
ManualAddressScreeningParmsDTO
object
Application specific parameters to display the manual address screening application.
1 property
ManualAddressScreeningRequestDTO
object
Request object to get the URL to display the manual address screening application.
2 properties
ManualLogEntryRequestDTO
object
Request object to get the URL to display the manual log entry application.
2 properties
ManualProtocolEntryAFParmsDTO
object
Application specific parameters to display the manual log entry application.
5 properties
MatchHandlingOverviewParmsDTO
object
Application specific parameters to display the match handling overview. If omitted, the default view is used.
1 property
MatchHandlingOverviewRequestDTO
object
Request object to get the URL to display the match handling overview.
2 properties
MatchHandlingEntryAFParmsDTO
object
Application specific parameters to display a match handling entry.
4 properties 1 required
MatchHandlingEntryRequestDTO
object
Request object to get the URL to display a match handling entry.
2 properties
RestrictedPartyAddressParmsDTO
object
Application specific parameters to display a restricted party address.
1 property
RestrictedPartyAddressRequestDTO
object
Request object to get the URL to display a restricted party address.
2 properties
RestrictedPartyListParmsDTO
object
Application specific parameters to display a restricted party list.
1 property
RestrictedPartyListRequestDTO
object
Request object to get the URL to display a restricted party list.
2 properties
ScreeningProtocolEntryParmsDTO
object
Application specific parameters to display a screening log entry for an address match, Good Guy alarm or non match.
5 properties
ScreeningProtocolEntryRequestDTO
object
Request object to get the URL to display a screening log entry for an address match, Good Guy alarm or non match.
2 properties
ScreeningLogsParmsDTO
object
Application specific parameters to display the screening logs application.
4 properties
ScreeningLogsRequestDTO
object
Request object to get the URL to display the screening logs application.
2 properties
StatisticalDataParmsDTO
object
Application specific parameters to display the statistical overview application.
5 properties
StatisticalDataRequestDTO
object
Request object to get the URL to display the statistical overview application.
2 properties
StatisticalKeyFiguresParmsDTO
object
Application specific parameters to display the statistical key figures.
5 properties
StatisticalKeyFiguresRequestDTO
object
Request object to get the URL to display the statistical key figures.
2 properties
SetFinalCommentRequestDTO
object
Request DTO for /ComplianceScreeningInternal/setFinalReferenceComment containing identifying data for the entries to be updated as well as the new reference co…
6 properties 2 required
SetFinalCommentResponseDTO
object
On success this response will be empty. In case of failure see messages for error details.
4 properties
AcknowledgeGetMatchHandlingChangesResponseDTO
object
Response for /ComplianceScreening/matchHandlingChanges .
4 properties
AcknowledgeGetMatchHandlingChangesRequestDTO
object
Request to acknoledge changed match handling results.
5 properties
AddressIdDTO
object
Data transfer object for encoding of IDs of addresses, e.g. like DUNS number or passport number.
2 properties 1 required
RestrictedPartyAddressDTO
object
Data transfer object for addresses found in a restricted party list which match a given address.
51 properties
AebProblem
object
8 properties
AebProblemError
object
Array of related errors
4 properties
MatchHandlingCountResponseDTO
object
Represents the response of counting matches.
5 properties
MatchHandlingCountFilterParmsDTO
object
Parameters to configure the match handling view when counting the matches.
1 property
MatchHandlingCountRequestDTO
object
Represents the request for counting matches in the match handling overview.
5 properties
AddressScreeningConditionDTO
object
Data transfer object for a condition for an address check.
2 properties 1 required
AddressScreeningParametersDTO
object
Data transfer object for parameters of the address screening.
11 properties 2 required
AddressToCheckDTO
object
Data transfer object for an address to be screened against restricted party lists.
41 properties
FindMatchingAddressesRequestDTO
object
Request object to find restricted party addresses matching a given address.
2 properties
GoodGuyDefinitionResultDTO
object
The result of a Good Guy definition request.
1 property
GoodGuyAddressDTO
object
Data transfer object for a Good Guy address.
46 properties 2 required
GoodGuyConditionDTO
object
Condition of a Good Guy. Allows to define that a Good Guy is only valid in a certain context like a specific order or transaction.
2 properties 1 required
LastRestrictedPartyListUpdateResponseDTO
object
DTO for wrapping the a "simple" Date result of a function to something, which is JSON-able.
1 property
ClientSystemComplianceEventDTO
object
Data transfer object describing a log event of the client system.
11 properties 2 required
GetMatchHandlingChangesResponseDTO
object
Response when getting changed match handling results.
7 properties
MatchHandlingSyncDTO
object
The sync results of one handled match.
4 properties
GetMatchHandlingChangesRequestDTO
object
Request to get changed match handling results.
4 properties
ProfileDTO
object
Data transfer object for a Compliance profile.
2 properties
AddressScreeningResultDTO
object
Data transfer object for the results of address screening.
4 properties
ScreenAddressesRequestDTO
object
Request object for screening addresses against restricted party lists.
2 properties
GetScreeningStatisticDataResponseDTO
object
Data transfer object for statistic data in Compliance Screening.
5 properties
ScreeningStatisticDataDTO
object
Data transfer object for statistic data in Compliance Screening.
23 properties
GetScreeningStatisticDataRequestDTO
object
Data transfer object for requesting statistic data in Compliance Screening.
8 properties 2 required
QuestionnaireParmsDTO
object
Passing the parameters to identify the questionnaire. The fields questTemplId , clientSystemId , and referenceIdHost are mandatory.
4 properties 3 required
QuestionnaireRequestDTO
object
Request for the application open questionnaire.
2 properties
AbsoluteIntervalFilterDTO
object
Initializes the filter with a fix interval between two dates.
2 properties
DateTimeIntervalRangeFilterDTO
object
Represents a possibility to pass a date time interval range filter. Use one of the given attributes to pass the filter. If more than one attribute is filledthe…
2 properties
IntervalFromNowFilterDTO
object
Initializes the filter with a time interval relative to 'today'.
2 properties
QuestionnairesFilterParmsDTO
object
Passing the filters of the questionaires.
13 properties
RelativeIntervalFilterDTO
object
Initializes the filter with a relative time range. If only one attribute is filled, the interval is relative to 'today'.
2 properties
SearchQuestionnairesRequestDTO
object
Request for the application search questionnaires.
2 properties
RAQuestionnairesCountResponseDTO
object
Represents the response of counting questionnaires.
5 properties
RAQuestionnairesCountRequestDTO
object
Represents the request for a count of questionnaires.
5 properties
QuestionnaireCriticalResultDTO
object
Data about a critical result of a questionnaire.
1 property
QuestionnaireSummaryDTO
object
Summary data of a single questionnaire.
6 properties
QuestionnaireSummaryResponseDTO
object
Represents the response of questionnaire summary.
5 properties
QuestionnaireSummaryRequestDTO
object
Represents a request for a summary of the most recent valid questionnaire(s). The fields clientIdentCode , referenceIdHost , and transactionIdHost are mandator…
6 properties 1 required
InvalidateQuestionnairesResponseDTO
object
Represents the response of invalidating questionnaires. The response is empty, unless an error occurs.
4 properties
InvalidateQuestionnairesRequestDTO
object
Represents a request for invalidating questionnaires. The fields clientIdentCode , clientSystemId , and referenceIdHost are mandatory.
6 properties 1 required
DesktopAgentInfo
object
16 properties
LauncherInfo
object
2 properties
PerfMonitoringInfo
object
3 properties
ProcessInfo
object
6 properties
SessionInfo
object
1 property
TracingInfo
object
6 properties
WorkstationSessionInfoDTO
object
3 properties
WorkstationAgentConnectionTimeouts
object
4 properties
ApplicationInfoDTO
object
Contains information about an application, that can be accessed via GenericAFopen
2 properties
GenericApplicationFacadeInfoDTO
object
The result DTO for getGenericApplicationFacadeInfo().
5 properties
GenericParameterInfoDTO
object
Information about a specific parameter for an application.
7 properties
GenericApplicationFacadeParmsDTO
object
A generic request for an application facade.
18 properties
GenericParameterDTO
object
A name-value pair representing a single parameter.
2 properties
TCAESCertificateTypeDTO
object
DTO containing the extended field of a aes certificate.
13 properties
TCDateDTO
object
Contains a date as string.
1 property
TCGetAESCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given country.
2 properties
TCUserMessageDTO
object
DTO encapsulates problem and information messages.
2 properties
TCGetAESCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates of a specific country
2 properties
TCCommodityCodeAdditionalCodeDTO
object
Result DTO to hold code and description of an additional code
1 property
TCCommodityCodeMeasureAdditionalCodeDTO
object
Result DTO to hold information of a measure with additional code.
2 properties
TCCommodityCodeMeasureTypeDTO
object
Result DTO to hold code and description of a measure.
2 properties
TCGetAdditionalCodeProposalsResultDTO
object
Result DTO to hold measures with additional codes.
2 properties
TCGetAdditionalCodeProposalsRequestDTO
object
DTO to hold request data to get additional codes.
6 properties
TCCommodityCodeCertificateDTO
object
Result DTO to hold the information of a certificate/produced document
2 properties
TCCommodityCodeMeasureCertificatesDTO
object
Result DTO to hold information of a measure with certificates.
4 properties
TCGetCertificateProposalsResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCCommodityCodeMeasureCertificatesDTO for each measure that needs to be applied fo…
3 properties
TCGetCertificateProposalsRequestDTO
object
DTO to hold request data to get certificate/document proposals.
7 properties
TCCommodityCodeDTO
object
DTO to hold data of a valid commodity code.
6 properties
TCGetCommodityCodeResultDTO
object
Result DTO to hold exactly one commodity code
2 properties
TCGetCommodityCodeRequestDTO
object
DTO to hold request data to get exactly one commodity codes.
7 properties
TCCommodityCodeSubstitutionDTO
object
DTO to hold data of one commodity code substitution.
5 properties
TCGetCommodityCodeSubstitutionsResultDTO
object
DTO to hold a list of commodity code substitutions.
2 properties
TCGetCommodityCodeSubstitutionsRequestDTO
object
DTO to hold request data to get a list of commodity code substitutions.
5 properties
TCGetCommodityCodesResultDTO
object
Result DTO to hold list of TCCommodityCodeDTO
2 properties
TCGetCommodityCodesRequestDTO
object
DTO to hold request data to get a list of all valid commodity codes.
6 properties
TCContentDTO
object
DTO to hold meta data of a content.
2 properties
TCGetContentsResultDTO
object
Result DTO to hold a list of licensed contents.
2 properties
TCGetContentsRequestDTO
object
DTO to hold request data to get all licensed contents for the given client.
1 property
TCCountryInGroupDTO
object
DTO to hold data of a country referenced in a country group.
3 properties
TCGetCountriesForGroupResultDTO
object
DTO to hold result data of countries referenced in a country group.
2 properties
TCGetCountriesForGroupRequestDTO
object
DTO to hold request data to get all countries which belong to a given group.
4 properties
TCCountryGroupDTO
object
DTO to hold data of a country group
2 properties
TCCountryGroupTTDTO
object
DTO to hold language specific data of a country group.
3 properties
TCGetCountryGroupsResultDTO
object
DTO to hold result data of country groups related in the tariff content.
2 properties
TCGetCountryGroupsRequestDTO
object
DTO to hold request data to get all country groups related in the tariff content.
2 properties
TCExportControlNumberDTO
object
DTO to hold data of a valid export control number.
4 properties
TCGetExportControlNumberResultDTO
object
Result DTO to hold exactly one export control number.
2 properties
TCGetExportControlNumberRequestDTO
object
DTO to hold request data to get exactly one export control number.
5 properties
TCGetExportControlNumberMappingResultDTO
object
Result DTO to hold export control number mappings of a given commodity code
2 properties
TCGetExportControlNumberMappingRequestDTO
object
DTO to hold request data to get all proposed AL numbers for a KN codes.
5 properties
TCGetExportControlNumbersResultDTO
object
Result DTO to hold list of TCExportControlNumberDTO
2 properties
TCGetExportControlNumbersRequestDTO
object
DTO to hold request data to get a list of all valid export control numbers.
4 properties
TCDateRangeDTO
object
Describes a date range, spanning all days between a pair of TCDateDTO .
2 properties
TCGetImportMeasuresResultDTO
object
Result DTO to hold a list of import measures matching the request criteria. A TCImportMeasureDTO is returned for each matching import measure
2 properties
TCImportMeasureAdditionalCodeDTO
object
Represents additional code information within a TCImportMeasureDTO .
2 properties
TCImportMeasureCertificateDTO
object
Represents a certificate within a TCImportMeasureConditionDTO .
1 property
TCImportMeasureConditionDTO
object
Describes a conditional rate within a TCImportMeasureDTO .
6 properties
TCImportMeasureDTO
object
Result DTO representing a single import measure.
13 properties
TCImportMeasureFootnoteDTO
object
Describes a footnote within a TCImportMeasureDTO .
3 properties
TCImportMeasureRateComponentDTO
object
Result DTO representing one rate component of an import measure.
12 properties
TCGetImportMeasuresRequestDTO
object
DTO to hold request data for import measure requests
6 properties
TCKnCodeCertProposalResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCKnCodeMeasureInfoDTO for each measure that needs to be applied for materials wit…
3 properties
TCKnCodeMeasureCertificateDTO
object
Result DTO to hold the information about a certificate.
1 property
TCKnCodeMeasureInfoDTO
object
Result DTO to hold the certificate proposal for exactly one measure.
5 properties
TCKnCodeNationalCertificateDTO
object
Result DTO to hold the information of a national certificate.
2 properties
TCKnCodeCertProposalRequestDTO
object
DTO to hold request data to get certificate/document proposals.
5 properties
TCAESCertificateTypeSimpleDTO
object
DTO containing the basic fields of a certificate.
5 properties
TCGetKnCodeCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given kn code.
2 properties
TCGetKnCodeCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates for a specific kn code.
5 properties
CodeElementDTO
object
DTO to hold data of one code element of a nomenclature resp. an export control list.
5 properties
GetCodeResultDTO
object
DTO to hold a request result containing one code element of the nomenclature resp. the export control list.
5 properties
SupplementaryCodeElementInfoDTO
object
DTO to hold one type-casted supplementary information about a code element.
2 properties
GetFinalCodesResultDTO
object
DTO to hold a request result containing all final code elements of the nomenclature resp. the export control list.
5 properties
SearchCodesResultDTO
object
DTO to hold a search result containing all matching code elements of the nomenclature resp. the export control list.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-trade-compliance-management-openapi.json Raw ↑

Other APIs AEB publishes across the network.

AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Product Classification API
AEB Carrier Connect API
AEB Carrier Select API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB Document Service API
AEB BSM API
Where this information came from

This is an independent, third-party profile of AEB Trade Compliance Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.