API

This page provides OpenAPI descriptions and downloadable schemas for the APIs used between the eFTI gate and a platform.

Note on API versions: Currently, we recommend implementing the V0 endpoints. The V1 endpoints are still under development and may change. We will provide guidance on migration to V1 once it is finalized.

Gate API for Platform

Data examples

Data example for endpoint PUT /v0/consignments/{datasetId}

Data example for error in endpoint PUT /v0/consignments/{datasetId}

Platform API for Gate

Data examples

Data example for endpoint GET /v0/consignments/{datasetId}

Data example for endpoint POST /v0/consignments/{datasetId}/follow-up

Platform Interoperability API for Platform

Schema files

Download all (.zip)