Company Identifiers

Create Company Identifier

Add a Peppol identifier the company can be addressed by.

POST
/api/v1/companies/{companyId}/identifiers

Add a Peppol identifier the company can be addressed by. When the company is registered as an SMP recipient, the identifier is registered in the SMP as well, which is what makes the address reachable on the network. A company created without skipDefaultCompanySetup already has the default identifiers for its country, so use this to add an extra address, for example a GLN alongside a national registration number.

Authorization

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 to create an identifier for

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/companies/string/identifiers" \  -H "Content-Type: application/json" \  -d '{    "scheme": "string",    "identifier": "string"  }'
{  "success": true,  "identifier": {    "id": "ci_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "scheme": "0208",    "identifier": "1012081766",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}