---
title: "Look up directory entries by electronic address"
method: GET
path: "/apps/gov-fr/v1/directory/identifier/{identifier}"
---

# Look up directory entries by electronic address

`GET /apps/gov-fr/v1/directory/identifier/{identifier}`

## Request

- Base URL: `https://api.invopop.com`
- URL: `https://api.invopop.com/apps/gov-fr/v1/directory/identifier/{identifier}`
- Auth: none required
- TypeScript: <https://skmtc.dev/invopop/apis/access-service-api/docs/apps/gov-fr/v1/directory/identifier/:identifier/get.ts> (a function with typed inputs; its response is checked against the schema)

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`.

## Path parameters

- `identifier` string, required

## Response `200`

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

- IdentifierLookupResponse
  - `identifier` string, required: Electronic address identifier that was queried.
  - `count` integer, required: Number of directory entries returned.
  - `results` DirectoryEntry[], required: Matching directory entries. Empty when the identifier is not in the Annuaire.
    - `id_instance` string: Unique instance identifier from the PPF export.
    - `siren` string: 9-digit French SIREN of the company.
    - `siret` string: 14-digit French SIRET of the establishment, when applicable.
    - `routing_code` string: Routing code used by the PPF to deliver invoices.
    - `platform_id` string: 4-digit identifier of the PA platform that registered the entry.
    - `nature` string: Single-letter code for the nature of the entry as classified by the Annuaire.
    - `identifier` string: Electronic address identifier used for routing. Typically the SIREN, optionally with a `_suffix` qualifier when multiple addresses exist for the same company.
    - `suffix` string: Optional suffix qualifying the identifier.
    - `start_date` string: Date from which this entry is active in the Annuaire, as `YYYYMMDD`.
    - `end_date` string: Scheduled end date of the entry as `YYYYMMDD`, when set.
    - `effective_end_date` string: Effective end date as `YYYYMMDD`, once the entry has been deactivated.
    - `created_at` string, date-time: When this entry was first stored in the local mirror.
    - `updated_at` string, date-time: When this entry was last refreshed from a PPF export.

## Other responses

- `400`: The request is malformed or missing required parameters.
- `401`: Missing or invalid authentication token.
- `403`: The authenticated enrollment is not allowed to access this silo entry.
- `500`: An unexpected server-side error occurred.

---

[API](https://skmtc.dev/invopop/apis/access-service-api.md) - [All operations](https://skmtc.dev/invopop/apis/access-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/invopop/apis/access-service-api/revisions/fc954f96ea62?raw)