跳转到主要内容
GET
/
v1
/
rfis
/
{id}
Retrieve RFI
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/rfis/{id} \
  --header 'x-auth-token: <api-key>'
{
  "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"
        ]
      }
    }
  ]
}

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.

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

​
x-on-behalf-of
string

The value set to the connected account's ID. More information at List Connected Accounts

路径参数

​
id
string<uuid>
必填

Universally unique identifier (UUID v4) of a resource.

示例:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

响应

200 - application/json

OK - Successfully retrieved an RFI.

​
account_id
string

A unique identifier of the account.

示例:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

​
rfi_id
string

A unique identifier of the RFI.

示例:

"f846c1c3-8e8e-4560-b1a8-5318e858df1c"

​
status
enum<string>

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.
可用选项:
SUBMITTED_PENDING,
REJECTED,
APPROVED,
ACTION_REQUIRED
示例:

"SUBMITTED_PENDING"

​
create_time
string

Creation time of the RFI.

示例:

"2024-11-08T17:17:32+08:00"

​
update_time
string

Last updated time of the RFI.

示例:

"2024-11-09T17:17:32+08:00"

​
request
object[]

The list of questions raised in this RFI and any answers already submitted.