Skip to content
/Companies

Companies

Entity representing a Company.

Operations

Create a Company

Request

Create a Company based on the provided details.

Security
api_key
Bodyapplication/jsonrequired
identificationNumberstring

Identification number of the company, if provided must be valid

namestringrequired

Name of the company

headAddressobject(PhysicalAddressDto)required

Head office address of the company

emailAddressstring, (email)

Email address of the company

phoneNumberstring

Phone number of the company

isActivebooleanrequired

Indicates if the company is active

identifiersArray of objects(CompanyIdentifierDto)required

List of identifiers associated with the company

curl -i -X POST \
  https://doc.connect.easypost.eu/_mock/public-api/openapi/companies \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "identificationNumber": "string",
    "name": "string",
    "headAddress": {
      "street": "string",
      "streetNr": "string",
      "postalCode": "string",
      "box": "string",
      "city": "string",
      "countryCode": "string",
      "addressAdditionalLine": "string"
    },
    "emailAddress": "user@example.com",
    "phoneNumber": "string",
    "isActive": true,
    "identifiers": [
      {
        "type": "ENTERPRISE_NUMBER",
        "value": "string"
      }
    ]
  }'

Responses

Bodyapplication/json
erpIdstringrequired

ERP identifier of the company

identificationNumberstring

Identification number of the company

namestringrequired

Name of the company

headAddressobject(PhysicalAddressDto)required

Head office address of the company

emailAddressstring, (email)

Email address of the company

phoneNumberstring

Phone number of the company

isActivebooleanrequired

Indicates if the company is active

idstringrequired

Unique identifier of the company

createdAtstringrequired

Creation date of the company

lastModifiedAtstringrequired

Last modification date of the company

lastModifiedBystringrequired

Last modified by information

identifiersArray of objects(CompanyIdentifierDto)required

List of identifiers associated with the company

isTechnologyPartnerboolean

Indicates if the company is a technology partner

Response
{
  "erpId": "string",
  "identificationNumber": "string",
  "name": "string",
  "headAddress": {
    "street": "string",
    "streetNr": "string",
    "postalCode": "string",
    "box": "string",
    "city": "string",
    "countryCode": "string",
    "addressAdditionalLine": "string"
  },
  "emailAddress": "user@example.com",
  "phoneNumber": "string",
  "isActive": true,
  "id": "string",
  "createdAt": "string",
  "lastModifiedAt": "string",
  "lastModifiedBy": "string",
  "identifiers": [
    { … }
  ],
  "isTechnologyPartner": true
}