Migrate Peppol registrations to or from eConnect: migration key, API endpoints and the process.
When an organisation switches Peppol provider, the SMP registrations need to be transferred. The Peppol migration protocol ensures this happens without downtime: senders can continue sending during the migration. The PSB offers two migration scenarios via the API.
If a party moves from eConnect to another Peppol Access Point provider, you prepare the migration via the prepareToMigrate endpoint:
GET /api/v1/peppol/{partyId}/prepareToMigrate
This endpoint does two things:
The API returns the migration key in the response. Pass this key to the new provider, who needs it to take over the registration in their SMP.
{
"migrationKey": "abc123-def456-ghi789"
}
After the migration, the party is automatically removed from the eConnect SMP.
If a party moves to eConnect from another Peppol Access Point provider, you need the migration key that the current provider has generated. Add this key to the party configuration via:
PUT /api/v1/peppol/config/party/{partyId}
With the migration object in the request body:
{
"migration": {
"key": "the-migration-key-from-the-current-provider"
}
}
The PSB completes the migration automatically: the SMP registration is taken over and the SML is updated. From that point on, all Peppol messages for this party are routed through the eConnect Access Point.
If the migration key is invalid or expired, the migration fails and the API returns an error message. In that case, request a new key from the current provider.
GET /api/v1/peppol/{partyId}/prepareToMigratePUT /api/v1/peppol/config/party/{partyId} with the migration keyThe Peppol migration protocol is designed for zero downtime. During the transfer, the party remains registered in the network. Senders who send an invoice at that moment will reach the party via the old or the new Access Point, depending on the timing of SML propagation. No messages are lost.
After a successful migration to eConnect, the party is reachable immediately, but SMP propagation across the Peppol network may take a few minutes. After the migration, always configure the capabilities and set up the required hooks.
Don't forget to set up user permissions and optionally a businessCard via the Enrollment API if that hasn't been done yet.
Need help with a migration? Contact TechSupport for guidance on the migration process.
Contact us about migration