Skip to main content
GET
Get an RFI

Authorizations

Api-Key
string
header
required

Path Parameters

rfiID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Response

Successful RFI response

id
string
required
read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
state
enum<string>
required

The current state of the RFI

Available options:
on_developer,
on_bridge,
closed
type
string
required

A developer-facing name describing the kind of request being made

developer_id
string
required
read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
deadline
string<date-time>
required

The time by which a response to this RFI is expected

requested_items
object[]
required

The items Bridge is asking the developer to provide for this RFI. A question that asks for both a narrative and supporting documents is split into two items sharing a base name, suffixed _text and _attachment

dashboard_url
string
required

A link to view and respond to this RFI in the Bridge dashboard

created_at
string<date-time>
required
read-only

Time of creation of the RFI

customer_id
string | null
read-only

The customer this RFI is associated with, if any

Required string length: 1 - 42
Pattern: [a-z0-9]*
referent_id
string | null

The id of the record (transfer, drain, deposit, or card account) this RFI relates to, if any. Resolve it against the endpoint named by referent_type

referent_type
enum<string> | null

The type of record that referent_id refers to

Available options:
transfer,
drain,
deposit,
card_account
context
object

Transaction and counterparty facts this RFI is about, keyed by field name. The set of keys present varies by RFI template - fields without a value for this RFI are omitted rather than set to null. May contain personally-identifiable information (customer name/email, IBANs, counterparty names). The properties below are the most common keys; other template-specific string keys may also be present.

bridge_action_taken
enum<string> | null

An action Bridge has already taken as a result of this RFI, if any

Available options:
customer_paused,
transaction_paused
expected_action_on_expiry
enum<string> | null

The action Bridge expects to take if this RFI expires without a response, if any

Available options:
pause_customer
state_changed_at
string<date-time> | null

The time the RFI's state last changed

closed_at
string<date-time> | null

The time the RFI was closed, if it has been