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}

Look up directory entries by electronic address

cURL

curl --request GET \
  --url https://api.invopop.com/apps/gov-fr/v1/directory/identifier/{identifier} \
  --header 'Authorization: Bearer <token>'

200

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

Returns all entries from the local mirror of the PPF Annuaire that use the given electronic address identifier (the value used to route invoices to a party in France, typically in scheme:value form). An empty results array means no entry currently uses this identifier.

Only available to live workspaces — sandbox enrollments receive 403 Forbidden.

Authorizations

Authorization · string · header · required

Authenticate using a valid Invopop enrollment token in the Bearer scheme.

Example: Authorization: Bearer <token>

Path Parameters

identifier · string · required

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

Example:

"0009:123456789"

Response

200

application/json

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

identifier · string · required

Electronic address identifier that was queried.

Example:

"0009:123456789"

count · integer · required

Number of directory entries returned.

Example:

1

results · object[] · required

Matching directory entries. Empty when the identifier is not in the Annuaire.

Show child attributes