Lookup

Look up Peppol participants on the SML/SMP for ERP integration.

Resolve a Peppol endpoint identifier against the SML and SMP — before queueing a document for a new recipient, check whether they are registered on PROD, TEST, or both networks, and which document types their SMP advertises. When the SMP publishes a Peppol Directory Business Card, the official company name and country code are returned as well.

Look up a Peppol participant

GET /bizzlink/lookup/peppol/participant/{endpointId}

Resolves a Peppol endpoint identifier against the SML (production AND test — the same participant ID can be registered on both networks) and queries each matching SMP for the accepted document types and, when published, the Peppol Directory Business Card (official name + country).

Typical ERP use case: before queueing a Peppol document for a new recipient, call this endpoint to confirm the recipient is registered on the network you care about (PROD vs TEST) and accepts the document type you are about to send.

The endpointId path parameter takes the colon-separated scheme:participant form, e.g. /api/v1/lookup/peppol/participant/9938:LU18635679. The response is a JSON:API resource envelope where data.id is the same endpointId and data.attributes carries the lookup result.

Responses:

StatusDescription
200Lookup result (always 200 — `attributes.registered=false` and an empty `attributes.environment` list mean the participant is on neither PROD nor TEST)
400Malformed endpoint identifier

Response BodyJsonApiDocumentParticipantLookupAttributes:

FieldTypeDescription
dataJsonApiResourceParticipantLookupAttributes
    attributesParticipantLookupAttributesResource-specific fields.
        countrystringISO 3166-1 alpha-2 country code from the Peppol Directory Business Card. `null` when no Business Card is available.
        documentTypesstring[]Distinct Peppol document type identifiers the participant accepts (union across PROD and TEST). Each entry is the full URL-decoded ID, e.g. `busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1`.
        environmentstring[]Which Peppol networks the participant is registered on. Possible entries: `PROD` (live network — SML `edelivery.tech.ec.europa.eu`), `TEST` (acceptance network — SML `acc.edelivery.tech.ec.europa.eu`). Empty when `registered=false`.
        namestringOfficial company name from the Peppol Directory Business Card (if the SMP publishes one). `null` when no Business Card is available.
        registeredbooleanWhether the participant is registered on at least one Peppol network (PROD or TEST).
    idstringUnique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
    typestringResource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).
cURL Request
curl -X GET https://gateway.vigasoft.lu/bizzlink/lookup/peppol/participant/{endpointId} \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE"
Response 200 OK
{
    "data": {
      "attributes": {
        "country": "LU",
        "documentTypes": ["string"],
        "environment": ["string"],
        "name": "VIGASOFT SARL-S",
        "registered": true
    },
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "type": "invoices"
  }
}