KYC & Annuaire (PPF directory)
How to get “API Key” from Portal?
To obtain the API key used with /auth/login, navigate to Settings → ERP Management → API Management in the Portal and use Generate. See also Authentication.
France — KYC & Annuaire (PPF directory)
The Annuaire is the French PPF (Portail Public de Facturation) company registry. Before sending or receiving invoices in France, companies must be registered and validated via SIREN/SIRET lookup and directory line management.
Validate recipient (SIREN) GET
Purpose of use: Verify the recipient is registered on PPF before sending an invoice.
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/validate/{siren} |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
| siren | String | Yes | 9-digit SIREN |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| siret | String | No | 14-digit SIRET |
Responses
200 — Recipient valid
404 — Not found in PPF
Recipient not found in PPF directory.
Lookup SIREN GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/siren/{siren} |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Lookup SIRET GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/siret/{siret} |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Create routing code (code routage) POST
Purpose of use: Route invoices to the correct destination within a company.
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/routing |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Request body (JSON)
{
"siret": "12345678901234",
"code": "ROUTING_CODE_VALUE"
}
Update routing code PUT
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/routing/instance/{idInstance} |
| Method | PUT |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Create directory line (ligne annuaire) POST
Purpose of use: Register the company in the PPF directory — required once per company onboarding.
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/directory-line |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Update directory line PUT
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/directory-line/instance/{idInstance} |
| Method | PUT |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Delete directory line DELETE
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/directory-line/instance/{idInstance} |
| Method | DELETE |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
PPF health check GET
Endpoint Information
| Property | Value |
|---|---|
| URL | /annuaire/FR/health |
| Method | GET |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Example response
{ "healthy": true }