Welcome
Login
Open navigation

How do API multi-keys work when acquiring a data offering accessible via API Pull, in OpenAPI?

Key generation and deletion are associated with the acquirer role.

API multi-keys enable acquirers to consume data acquired by OpenApi, while reinforcing the security of data access.

Generation of multiple API keys in acquisition

One key is required per transaction and per acquirer, and can be generated for each person or entity that will need to consume the API. You can name your API keys.

The acquirer is invited to copy and save the API keys generated, as they will no longer be displayed. A message is displayed in the participant portal to indicate this.

Use case

  • I want to give access to the data to another member of my organization: I will create an API key and name it clearly, for example with the first and last name of the member of my organization who will use this API key.

  • I want to give access to the data to an external person acting as a subcontractor on a temporary basis: I will create an API key and name it clearly, for example with the name of the external organization that will use this API key.


When a data offering expires, the participant can reacquire the same data offering, using the same API key.

Deletion of multiple API keys in the acquisition

A key can be deleted at any time to enhance security. To do so, the data acquirer has to go to the relevant acquisition and delete the desired key.

Export acquired data

There are two ways to export acquired data: 

  • OpenApi via a cloud connector: a cloud connector must be associated with the acquisition in question. The data acquirers must select the OpenAPI OAS specification standard to be transferred to the cloud connector. They can then send an existing key or generate a new one.

  • OpenAPI export: the data acquirers can download the API specifications in OpenAPI format (version 2.0 or 3.0).

  • If the data acquirer exports its data via a cloud connector, new exports will be generated automatically when the data provider performs an update.

  • If the data acquirer exports his data in OpenAPI format, he will have to manually redo the exports as soon as the data provider performs an update.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.