API Reference
Complete reference for all Bizzlink API endpoints.
All endpoints below are under the base URL https://gateway.vigasoft.lu/bizzlink.
Endpoint Overview
Partner Legal Entities
Manage legal entities on child tenants (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/tenants/{tenantId}/legal-entities | List legal entities on child tenant |
| POST | /bizzlink/tenants/{tenantId}/legal-entities | Create legal entity on child tenant |
| PATCH | /bizzlink/tenants/{tenantId}/legal-entities/{leId} | Update legal entity on child tenant |
Partner Peppol IDs
Manage Peppol IDs on legal entities (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/tenants/{tenantId}/legal-entities/{leId}/peppol-ids | List Peppol IDs on legal entity |
| POST | /bizzlink/tenants/{tenantId}/legal-entities/{leId}/peppol-ids | Create Peppol ID on legal entity |
| DELETE | /bizzlink/tenants/{tenantId}/legal-entities/{leId}/peppol-ids/{peppolIdId} | Delete Peppol ID |
| POST | /bizzlink/tenants/{tenantId}/legal-entities/{leId}/peppol-ids/{peppolIdId}/deregister | Deregister Peppol ID from the SMP |
| POST | /bizzlink/tenants/{tenantId}/legal-entities/{leId}/peppol-ids/{peppolIdId}/register | Register Peppol ID at the SMP |
Validation
PEPPOL BIS 3.0 Schematron validation
| Method | Endpoint | Description |
|---|---|---|
| POST | /bizzlink/document/validate | Validate UBL XML |
Lookup
Look up Peppol participants (ERP integration helpers)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/lookup/peppol/participant/{endpointId} | Look up a Peppol participant |
Webhooks
Configure webhook notifications for document events
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/webhooks | List all webhook configurations visible to the caller in the caller's environment (own tenant + sub-tenants if caller is a PARTNER) |
| POST | /bizzlink/webhooks | Create a webhook configuration. Scope (tenant/legal-entity/partner) is set via meta.scope. PARTNER callers may target sub-tenants via tenant.value=<sub-tenant-uuid> or by referencing a sub-tenant's Peppol ID. |
| DELETE | /bizzlink/webhooks/{id} | Delete a webhook configuration |
| GET | /bizzlink/webhooks/{id} | Get a specific webhook configuration (own tenant or sub-tenant if caller is PARTNER) |
| PATCH | /bizzlink/webhooks/{id} | Update a webhook configuration. Scope is immutable — only attributes can be patched. |
| POST | /bizzlink/webhooks/{id}/actions/rotate-secret | Rotate the webhook signing secret |
| POST | /bizzlink/webhooks/{id}/actions/test | Send a test webhook |
Document
Create, convert and send documents via the Peppol network
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/documents | List all renditions sharing a processId (sibling lookup) |
| POST | /bizzlink/documents/json | Send a document from a JSON structure |
| POST | /bizzlink/documents/xml | Send a document from an XML file |
| GET | /bizzlink/documents/{documentId}/status | Get document processing status |
Ping
Health check and authentication probe.
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/ping | /bizzlink/ping |
Partner Tenants
Create and manage child tenants (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/tenants | List child tenants |
| POST | /bizzlink/tenants | Create a child tenant |
| GET | /bizzlink/tenants/{id} | Get child tenant details |
| PATCH | /bizzlink/tenants/{id} | Update child tenant |
Email Templates
Manage email templates for document notifications
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/email-templates | List all email templates visible to the tenant |
| POST | /bizzlink/email-templates | Create an email template |
| DELETE | /bizzlink/email-templates/{id} | Delete an email template |
| GET | /bizzlink/email-templates/{id} | Get a specific email template |
| PATCH | /bizzlink/email-templates/{id} | Update an email template |
Notification Emails
Configure email notifications for inbound documents
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/notification-emails | List all notification email configurations for the tenant |
| POST | /bizzlink/notification-emails | Create a notification email configuration |
| DELETE | /bizzlink/notification-emails/{id} | Delete a notification email configuration |
| GET | /bizzlink/notification-emails/{id} | Get a specific notification email configuration |
| PATCH | /bizzlink/notification-emails/{id} | Update a notification email configuration |
Document
Create, convert and send documents via the Peppol network.
Conversion
Convert between ZUGFeRD/CII and UBL 2.1 without sending.
Validation
Validate UBL XML against PEPPOL BIS 3.0 Schematron rules.
Webhooks
Configure webhook notifications for document status changes.
Email Templates
Manage email notification templates for document delivery.
Lookup
Look up Peppol participants on the SML/SMP for ERP integration.
Partner Tenants
Create and manage child tenants (Partner API only).
Partner Legal Entities
Manage legal entities on child tenants (Partner API only).
Partner Peppol IDs
Manage Peppol IDs on legal entities (Partner API only).