Submit report through API Gateway

Access to the goAML API via the Government API Gateway

To facilitate the automated submission of reports to goAML, authorized organizations may access the goAML API via the government API Gateway within a secure and standardized framework.

This information is intended for technical representatives of private‑sector entities who are responsible for managing API access on behalf of their organization.

 

Eligibility and Roles

Organizations wishing to use the goAML API must designate technical representatives, including at least one Application Manager, who will be responsible for managing API access on behalf of the organization.

For operational continuity, it is recommended to:

  • Designate more than one Application Manager
  • Identify a backup technical contact

All roles remain under the responsibility of the API Consumer organization.

 

Onboarding Process (High‑Level)

Access to the API Gateway requires a formal onboarding process coordinated by the competent government services.

At a high level, onboarding includes:

  1. Submission of an onboarding request form
  2. Identification of technical and main contacts
  3. Validation of the organization’s registration details
  4. Approval of access to the requested APIs

For legal and security reasons, identity verification and formal authorization are required as part of this process. Specific administrative and documentary requirements are communicated directly during onboarding.

 

Application Registration and API Access

Once organizational onboarding has been completed:

  • Designated Application Managers complete the registration process via the API Gateway Portal
  • An application is created to consume the authorized APIs
  • Authentication credentials are generated and managed by the API Consumer

These credentials are required before initiating any API interactions with goAML.

Important:
Credentials are managed exclusively by the API Consumer.
The publishing administration can grant or revoke access to the API but does not manage consumer credentials.

 

Environments

The API Gateway provides separate environments to support testing and live operation.

Typically, these include:

  • A non‑production environment for testing and integration
  • A production environment for operational use

Access to the associated portals requires strong electronic authentication in accordance with Luxembourg government standards.

Specific environment URLs and technical connection details are provided to authorized users through official channels.

 

API Gateway Portal

The API Gateway Portal is the primary interface used by Application Managers to:

  • Access the API Catalog
  • Review available API documentation
  • Manage applications and API subscriptions

Only users whose identities and contact details were validated during onboarding are able to access the portal.

 

API Catalog

The API Catalog lists the APIs that have been explicitly made available to a given organization.

For each authorized API, the catalog allows users to:

  • Review functional documentation
  • Understand supported operations and data flows
  • Perform limited tests in applicable environments

Detailed technical specifications are accessible only after successful authentication.

 

Application Management

To consume an API, an Application Manager must create an application within the portal and associate it with the authorized APIs.

As part of this process:

  • Authentication material is generated for the application
  • Access permissions are bound to the approved scope

If credentials need to be rotated or replaced, a new application may be required, in accordance with platform security rules.

 

Support and Documentation

Additional guidance, forms, and procedural documentation are available through the API Gateway Portal Help Center, which is accessible to authenticated users.

For any additional information, please use the official contact channels indicated in the portal.

Last update