v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Request for Information (RFI)

Retrieve RFI

Retrieve the details of a single RFI, including the questions raised and the documents required to answer it.

get/v1/rfis/{id}

Path parameters

idstring uuid required

Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Successfully retrieved an RFI.

account_idstring

A unique identifier of the account.

rfi_idstring

A unique identifier of the RFI.

status'SUBMITTED_PENDING' | 'REJECTED' | 'APPROVED' | 'ACTION_REQUIRED'

The current status of the RFI.

ACTION_REQUIRED: An answer is required from you.
SUBMITTED_PENDING: An answer has been submitted and is under review.
APPROVED: The submitted answer has been approved.
REJECTED: The submitted answer has been rejected; further action may be required.

create_timestring

Creation time of the RFI.

update_timestring

Last updated time of the RFI.

Example response

{
  "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "rfi_id": "f846c1c3-8e8e-4560-b1a8-5318e858df1c",
  "status": "SUBMITTED_PENDING",
  "create_time": "2024-11-08T17:17:32+08:00",
  "update_time": "2024-11-09T17:17:32+08:00",
  "request": [
    {
      "question": {
        "key": "basic_certificate_of_incorporation",
        "comment": "Company Registration Documentation: includes company name, registered address, business license, etc.",
        "type": "ATTACHMENT"
      },
      "answer": {
        "key": "basic_certificate_of_incorporation",
        "type": "ATTACHMENT",
        "attachments": [
          "63d75f6d-97a3-478c-bdbf-b050c650d72a"
        ]
      }
    }
  ]
}