Company Identifiers

Migrate Company Identifier to Recommand

Move an identifier that another Peppol provider currently publishes for receiving over to Recommand, using the migration key that provider issued.

Move an identifier that another Peppol provider currently publishes for receiving over to Recommand, using the migration key that provider issued. Recipient registration is exclusive on the Peppol network; without a key the previous registration has to be removed first and the company is unreachable in between. With the key, the network switches the identifier to Recommand in one step.

When the company is publishable right now, the migration runs immediately and the response has status completed. When it is not yet, for example because the company's identity check is still open, the key is stored with status pending and used the moment the company is registered. Submitting a new key replaces a pending one. Only companies published through Recommand's own SMP can be migrated this way.

POST
/api/v1/companies/{companyId}/identifiers/{identifierId}/migration
AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

companyId*string

The ID of the company the identifier belongs to

identifierId*string

The ID of the identifier to migrate to Recommand

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://app.recommand.eu/api/v1/companies/string/identifiers/string/migration" \  -H "Content-Type: application/json" \  -d '{    "migrationKey": "Ab12$#xyZ9!kLm"  }'
{
  "success": true,
  "migration": {
    "id": "pm_01JQZ8X0M4T7RB6K9V2NDHW3PA",
    "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA",
    "scheme": "0208",
    "identifier": "1012081766",
    "direction": "inbound",
    "status": "pending",
    "migrationKey": "string",
    "errorMessage": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}