---
title: FapiInteractionIdFilter
description: Tracks the interaction ID of requests, according to the Financial-grade API (FAPI) WG, as follows:
component: pinggateway
version: 2026
page_id: pinggateway:reference:FapiInteractionIdFilter
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/FapiInteractionIdFilter.html
revdate: 2025-06-02T18:01:47Z
section_ids:
  FapiInteractionIdFilter-usage: Usage
  FapiInteractionIdFilter-properties: Properties
  FapiInteractionIdFilter-example: Example
  FapiInteractionIdFilter-more: More information
---

# FapiInteractionIdFilter

Tracks the interaction ID of requests, according to the [Financial-grade API (FAPI) WG](https://openid.net/wg/fapi/), as follows:

* If a FAPI header is provided in a client request, this filter includes the interaction ID in the `x-fapi-interaction-id` property of the response header.

* If a FAPI header isn't provided in the request, this filter includes a new Universally Unique Identifier (UUID) in the `x-fapi-interaction-id` property of the response header.

* This filter logs the value of `x-fapi-interaction-id`.

## Usage

```none
{
  "name": string,
  "type": "FapiInteractionIdFilter"
}
```

## Properties

There are no configuration properties for this filter.

## Example

The following example is based on [Mutual TLS with PingAM](../gateway-guide/oauth2-rs-introspect-mtls.html) and adds a FapiInteractionIdFilter to the end of the chain:

```json
{
  "name": "mtls",
  "condition": "${find(request.uri.path, '/mtls')}",
  "handler": {
    "type": "Chain",
    "config": {
      "filters": [ {
          "name": "OAuth2ResourceServerFilter-1",
           ...
        },
        {
          "type": "FapiInteractionIdFilter"
        }
      ],
      "handler": {
          "name": "StaticResponseHandler-1",
          ...
      }
    }
  }
}
```

## More information

[org.forgerock.openig.filter.finance.FapiInteractionIdFilter](../_attachments/apidocs/org/forgerock/openig/filter/finance/FapiInteractionIdFilter.html)

[Financial-grade API - Part 1: Read-Only API Security Profile](https://openid.net/specs/openid-financial-api-part-1.html#protected-resources-provisions)