Recipients

Search Directory

Run a free-text search against the Peppol Directory and get back the participants that match, with the document types each is registered to receive.

POST
/api/v1/search-peppol-directory

Run a free-text search against the Peppol Directory and get back the participants that match, with the document types each is registered to receive. Use it to find a recipient's Peppol address when you only know who they are, then pass that address to the verify recipient endpoint. The Peppol Directory only lists participants that publish a directory entry, so a recipient that is reachable on the network can still be missing here. Returns a 503 when the directory itself cannot be reached.

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

curl -X POST "https://example.com/api/v1/search-peppol-directory" \  -H "Content-Type: application/json" \  -d '{    "query": "Company Name"  }'
{  "success": true,  "results": [    {      "name": "Recommand BV",      "peppolAddress": "0208:1012081766",      "supportedDocumentTypes": [        "string"      ]    }  ]}