Skip to main content
Version: 1.0.0

The operator business entity object

Operator business entity

An Operator business entity refers to any business entity associated with your account.

By default, your account is not associated with any business entities. This set of API allow you to claim, search, create or delete your business entities.

You can find more explanation below:

  • Claim: Learn how to claim existing business entities.
  • Search: Discover how to search for business entities.
  • Register/Unregister: Understand how to register/unregister a business entities.
  • Create: Find out how to create new business entities.
Endpoints
GET/v1/config/business/entity
GET/v1/config/business/entity/{businessEntityId}
POST/v1/config/business/entity/legalunit
POST/v1/config/business/entity/office
POST/v1/config/business/entity/{businessEntityId}/claim
POST/v1/config/business/entity/scheme/{identifierScheme}/value/{identifierValue}/claim
POST/v1/config/business/entity/{businessEntityId}/identifier
DELETE/v1/config/business/entity/identifier/{businessEntityIdentifierId}
POST/v1/config/business/entity/identifier/{businessEntityIdentifierId}/network/{networkIdentifier}
DELETE/v1/config/business/entity/identifier/{businessEntityIdentifierId}/network/{networkIdentifier}
POST/v1/config/business/entity/identifier/scheme/{identifierScheme}/value/{identifierValue}/network/{networkIdentifier}
POST/v1/config/business/entity/batch
Attributes
businessEntityIdstring (uuid) - Optional
namestring - Optional
countryenum - Optional


identifierSchemestring - Optional
identifierValuestring - Optional
postalAddressobject - Optional

operatorRelationobject - Optional

identifiersarray - Optional



Object
{
  "businessEntityId": "0193eee7-4572-770f-a712-12db83c8e6c7",
  "name": "HELIO PROJETS",
  "type": "LEGAL_UNIT",
  "scope": "PRIVATE_TAX_PAYER",
  "country": "FR",
  "identifierScheme": "0002",
  "identifierValue": "007350101",
  "identifiers": [
    {
      "businessEntityIdentifierId": "0193eee7-4572-770f-a712-14973801d52a",
      "type": "LEGAL_IDENTIFIER",
      "scheme": "0002",
      "value": "007350101",
      "networkRegistered": [
        {
          "directoryId": "0193eee7-4572-770f-a712-18b4d83249d9",
          "directoryAddress": "0225:007350101",
          "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
          "networkIdentifier": "DOMESTIC_FR"
        }
      ]
    }
  ]
}
{
  "businessEntityId": "0193eee7-4572-770f-a712-21d4b86d9759",
  "name": "HELIO PROJETS",
  "type": "OFFICE",
  "scope": "PRIMARY",
  "country": "FR",
  "identifierScheme": "0009",
  "identifierValue": "00735010100031",
  "postalAddress": {
    "city": "city_1",
    "postalCode": "34000",
    "addressLine1": "addr1_1",
    "addressLine2": "addr2_1"
  },
  "identifiers": [
    {
      "businessEntityIdentifierId": "0193eee7-4572-770f-a712-26b80d86a8cc",
      "type": "OFFICE_IDENTIFIER",
      "scheme": "0009",
      "value": "00735010100031",
      "networkRegistered": [
        {
          "directoryId": "0193eee7-4572-770f-a712-2881efd39d62",
          "directoryAddress": "0225:007350101_00735010100031",
          "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
          "networkIdentifier": "DOMESTIC_FR"
        }
      ]
    },
    {
      "businessEntityIdentifierId": "0193eee7-4585-7110-a1e8-cb963cda096d",
      "type": "ROUTING_CODE",
      "scheme": "0224",
      "value": "RC_00735010100031"
    }
  ]
}

Information
The properties schemeIdentifier and schemeValue appear both at the root of the JSON structure AND within the identifiers array.

Root-Level schemeIdentifier and schemeValue: They represent the primary or default identifier for quick reference and compatibility with systems expecting a flat structure. They are duplicates of a specific identifier from the identifiers array, flagged as either LEGAL_IDENTIFIER or OFFICE_IDENTIFIER.

identifiers Array: This array contains all the identifiers associated with the entity, including the one duplicated at the root level. It supports multiple identifier types for broader compatibility and detailed entity representation.

claim​

This feature allows you to register in Iopole system that a particular company, identified by its unique ID, is managed by you. By using it, you link the company to your account, showing that you are responsible for managing it. It is a mandatory step for both the business entities that will receive invoices and those that will send invoices.

This feature helps you locate the companies you've previously claimed as your own. There are two options available: one allows you to search by the company's unique identifier, while the other uses a custom search filter.

register​

This feature is crucial for receiving documents for claimed companies. For French companies, it updates the government directory. For companies in other countries, it updates the Peppol network.

create​

This feature is not applicable to companies registered in France, as they are established by the French government.

For companies in other countries, you must use this feature to declare the company within the Peppol network.