Overview
Two queries read requests for information (RFIs):openRfislists every RFI on the token’s account that is waiting for the customer’s answers. Use it to decide whether to show an RFI prompt.rfireads one RFI by ID, in any status. Use it to render a form you have already found, or to check the outcome after submitting.
Rfi type. See the RFI overview for the flow and question types.
Required scopes
The customer is taken from the token. The token’s
accountId must be the account the RFI is on, and its user must be the account’s addressee: the owner of a consumer account, or the applicant of a business account. See Who can answer an RFI.
openRfis
[Rfi!]!: the RFIs on the token’s account with status PENDING_DOCUMENTS that have not expired, newest first. Returns [] when there are none.
RFIs that are IN_REVIEW or finished are not in this list. Read them with rfi.
rfi
Arguments
Returns the RFI in any status. Questions are included only while it is
PENDING_DOCUMENTS; otherwise questions is [].
Response details
Rfi
RfiQuestion
Saved answers
Use
isSubmitted to show answered questions as read-only and leave them out of your next submitRfi call.
cURL Example
Example Response
Error Codes
Both queries return failures in the top-levelerrors array.
openRfis returns a non-null list, so an ACCESS_DENIED error sets data to null. Check errors before reading data.Best practices
- Poll gently, or use webhooks. Call
openRfiswhen the customer opens your app or their account screen, not on every page load. To be told when an RFI arrives, subscribe to the RFI webhook events. - Render from the response. Questions, their order and which are required change from one RFI to the next.
- Show the expiry. If
expiresAtis set, show it to the customer. An expired RFI cannot be answered.
Related pages
RFI overview
Statuses, question types and the end-to-end flow.
Submit an RFI
Send the answers for the questions you rendered.