Start inbound migration
Migrate a Peppol participant into Docnova using a migration key issued by the participant's current provider.
Endpoint
| Property | Value |
|---|---|
| URL | POST /peppol/migration/inbound/start |
| Method | POST |
| Auth | R-Auth: <partner-jwt> (the associated company must have a user with SUPER_OWNER admin authority) |
| Content-Type | application/json |
| Base URL | Stage Environment https://api-stage.docnova.ai/ Production Environment https://api.docnova.ai/ |
Country-specific hosts
During testing this was observed against a France-hosted company on https://api-fr-stage.docnova.ai/; the host may vary by the company's country deployment.
Example Request
curl --location '{{baseUrl}}/peppol/migration/inbound/start' \
--header 'Content-Type: application/json' \
--header 'R-Auth: {{partnerJwt}}' \
--data '{
"companyId": "0ddae57b-673a-45fa-ad1f-e7c52827b44a",
"icd": "0225",
"specialIdentifier": "",
"businessIdentifier": "271688503",
"migrationKey": "A8F5D2K9L7YHD56FVO0PAZ"
}'
Request body
{
"companyId": "string (UUID)",
"icd": "string",
"specialIdentifier": "string",
"businessIdentifier": "string",
"migrationKey": "string"
}
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
companyId | UUID | Yes | The Docnova company the participant will be registered under. |
icd | string | Yes | The Peppol identifier scheme (ICD) for the participant, e.g. 0225 for the French SIRENE registry. See Common ICD codes. |
specialIdentifier | string | No | An optional prefix combined with businessIdentifier to form the full identifier value (used for sub-entity/suffix addressing). Leave empty for the base identifier. |
businessIdentifier | string | Yes | The business identifier value under the given icd (e.g. the SIREN). |
migrationKey | string | Yes | The migration key issued by the participant's current Peppol provider. Obtained from that provider, not from Docnova. |
The full Peppol participant ID is composed internally as iso6523-actorid-upis::{icd}:{specialIdentifier}{businessIdentifier}.
Response
200 OK
success
Response fields
Plain text body; no structured fields. A 200 response with body success confirms Docnova has submitted the inbound migration record to its SMP and has begun the participant's document setup.
Error Codes
| HTTP Status | Error | Description |
|---|---|---|
400 | Validation error | A required field is missing or malformed. |
401 / 403 | Unauthorized | Missing/invalid R-Auth token, or the associated user lacks SUPER_OWNER admin authority. |
500 | PEPPOL_PARTICIPANT_MIGRATION_FAILED | "Peppol participant migration failed! Error: %s" — the SMP rejected the migration key, or the key is invalid, expired, or does not match the participant ID. |
Related
- Submit register request — for registering a new participant that has no existing Peppol registration to migrate from.
- Start outbound migration — the reverse flow: generating a migration key for a participant leaving Docnova for another provider.