v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Look up directory entries by electronic address

Returns all entries from the PPF Annuaire that match the given electronic address identifier (the value used to route invoices to a party in France represented by an inbox in Invopop).

Only available to live workspaces. Sandbox workspaces receive 403 Forbidden.

get/apps/gov-fr/v1/directory/identifier/{identifier}

Path parameters

identifierstring required
Example:0009:123456789

Electronic address identifier as registered in the Annuaire, typically in scheme:value form (e.g. 0009:123456789).

Response

Lookup completed. count may be 0 if no entry uses this identifier.

identifierstring required

Electronic address identifier that was queried.

countinteger required

Number of directory entries returned.

Example response

{
  "identifier": "0009:123456789",
  "count": 1,
  "results": [
    {
      "id_instance": "1020993",
      "siren": "269909452",
      "routing_code": "ROUTE123",
      "platform_id": "0431",
      "nature": "M",
      "identifier": "269909452",
      "suffix": "suffixe1",
      "start_date": "20251227",
      "effective_end_date": "20280402",
      "created_at": "2026-01-15T10:00:00Z",
      "updated_at": "2026-01-15T10:00:00Z"
    }
  ]
}