Welcome to the Scribee API

As of September 1, 2026, every company subject to VAT in France must be able to receive e-invoices, and large companies as well as mid-size companies must issue them; as of September 1, 2027, the obligation to issue extends to all companies. If your software creates, receives, or manages invoices for these companies, it must connect to the national system. Scribee is a Plateforme Agréée (French approved e-invoicing platform) for the e-invoicing reform. Your system connects to a REST API that creates, checks, and formats your e-invoices, tracks their lifecycle statuses, and gathers your e-reporting data. This page lets you check that the coverage matches your need, then get access.

What Scribee does for you

• Format conversion: you create an invoice in structured JSON or upload an existing file (UBL 2.1, CII EN16931, Factur-X - PDF with embedded XML); each invoice can then be downloaded in pdf, ubl, cii, or facturx format.
• Factur-X compliance: Scribee generates the PDF/A-3 with the embedded CII XML. When you supply your own PDF, the compliance of the resulting file is checked and the result is exposed on the invoice (facturx_conformance: pending, compliant, non_compliant); on an invoice generated by Scribee, that field is null.
• AIFE lifecycle (Agence pour l'informatique financière de l'État): regulatory statuses are tracked on your sales invoices as well as your purchase invoices - 200 deposited, 202 received, 205 approved, 210 refused, 213 rejected, 220 cancelled. You declare the transitions open to a partner through the API, Scribee checks that they are allowed from the current state, and the event history carries each event's date, status, and reason. The states the platform writes itself - 202 received, 213 rejected, 220 cancelled - are reported to you, not declared by you: Invoice lifecycle has the exact list.
• Document origin: every invoice carries the channel through which it entered the workspace (upload_source).
• E-reporting: you record the transactions, payments, and invoices outside mandatory e-invoicing - B2C sales, cross-border B2B transactions - in ten-day, monthly, or bimonthly periods, depending on the company's VAT regime.
• Notifications: webhooks push the creation of an invoice and its lifecycle status changes to your system, with request signing and secret rotation.

The path of an invoice

Your system talks only to Scribee. The API does not transmit documents on the regulatory network: it creates them, checks them, formats them, and records the statuses you declare. No call in the /api/v1/** API sends an invoice out to the public invoicing portal or to Peppol - that routing is driven from the Scribee interface. Sending through another channel does exist: POST /api/v1/invoices/{id}/send_by_email emails the invoice to the recipient you name. The PDF is always attached; the Factur-X only when the invoice already carries one.

Five functional domains

The guides and the API reference follow the same breakdown into five domains. All endpoints are under /api/v1/.

Domain	What it covers
Invoicing	Sales and purchase invoices compliant with EN16931, quotes and their conversion to invoices, reconciled payments, supporting documents attached to outbound Factur-X. Entry point: Invoices.
E-reporting	Periodic reports and their transactions, payments, and invoices. Entry point: E-reportings.
Directory	Customers, suppliers, your companies (SIREN, SIRET, VAT) and their establishments, update invitations sent to your third parties, and the national directory of electronic addresses. Entry point: Directory search.
Compliance	The mandate that authorizes Scribee to issue and receive on behalf of a company, its electronic signature workflow, and its KYC documents (Kbis extract, proof of identity, proof of signing authority). Entry point: Mandates.
Platform	Workspaces, members, categories, webhooks, and the availability endpoint GET /api/v1/health. Entry point: Workspaces.

The accounting module is managed from the Scribee interface and is not exposed in the API.

API access

The API is served at https://app.scribee.tech. Authentication is OAuth 2.0 with client credentials: an access token obtained from POST /oauth/token grants access to the workspaces granted to your application. GET /api/v1/workspaces is the first call: endpoints that list or create resources are nested under a workspace, while those that operate on an already-identified resource reference it directly by its id.

Two scope sets are commonly granted: read for read-only access, read write to read and write. Reads require read and writes require write, a deletion accepting destroy or write; exactly what the server verifies is in Authentication.

Three facts shape the integration:

• Access is granted, not self-service. A Scribee administrator validates your request, creates the OAuth client, and sends you the client_id and client_secret. There is no signup form or developer console; a secret rotation is requested from the same team.
• You integrate against production. There is no test environment: your calls operate on your production account. Some calls send a real email to a third party - sending an invoice or a quote, sending an update invitation to a customer or supplier, starting a mandate signature. Every write guide states this before the first code block. The draft state of invoices and quotes lets you build a document without triggering any of those sends.
• The API is versioned as a whole. Every resource lives under /api/v1/; a breaking change would ship under /api/v2/, never as a modification of v1.

The conventions common to all endpoints (pagination, sorting, error formats) are grouped in API conventions.

Become a partner

The starting point is a conversation with the Scribee team: present your use case (direction of flows, volumes, software you are connecting) and request API access. A Scribee administrator then creates your OAuth client with the scopes matching your use, and sends you your credentials. The same team supports you afterward: scope changes, secret rotation, and integration questions go through them.

Your integration path

1. Authentication: get an access token with your OAuth credentials.
2. Your first call: list your workspaces and check your access scope.
3. Companies and establishments: register the legal entities (SIREN, SIRET) you invoice for.
4. Electronic invoicing mandates: get the mandate signed that authorizes Scribee to act for each company.
5. The national directory: publish the electronic addresses of your companies and look up those of your recipients.
6. Issue a sales invoice: create the invoice, deposit it, and track its statuses from deposited to collected.