v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Request for Information (RFI)

List RFIs

Returns a paginated list of RFIs raised against your UQPAY account. Use this to discover open RFIs that require your action and to review previously answered ones.

get/v1/rfis

Query parameters

page_sizeinteger required

Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required

Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

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

Filter the result list by RFI status.

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 listed RFIs.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "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"
            ]
          }
        }
      ]
    }
  ]
}