Search by id

Information

---

Use this endpoint to search for your business entity by its unique identifier.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

GET/v1/config/business/entity/{businessEntityId}

---

Path parameters

---

businessEntityIdstring (uuid) - Required

---

Request

---

GET /v1/config/business/entity/:businessEntityId

bash

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/config/business/entity/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${TOKEN}'

javascript

    const got = require('got');
    const url = 'https://api.ppd.iopole.fr//v1/config/business/entity/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8';
    const token = 'your_token_here';
    (async () => {
        try {
        const response = await got(url, {
            headers: {
                    accept: 'application/json',
                    Authorization: `Bearer ${token}`,
            },
                responseType: 'json',
            });
         console.log(response.body);
        } catch (error) {
            console.error('Error:', error.message);
        }
    })();

.NET

    using System;
    using System.Net.Http;
    using System.Net.Http.Headers;
    using System.Threading.Tasks;
    class Program
    {
        static async Task Main(string[] args)
        {
        string url = "https://api.ppd.iopole.fr//v1/config/business/entity/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8";
        string token = "your_token_here";
        using HttpClient client = new HttpClient();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
        try
        {
            HttpResponseMessage response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine("Error: {e.Message}");
        }
    }
    }

Response

---

Status: 200 - application/json

Description: Retrieve list of business entity matching given criteria

Schema:

• businessEntityId: string
  Unique identifier for the business entity.
• name: string
  Name of the business entity.
• country: enum
  
• type: enum
  The type of the business entity
• scope: enum
  Scope of the office or legal unit business entity.
• identifierScheme: string
  The EAS code (Endpoint Address Scheme) identifies the type of identifier used for parties in electronic invoicing
• identifierValue: string
  The value of the electronic address.
• postalAddress: object
  
• operatorRelation: object
  
• identifiers: array
  List of business entity identifiers.

Examples:

{
  "businessEntityId": "01944583-ae33-7285-b62d-91737a7dcf56",
  "name": "HELIO PROJETS",
  "type": "LEGAL_UNIT",
  "scope": "PRIVATE_TAX_PAYER",
  "country": "FR",
  "identifierScheme": "0002",
  "identifierValue": "007350101",
  "countryIdentifier": {
    "siren": "007350101",
    "siret": "007350101"
  },
  "identifiers": [
    {
      "businessEntityIdentifierId": "01944583-ae40-770c-bd8c-7f7f801a18b0",
      "type": "LEGAL_IDENTIFIER",
      "scheme": "0002",
      "value": "007350101"
    }
  ]
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.

Status: 404

Description: Business entity not found for given criteria

---