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 of your customers (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/customers/{customerId}/legal-entities | List legal entities of a customer |
| POST | /bizzlink/customers/{customerId}/legal-entities | Create legal entity on a customer |
| PATCH | /bizzlink/customers/{customerId}/legal-entities/{leId} | Update legal entity of a customer |
Partner Peppol IDs
Manage Peppol IDs on legal entities (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/customers/{customerId}/legal-entities/{leId}/peppol-ids | List Peppol IDs on legal entity |
| POST | /bizzlink/customers/{customerId}/legal-entities/{leId}/peppol-ids | Create Peppol ID on legal entity |
| DELETE | /bizzlink/customers/{customerId}/legal-entities/{leId}/peppol-ids/{peppolIdId} | Delete Peppol ID |
| POST | /bizzlink/customers/{customerId}/legal-entities/{leId}/peppol-ids/{peppolIdId}/deregister | Deregister Peppol ID from the SMP |
| POST | /bizzlink/customers/{customerId}/legal-entities/{leId}/peppol-ids/{peppolIdId}/register | Register Peppol ID at the SMP |
Partner Customers
Create and manage your customers — each customer is a child tenant of the partner (Partner API only)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/customers | List customers |
| POST | /bizzlink/customers | Create a customer |
| DELETE | /bizzlink/customers/{id} | Delete customer (sandbox only) |
| GET | /bizzlink/customers/{id} | Get customer details |
| PATCH | /bizzlink/customers/{id} | Update customer |
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 (your account + your customers if caller is a PARTNER) |
| POST | /bizzlink/webhooks | Create a webhook configuration. Scope (tenant = your account, legal-entity, partner) is set via meta.scope. PARTNER callers may target one of their customers via scope type tenant with value=<customer-id> or by referencing the customer's Peppol ID. |
| DELETE | /bizzlink/webhooks/{id} | Delete a webhook configuration |
| GET | /bizzlink/webhooks/{id} | Get a specific webhook configuration (your account or one of your customers 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 documents |
| 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} | Download document as UBL XML or PDF |
| GET | /bizzlink/documents/{documentId}/status | Get document processing status |
Ping
Health check and authentication probe.
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/ping | /bizzlink/ping |
Document Forwarding
Forward every inbound/outbound document to a target (e.g. your accountant)
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/document-forwarding | List all forwarding rules visible to the caller in the caller's environment (your account + your customers if caller is a PARTNER) |
| POST | /bizzlink/document-forwarding | Create a forwarding rule. An account can have several rules. PARTNER callers may target one of their customers via meta.scope type tenant with value=<customer-id>. |
| DELETE | /bizzlink/document-forwarding/{id} | Delete a forwarding rule |
| GET | /bizzlink/document-forwarding/{id} | Get a specific forwarding rule (your account or one of your customers if caller is PARTNER) |
| PATCH | /bizzlink/document-forwarding/{id} | Update a forwarding rule |
Email Templates
Manage email templates for document notifications
| Method | Endpoint | Description |
|---|---|---|
| GET | /bizzlink/email-templates | List all email templates visible to your account |
| 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 |
Document
Create, convert and send documents via the Peppol network.
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).