# Trade Compliance Management Documentation

> AEB Trade Compliance Management API

## Guides: General
- [Accessing REST services](https://trade-compliance.docs.developers.aeb.com/docs/accessing-the-rest-services.md)

## Guides: Compliance Screening
- [Status synchronization](https://trade-compliance.docs.developers.aeb.com/docs/status-syncronization.md)
- [API Usage Scenarios](https://trade-compliance.docs.developers.aeb.com/docs/api-usage-scenarios-2.md)
  - [Simple integrated screening](https://trade-compliance.docs.developers.aeb.com/docs/simple-screening.md)
  - [Screening with integrated status synchronization](https://trade-compliance.docs.developers.aeb.com/docs/screening-with-integrated-re-screen.md)
  - [Screening with integrated good guy definition](https://trade-compliance.docs.developers.aeb.com/docs/screening-with-integrated-good-guy-definition.md)
  - [Screening Integration with UI-API](https://trade-compliance.docs.developers.aeb.com/docs/integration-with-ui-api.md)

## REST API: Trade Compliance Management HTTP API
- Compliance Foundation
  - [Returns the identifiers of master data for a client.](https://trade-compliance.docs.developers.aeb.com/reference/getmasterdataidentifiers.md): 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:…
- CoreBFBean
  - [/CoreBFBean/checkBFFunctionExists](https://trade-compliance.docs.developers.aeb.com/reference/checkbffunctionexists.md): Can be called to know if a BF function exist.
  - [/CoreBFBean/echo](https://trade-compliance.docs.developers.aeb.com/reference/echo.md): Returns the given echo parameter value.
  - [/CoreBFBean/echoUpperCase](https://trade-compliance.docs.developers.aeb.com/reference/echouppercase.md): Returns the given echo parameter value in uppercase.
  - [/CoreBFBean/getAllMonitoringValues](https://trade-compliance.docs.developers.aeb.com/reference/getallmonitoringvalues.md): Returns all available monitoring values of the server.
  - [/CoreBFBean/getBuildForSolution](https://trade-compliance.docs.developers.aeb.com/reference/getbuildforsolution.md): 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\".
  - [/CoreBFBean/getMonitoringValue](https://trade-compliance.docs.developers.aeb.com/reference/getmonitoringvalue.md): Returns the current monitoring value for the given group and name.
  - [/CoreBFBean/getProductInfo](https://trade-compliance.docs.developers.aeb.com/reference/getproductinfo.md): 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\".
  - [/CoreBFBean/getRuntimeInfo](https://trade-compliance.docs.developers.aeb.com/reference/getruntimeinfo.md): 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…
  - [/CoreBFBean/getRuntimeState](https://trade-compliance.docs.developers.aeb.com/reference/getruntimestate.md): 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…
  - [/CoreBFBean/getThreadDump](https://trade-compliance.docs.developers.aeb.com/reference/getthreaddump.md): Generate Thread-Dump.
  - [/CoreBFBean/getVersionForSolution](https://trade-compliance.docs.developers.aeb.com/reference/getversionforsolution.md): 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\".
  - [/CoreBFBean/restartRFCServer](https://trade-compliance.docs.developers.aeb.com/reference/restartrfcserver.md): 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…
- Export Control Applications
  - [Get application for the Commerce Control List.](https://trade-compliance.docs.developers.aeb.com/reference/getcommercecontrollist.md): Returns an URL for an application, which displays the Commerce Control List appliaction.
  - [Get application for displaying an export control transaction.](https://trade-compliance.docs.developers.aeb.com/reference/getectransaction.md): Returns an URL for an application, which displays an export control transaction. Since 2022/11.
  - [Get application for the EU export control list.](https://trade-compliance.docs.developers.aeb.com/reference/geteuexportcontrollist.md): Returns an URL for an application, which displays the EU export control list.
  - [Get application for the overview of Export Controls log entries.](https://trade-compliance.docs.developers.aeb.com/reference/getexpctrllogs.md): Returns an URL for an application, which displays the overview of Export Controls log entries.
  - [Get application for the list of all known values of the specified goods attribute.](https://trade-compliance.docs.developers.aeb.com/reference/getgoodsattributevalueslist.md): Returns an URL for an application, which displays the list of all known values of the specified goods attribute.
  - [Get application for a Quick check.](https://trade-compliance.docs.developers.aeb.com/reference/getquickcheck.md): Returns an URL for an application, which displays the Quick check.
- Export Control
  - [Acknowledge changed results of EC check transactions.](https://trade-compliance.docs.developers.aeb.com/reference/acknowledgegetchangedtransactions.md): A call to this endpoint acknowledges that your partner system has processed the changed transaction results retrieved by calling *getChangedTransactions*. Acknowledged events will not be available…
  - [Check a transaction in Export Controls.](https://trade-compliance.docs.developers.aeb.com/reference/checktransaction.md): Check a transaction in Export Controls. This call does not imply any approval management in the host system. Instead, if required, for each checked transaction from host system a check transaction is…
  - [Create a new questionnaire for a transaction in Export Controls](https://trade-compliance.docs.developers.aeb.com/reference/createquestionnairefortransaction.md): Explicitly create a new questionnaire for a transaction in Export Controls. In case other questionnaires already exist for the given transaction, they are marked as invalid and the newly created…
  - [To be invoked when a transaction in the partner system is deleted.](https://trade-compliance.docs.developers.aeb.com/reference/deletetransaction.md): Method to be invoked when a transaction in the partner system is deleted. Deletes the corresponding check transaction in Export Controls if existing.
  - [Get the changed results of EC check transactions.](https://trade-compliance.docs.developers.aeb.com/reference/getchangedtransactions.md): Get the changed results of EC check transactions. Returns the changed results of EC check transactions, that were created for EC check transaction created with the *checkTransaction* call. The result…
  - [Gets the check result for a certain EC check transaction.](https://trade-compliance.docs.developers.aeb.com/reference/gettransactioncheckresult.md): Gets the check result for a certain EC check transaction. The check result is returned without a new EC check being performed. If a check is desired, call *checkTransaction* instead.
  - [Finalize an approval.](https://trade-compliance.docs.developers.aeb.com/reference/finalizeapproval.md): Method to be invoked when an approval should be finalized. Finalizes the approval for the corresponding check transaction in Export Controls if existing.
  - [Update customs info.](https://trade-compliance.docs.developers.aeb.com/reference/updatecustomsinfo.md): Method to be invoked when customs info is to be updated. Updates the customs info for the corresponding check transaction in Export Controls if existing.
- Logon
  - [/logon/authToken](https://trade-compliance.docs.developers.aeb.com/reference/authtoken.md): 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".
  - [/logon/user](https://trade-compliance.docs.developers.aeb.com/reference/logonuser.md): Logon with classical procedure: user, client and password.
- DataFeedBFBean
  - [/DataFeedBFBean/acknowledgePublishedDataFeedParts](https://trade-compliance.docs.developers.aeb.com/reference/acknowledgepublisheddatafeedparts.md): Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
  - [/DataFeedBFBean/dataFeedParts/{client}/{id}](https://trade-compliance.docs.developers.aeb.com/reference/getdatafeedpartcontentforrest.md): Retrieve the data feed part content.
  - [/DataFeedBFBean/getPublishedDataFeedParts](https://trade-compliance.docs.developers.aeb.com/reference/getpublisheddatafeedparts.md): 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…
- SyncBFBean
  - [/SyncBFBean/acknowledgeEvents](https://trade-compliance.docs.developers.aeb.com/reference/acknowledgeevents.md): Acknowledge events got with {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)}.<br> Since XNSG 4.0, Nov. FP, 2017<br>.
  - [/SyncBFBean/getNotAcknowledgedEvents](https://trade-compliance.docs.developers.aeb.com/reference/getnotacknowledgedevents.md): Poll any not acknowledged events for the client system.<br> This method does not require, that the client system fills {@link SyncEventsRequestDTO#syncId}.<br> However, it requires, that a call to…
  - [/SyncBFBean/getPartnerSystemSubscriptions](https://trade-compliance.docs.developers.aeb.com/reference/getpartnersystemsubscriptions.md): Fetch a list of registered subscriptions (either all or filtered by the business object type).<br>Only subscription belonging to the provided <code>clientSystemId</code> are returned (mandatory…
  - [/SyncBFBean/subscribePartnerSystem](https://trade-compliance.docs.developers.aeb.com/reference/subscribepartnersystem.md): Subscribe a partner system to be able to receive events for the specified business object type.<br>The subscription is uniquely identified by the <code>clientSystemId</code> and…
  - [/SyncBFBean/synchronizeEvents](https://trade-compliance.docs.developers.aeb.com/reference/synchronizeevents.md): Poll the next events for the client system.<br> This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link…
  - [/SyncBFBean/unsubscribePartnerSystem](https://trade-compliance.docs.developers.aeb.com/reference/unsubscribepartnersystem.md): Unsubscribe a partner system from being able to receive events for the specified business object type.<br>The subscription is uniquely identified by the <code>clientSystemId</code> and…
- License Management
  - [Get the customs data of the approvals for one or more check transactions.](https://trade-compliance.docs.developers.aeb.com/reference/gettransactionapprovalscustomsdata.md): Returns the customs data associated with the approvals for one or more check transactions.
- Companies
  - [/companies/{id}](https://trade-compliance.docs.developers.aeb.com/reference/getcompany.md): Returns the company with the requested ID (company number). In some cases the ID (company number) is <b>not unique</b>. In this case an error is returned.
  - [/companies/{id}](https://trade-compliance.docs.developers.aeb.com/reference/createorupdatecompany.md): 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…
  - [/companies/{id}](https://trade-compliance.docs.developers.aeb.com/reference/deletecompany.md): Delete the company with the specified ID (company number). The ID is in some AEB services <b>not unique</b>, in this case a conflict (409) is returned.
  - [/companies](https://trade-compliance.docs.developers.aeb.com/reference/searchcompanies.md): 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…
  - [/company-roles](https://trade-compliance.docs.developers.aeb.com/reference/getcompanyroles.md): Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
- Compliance Screening Applications
  - [Manual address screening UI](https://trade-compliance.docs.developers.aeb.com/reference/manualaddressscreening.md): Returns a URL that allows you to embed manual address screening into another application.
  - [Manual log entry editor](https://trade-compliance.docs.developers.aeb.com/reference/manuallogentry.md): Returns a URL that allows you to embed an editor to enter a manual log entry into another application.
  - [Match handling overview](https://trade-compliance.docs.developers.aeb.com/reference/matchhandlingview.md): Returns a URL that allows you to embed the match handling overview into another application.
  - [Restricted party address](https://trade-compliance.docs.developers.aeb.com/reference/restrictedpartyaddress.md): Returns a URL that allows you to embed the restricted party address of one list entry into another application.
  - [Restricted party list](https://trade-compliance.docs.developers.aeb.com/reference/restrictedpartylist.md): Returns a URL that allows you to embed the restricted party list into another application.
  - [Screening log entry editor](https://trade-compliance.docs.developers.aeb.com/reference/screeninglogentry.md): Returns a URL that allows you to embed the screening log entry for an address match, Good Guy alarm or non match into another application.
  - [Screening logs overview](https://trade-compliance.docs.developers.aeb.com/reference/screeninglogs.md): Returns a URL that allows you to embed the screening logs overview into another application.
  - [Screening log entry editor](https://trade-compliance.docs.developers.aeb.com/reference/screeningprotocolentry.md): Returns a URL that allows you to embed the screening log entry for an address match, Good Guy alarm or non match into another application.
  - [Statistical overview application](https://trade-compliance.docs.developers.aeb.com/reference/statisticaldata.md): Returns a URL that allows you to embed the statistical overview into another application.
  - [Statistical key figures application](https://trade-compliance.docs.developers.aeb.com/reference/statisticalkeyfigures.md): Returns a URL that allows you to embed statistical key figures into another application.
  - [Match handling entry](https://trade-compliance.docs.developers.aeb.com/reference/matchhandlingviewentry.md): Returns a URL that allows you to embed a match handling entry into another application.
- Compliance Screening
  - [Get aliases of an address](https://trade-compliance.docs.developers.aeb.com/reference/aliasaddresses.md): Returns all alias addresses of a restricted party list address.
  - [Match count](https://trade-compliance.docs.developers.aeb.com/reference/countmatchhandlingmatches.md): Returns the number of matches for the requested match handling view. The default view is used if no match handling view is requested.
  - [Find matching addresses](https://trade-compliance.docs.developers.aeb.com/reference/findmatchingaddresses.md): Finds all restricted party addresses matching a given address. Can be used to get more details about matches found via 'screenAddresses'.
  - [A Good Guy](https://trade-compliance.docs.developers.aeb.com/reference/goodguy.md): Create a Good Guy if it does not already exist. A Good Guy with exactly the same address fields will not be created twice.
  - [Get last update date of a restricted party list](https://trade-compliance.docs.developers.aeb.com/reference/lastrestrictedpartylistupdate.md): Get the date, a restricted party list has last been updated at.
  - [Create a log entry](https://trade-compliance.docs.developers.aeb.com/reference/logentry.md): Create a new log entry.
  - [Get the Compliance profiles of a client](https://trade-compliance.docs.developers.aeb.com/reference/profiles.md): Get the Compliance profiles of a client.
  - [Address screening](https://trade-compliance.docs.developers.aeb.com/reference/screenaddresses.md): Screens addresses against restricted party lists.
  - [Find statistic data](https://trade-compliance.docs.developers.aeb.com/reference/screeningstatisticdata.md): Finds the statistic data such as number of address checks, matches, good-guy definitions etc. in Compliance Screening.
  - [Returns all match handling updates since the last synchronization.](https://trade-compliance.docs.developers.aeb.com/reference/matchhandlingchanges.md): Returns all match handling updates since the last synchronization. The result of a match handling might change if e.g. a match is set to 'processed' or a good guy was created within Trade Compliance…
  - [Acknowledge changed match handling results.](https://trade-compliance.docs.developers.aeb.com/reference/acknowledgematchhandlingchanges.md): A call to this endpoint acknowledges that your partner system has processed the changed match handling results retrieved by *matchHandlingChanges*. Acknowledged events will not be available for…
  - [Returns the latest match handling result for a single match.](https://trade-compliance.docs.developers.aeb.com/reference/singlematchhandlingstatus.md): Returns the latest match handling result for a single match. The result of a match handling might change if e.g. a match is set to 'processed' or a good guy was created within Trade Compliance…
- Risk Assessment Applications
  - [Questionnaire](https://trade-compliance.docs.developers.aeb.com/reference/questionnaire.md): Returns a URL that allows you to embed the questionnaire into another application.
  - [Questionnaire overview](https://trade-compliance.docs.developers.aeb.com/reference/searchquestionnaires.md): Returns an URL that allows you to embed the questionnaires overview into another application.
- Risk Assessment
  - [Questionnaire count](https://trade-compliance.docs.developers.aeb.com/reference/countquestionnaires.md): Returns the count of filtered questionnaires. If data-driven access rights are defined for the client’s questionnaires, they will be taken into account by this call.
  - [Questionnaire summary](https://trade-compliance.docs.developers.aeb.com/reference/getquestionnairesummary.md): Returns a summary of the most recent valid questionnaire(s) for the specified parameters. If data-driven access rights are defined for the client’s questionnaires, they will be ignored by this call.…
  - [Invalidate questionnaires](https://trade-compliance.docs.developers.aeb.com/reference/invalidatequestionnaires.md): Invalidates all questionnaires for the specified parameters. If data-driven access rights are defined for the client’s questionnaires, they will be ignored by this call. It is assumed that this…
- WorkstationServiceAgent
  - [/wssagent/connect](https://trade-compliance.docs.developers.aeb.com/reference/connect.md): Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
  - [/wssagent/connect](https://trade-compliance.docs.developers.aeb.com/reference/disconnect0.md): Ends existing workstation agent. Noop if there is no agent for the id.
  - [/wssagent/status](https://trade-compliance.docs.developers.aeb.com/reference/status.md): Returns response object with information about given workstation service agent.
  - [/wssagent/connection/{id}](https://trade-compliance.docs.developers.aeb.com/reference/status0.md): Returns response object with information about given workstation service agent.
  - [/wssagent/connection/{id}](https://trade-compliance.docs.developers.aeb.com/reference/connect0.md): Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
  - [/wssagent/connection/{id}](https://trade-compliance.docs.developers.aeb.com/reference/disconnect1.md): Ends existing workstation agent. Noop if there is no agent for the id.
- GenericAFBean
  - [/GenericAFBean/getGenericApplicationFacadeInfo](https://trade-compliance.docs.developers.aeb.com/reference/getgenericapplicationfacadeinfo.md)
  - [/GenericAFBean/applications/{applicationName}](https://trade-compliance.docs.developers.aeb.com/reference/open.md)

## Changelog
- [Updated "Setting up Your Environment"](https://trade-compliance.docs.developers.aeb.com/changelog/updated-setting-up-your-environment.md)
- [Added API Method for statistic data in Compliance Screening](https://trade-compliance.docs.developers.aeb.com/changelog/add-api-method-for-statistic-data-in-compliance-screening.md)
- [Clarification on on threshold in screening](https://trade-compliance.docs.developers.aeb.com/changelog/clarification-on-on-threshold-in-screening.md)
- [Added more details about RA result status](https://trade-compliance.docs.developers.aeb.com/changelog/added-more-details-about-ra-result-status.md)
- [Updated API reference for new deleteTransaction API in EC](https://trade-compliance.docs.developers.aeb.com/changelog/updated-api-reference-for-new-deletetransaction-api-in-ec.md)
- [Fixed typo + Added information about goods attributes](https://trade-compliance.docs.developers.aeb.com/changelog/fixed-typo-added-information-about-goods-attributes.md)
- [Added description about indicating how an item is completely classified](https://trade-compliance.docs.developers.aeb.com/changelog/added-description-about-indicating-how-an-item-is-completely-classified.md)
- [Fixed typo](https://trade-compliance.docs.developers.aeb.com/changelog/fixed-typo.md)
- [Fixed wrong link](https://trade-compliance.docs.developers.aeb.com/changelog/fixed-wrong-link.md)
- [Clarified relation between questionnaires and check transactions](https://trade-compliance.docs.developers.aeb.com/changelog/clarified-relation-between-questionnaires-and-check-transactions.md)