Companies

Create Company

Create a business profile for sending or receiving Peppol documents.

POST
/api/v1/companies

Create a business profile for sending or receiving Peppol documents. Unless skipDefaultCompanySetup is set, the company is given the default Peppol identifiers and document types for its country. The response includes a verificationUrl: verification is required before exchanging documents. After verification, Recommand registers the company for receiving if isSmpRecipient is true (the default); false enables sending only. A company can be created while registered with another provider. When onboarding a company whose identifiers are registered elsewhere, we recommend submitting migration keys before completing verification to avoid registration conflicts, or having the previous provider deregister those identifiers first. Identifiers can also be migrated after verification. A company not yet registered on Peppol needs no migration keys.

Authorization

AuthorizationBasic <token>

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

In: header

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://example.com/api/v1/companies" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "address": "string",    "postalCode": "string",    "city": "string",    "country": "BE"  }'
{  "success": true,  "company": {    "id": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "name": "Recommand BV",    "address": "Kortrijksesteenweg 1092",    "postalCode": "9051",    "city": "Gent",    "country": "BE",    "enterpriseNumberScheme": "0208",    "enterpriseNumber": "1012081766",    "vatNumber": "BE1012081766",    "email": "billing@example.com",    "phone": "+32 9 396 20 39",    "isSmpRecipient": true,    "isVerified": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "verificationUrl": "string"}