Skip to main content
WEBHOOK
onboardingRfi
{
  "version": "V1.6.0",
  "event_name": "RFI",
  "event_type": "rfi.action_required",
  "event_id": "882794c0-dae5-45c0-806a-1eb134866cf4",
  "source_id": "6aaee9c5-9c71-4393-9a82-dbd841f3da39",
  "data": {
    "rfi_id": "48360606-82fa-46d2-be4a-43e80bd8dc67",
    "rfi_type": "onboarding",
    "account_id": "6aaee9c5-9c71-4393-9a82-dbd841f3da39",
    "create_time": "2026-04-20T11:20:11.268958593+08:00",
    "update_time": "2026-04-20T11:20:11.268958593+08:00",
    "ref_reference_id": "6aaee9c5-9c71-4393-9a82-dbd841f3da39"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Event Types

Event TypeDescription
rfi.action_requiredAn RFI was raised during onboarding and requires your action.

​
Usage guidelines

Upon receiving this notification, follow the steps below:
1

Retrieve RFI details

Use the rfi_id provided in the notification to call the Retrieve RFI API. This returns the required file information for the current RFI.
2

Upload required file

Upload the specified file via the Upload A File API. Upon success, a file_id will be returned.
3

Submit file via Answer RFI

Submit the file_id to UQPAY using the Answer RFI API.Ensure that the answer.key in your request matches the question.key returned from the Retrieve RFI response.

Body

application/json
​
event_id
string<uuid>
required

A unique identifier for this event.

​
event_name
enum<string>
required

Top-level event category.

Available options:
RFI
​
event_type
enum<string>
required

The specific event type that occurred.

Available options:
rfi.action_required
​
source_id
string
required

RFI ID.

​
version
string
required

API version number.

Example:

"V1.6.0"

​
data
object

RFI (Request for Information) details associated with the event.

Response

200

Return 200 to acknowledge receipt.