Check a transaction in Export Controls.

post

https://rz3.aeb.de/test4ce/rest/ExportControl/v2/checkTransaction

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 created in Export Controls with the data of the transmitted transaction. This is necessary, for example, due to critical results in the export control check. Further export control checks for the corresponding transaction are done using the associated check transaction in Export Controls. Based on this, approvals for a transaction must be managed directly using the corresponding check transaction in Export Controls. The existing approvals for the associated check transaction are automatically taken into account during check of transaction from host system in Export Controls.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Represents a request to check a transaction in Export Controls.
clientIdentCode and clientSystemId are mandatory fields.
Client system ID "COMPLIANCE SERVER" is reserved for internal usage and therefore it is not allowed to use it as clientSystemId in a request.

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

transaction

object

required

Data of the checked transaction.

profileIdentCode

string

required

ID of the compliance profile to take settings for export control check from.

organisationUnitHost

string

length ≤ 255

Ident code of the organizational unit. May be null.

isAutoCreateClearings

boolean

Defaults to false

Defines that the transaction can be automatically approved, if an applicable license is found. If the transaction can be approved automatically, an approval is automatically created per jurisdiction and the transaction is no longer blocked.
An automatic approval of the transaction is only performed if exactly one suitable license is found with exactly one matching item for one transaction per jurisdiction. Furthermore, a transaction can be approved automatically only if there are no applicable general licenses from the AEB data service.

riskAssessmentParms

object

Parameters to integrate Risk Assessment functionality in the export control check.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200OK. The operation response. See response schema documentation for details.

400Bad request.

401Unauthorized. Missing or invalid authorization token.

405Method not allowed. Use POST.

406Not Acceptable. This resource produces application/json or application/xml.

415Unsupported Media Type. This resource accepts application/json or application/xml.

500Internal server error. See errorMessage for details.