Search into Peppol

Information

---

This API is useful when you are looking for information about a company in all international network.

The response provided by the API is an array that includes all the directory entries matching the search criteria provided by the user.

This endpoint is synchronous

The role user is needed in order to use this endpoint

Endpoints

---

GET/v1/directory/international

---

Query parameters

---

value string - Required

• Anything like corporate name (like)
• Match siren (=)
• Match siret (=)
• Match address code (=)
• Match routing code (=)

offset integer - Optional - default 0
The number of records to skip before starting to return results. This is used to specify the starting point of the results to be fetched.

limit integer - Optional default 50
The maximum number of records to return.

Request

---

GET /v1/directory

bash

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/directory/fr/search?value=922304308&limit=50'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${token}'

javascript

    const got = require('got');
    const token = 'your_token_here';
    const value = '922304308';
    const limit = 50;
    
    (async () => {
    try {
        const response = await got(`https://api.ppd.iopole.fr//v1/directory?value=${value}&limit=${limit}`, {
        headers: {
            'accept': 'application/json',
            'Authorization': `Bearer ${token}`,
        },
        responseType: 'json',
        });
    
        console.log(response.body);
    } catch (error) {
        console.error(error.response.body);
    }
    })();

.NET

    using System;
    using System.Net.Http;
    using System.Threading.Tasks;
    
    class Program
    {
        static async Task Main(string[] args)
        {
            var token = "your_token_here";
            var value = "922304308";
            var limit = 50;
    
            using var client = new HttpClient();
            client.DefaultRequestHeaders.Add("accept", "application/json");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer ${token}");
    
            try
            {
                var response = await client.GetAsync(`https://api.ppd.iopole.fr//v1/directory?value={value}&limit={limit}`);
                response.EnsureSuccessStatusCode();
    
                var responseString = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseString);
            }
            catch (HttpRequestException ex)
            {
                Console.WriteLine("Request error: {ex.Message}");
            }
     }
   }

Response

---

Status: 200 - application/json

Description: Returns list of directory entries matching given criteria.

Schema:

• name: string
  
• country: enum
  
• electronicAddress: string
  
• entity: object
  

Examples:

[
  {
    "name": "Example Entity",
    "country": "FR",
    "electronicAddress": "0225:123456789",
    "entity": {
      "contacts": [
        {
          "name": "John Doe",
          "phone": "+123456789",
          "email": "john.doe@example.com"
        }
      ]
    }
  }
]

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.