Skip to main content
The RFI webhook and API are currently in beta. The API and webhook payloads described on this page are subject to change.
A Request for Information (RFI) is raised by Bridge’s compliance team when additional information is needed about a developer, customer, or specific transaction, for example a payment’s purpose or the source of funds. RFIs are typically raised on a transfer, drain, deposit, or card_account, but may also be raised directly on a developer or customer with no associated transaction. Bridge notifies you of RFIs via the rfi webhook event category and lets you read RFI state through the /rfis API. Resolving an RFI (submitting responses) currently happens via the Bridge Dashboard, using the dashboard_url returned on the RFI object. You can also continue to respond to RFIs via email if you prefer.

RFI lifecycle

An RFI moves through the following states:

The RFI object

Context

context holds transaction and counterparty details relevant to the request. The set of keys present varies by request - fields without a value for a given RFI are omitted rather than set to null. This object may contain personally-identifiable information, such as a customer’s name or email, IBANs, or counterparty names. Below is the full list of keys context can contain. This list may grow over time.

Requested items

requested_items lists the items Bridge is asking the developer to provide.

API

Use the RFIs API to read the current state of RFIs raised on your developer or customer accounts.
  • GET /rfis - list RFIs, optionally filtered by state or customer_id, with cursor-based pagination via starting_after/ending_before.
  • GET /rfis/{rfiID} - retrieve a single RFI by id.
Request
Response
There is currently no API for submitting RFI answers - respond via the dashboard_url returned on the RFI object.

Webhooks

Subscribe to the rfi event category on your webhook endpoint to be notified as RFIs are created and change state. The event_object on these events matches the RFI object returned by the API. If you don’t have a webhook endpoint yet, follow the webhook setup guide to create one. To add RFI events to an existing endpoint, include rfi in the event_categories array when you create or update the endpoint. See the webhooks overview and event structure docs for general webhook concepts.

Example: RFI lifecycle

The following three events show a single RFI moving from on_developer, to on_bridge after a response is submitted in the dashboard, to closed once Bridge finishes review.