VertiCer API for Traders (beta)

The VertiCer API allows you to carry out key trading activities directly from your own software. This reduces manual work and enables you to automate processes more efficiently.

On this page, you will find the key information and a step-by-step guide on how to use our API.

What can you do with the API?

1. Retrieve all valid GO's within your account, including their properties.

2. Carry out transactions:
a) Transfer: transfer of GO's within the Netherlands to another trader.
b) Export: transfer of GO's to a trader within a connected AIB register.
c) Redeem: redeeming GO’s for:

* an energy supplier;
* an end user;
* conversion to hydrogen GO’s via an electrolyser.

3. Retrieve the status of transactions to:
* check whether transactions have been successfully processed;
* link transactions to VertiCer invoices.

What is not available via the API?

The following functionalities are currently available exclusively within the trading portal:

  • Processing withdrawal requests.
  • Creating, amending or deleting collections.
  • Allocating GO’s to collections.

This allows you to retain maximum freedom to organise your own portfolio management within your software environment.

Step 1: Acceptance of the API terms and conditions

To gain access to the API documentation and the beta environment, we ask that you first agree to VertiCer’s supplementary terms and conditions (API Terms).

These terms can be found under ‘Documents’ further down this page.

📧 Please send your consent, including the API Terms attached, to: [email protected].

Step 2: Obtain your API key

Once we have received your approval, you will receive an API key to access the beta environment.

On this page, you will find additional API documentation to help your developers get started with integrating the API into your own software.

Step 3: Support during testing

Any questions regarding the API or test results can be sent to:

📧 [email protected]

Please use the prescribed support template from the enquiry form. Only requests submitted in this format can be processed.

VertiCer aims to respond within a maximum of 8 working days.

Step 4: Ready for production

Once the integration has been successfully tested, you can report this via:

📧 [email protected]

The beta environment contains fictitious test data and does not affect your actual GO stock or transactions in the trading portal.

All traders test on this environment, and VertiCer will regularly refresh the data in this environment to ensure consistency in testing.

The test transactions are completely separate from the production environment.

Step 5: Production environment and API key

Using the API in production

The API is currently only available in the beta environment.

When the API becomes available in the production environment, VertiCer will inform you via a newsletter. At that point, a few additional steps will be required.

Adapting your integration for production

Two things will change for use in the production environment:

  1. You will use a unique API key for your organisation.
  2. The API endpoint will change.

VertiCer will publish an updated YAML file for the new API endpoint.

Unique API key for your organisation

An authorised user from your organisation can retrieve this API key via the trading portal.

PLEASE NOTE: The API key is only displayed in full once. You should therefore store it immediately in a secure location. Even VertiCer does not have access to this key and cannot reissue it.

The user can also:

  • activate or deactivate the API;
  • set an automatic rotation period;
  • request a new API key themselves at any time (rotation).

Secure management of your API key

Your API key grants full access to carry out transactions on behalf of your organisation.

Important: it is therefore your responsibility to ensure that:

  • the key remains confidential;
  • only authorised systems have access to the key;
  • the key is stored securely.

If misuse or a leak is suspected, the key can be rotated immediately via the trading portal.

As the confidentiality of API keys is essential, VertiCer staff cannot view these keys. Only a user within your organisation can view the key once.

Using the new API endpoint and your unique API key, your developers can deploy the already-tested integration to production and connect it to the VertiCer trading portal.

Documents

API Terms of Use 

API Technical Documentation (YAML file)

Maintenance and future changes

The VertiCer API is under continuous development. New legislation, amendments to the AIB standard or changes to the trading portal may necessitate updates to API versions.

When a new version becomes available:

  • it will first be made available in the beta environment;
  • we will inform you of the changes in good time;
  • we will let you know when this version goes live.

Currently, older API versions may no longer be supported following the introduction of a new version.

Naturally, the trading portal will remain available as an alternative for users who continue to work via the screen.

Keep ongoing costs in mind

Using the API is not just a one-off investment. You should also keep in mind future changes and enhancements; these may incur costs to ensure you can continue to make the most of all the features.

These include:

  • changes to the VertiCer API;
  • changes to AIB standards;
  • maintenance of your own software;
  • any adjustments to existing integrations.

This ensures your integration remains secure, stable and compatible with future developments.

Do you have any questions or comments about the API?

Please get in touch via [email protected]. VertiCer checks this email address every week.

Please use the enquiry form below where possible, so that we can assess your enquiry more effectively.

Enquiry form beta API VertiCer

Do you have any questions about the API registration process?

Please contact our Servicedesk.

Contact our Servicedesk