Skip to main content
Version: 1.0.0

PPF Directory Line Search


Overview​

Search for PPF directory line entries by filtering on SIREN, SIRET, or other identifiers. This endpoint provides a live proxy to France's PPF Annuaire search API, enabling lookup of PA, Plateforme Agréée, registration details for a given company.

Endpoint Information​

PropertyValue
URL/annuaire/FR/directory-line/search
MethodPOST
Content-Typeapplication/json
Base URLStage Environment URL https://api-fr-stage.docnova.ai/
Base URLProduction Environment URL https://api-fr.docnova.ai/
AuthorizationR-Auth header, JWT token

Example Request​

curl --location 'https://api-fr.docnova.ai/annuaire/FR/directory-line/search' \
--header 'Accept: */*' \
--header 'Content-Type: application/json' \
--header 'R-Auth: <jwt-token>' \
--data '{
"filtres": {
"siren": {
"op": "strict",
"valeur": "{siren}"
}
},
"limite": 10
}'

Request Parameters​

Headers​

FieldTypeRequiredDescription
R-AuthJWTYesUser session JWT token. Sent without a Bearer prefix.
Content-TypestringYesMust be application/json.

Request Body​

FieldTypeRequiredDescription
filtresobjectYesFilter criteria for the search.
filtres.sirenobjectNoFilter by SIREN number.
filtres.siren.opstringYesOperator. Use strict for exact match.
filtres.siren.valeurstringYes9-digit SIREN number to search for.
limiteintegerNoMaximum number of results to return. Default: 10.

Responses​


200 - Successful Response​

{
"resultats": [
{
"identifiantAdressage": "945350858",
"matriculePlateforme": "0144",
"identifiantRoutage": null,
"siren": "945350858",
"siret": null,
"suffixeAdressage": null,
"dateFinEffet": null,
"dateFinEffective": "9999-12-31",
"historisation": {
"idInstance": 22484275,
"dateDebutEffet": "2026-08-07",
"dateDefinition": null,
"creePar": null,
"masque": null
},
"plateforme": null,
"uniteLegale": null,
"etablissement": null,
"codeRoutage": null
}
],
"recherche": null,
"nombre_total_resultats": 1
}

Response Fields​

FieldTypeNullableDescription
resultatsarrayNoList of matching directory line entries.
nombre_total_resultatsintegerNoTotal number of matching results.
rechercheobjectYesSearch metadata returned by PPF.

resultats Item Fields​

FieldTypeNullableDescription
identifiantAdressagestringYesPrimary addressing identifier, SIREN, SIRET, or routing code.
matriculePlateformestringYesPPF registration code of the Plateforme Agréée.
identifiantRoutagestringYesRouting identifier.
sirenstring (9)YesCompany SIREN number.
siretstring (14)YesEstablishment SIRET number.
suffixeAdressagestringYesSub-unit suffix for SIRET entries.
dateFinEffetLocalDateYesPlanned validity end date.
dateFinEffectiveLocalDateYesActual effective end date. 9999-12-31 means no end date.
historisation.idInstanceintegerYesPPF-assigned unique instance identifier. Use this with the PPF Directory Lookup endpoint.
historisation.dateDebutEffetLocalDateYesEffective start date of this registration.

⚠️ Important: Use the idInstance from this response, not from the SIREN lookup endpoint, when calling /annuaire/FR/directory-line/instance/{idInstance}. The SIREN lookup returns a different idInstance belonging to the company's legal record, which is unrelated to the PA registration.

Error Responses​

All errors follow this structure:

{
"errorMessage": "<description>",
"errorType": "<error key>",
"errorTitle": "<HTTP status>",
"status": "<code>",
"timestamp": "ISO8601",
"path": "<request path>"
}
StatusConditionMessage
401Missing, malformed, or expired R-Auth header.Not authorized for this action
500Unexpected error during PPF communication.An unexpected error occurred
503PPF integration disabled in server configuration.PPF integration is currently unavailable