Skip to main content
POST
/
v1
/
rfis
/
answer
Answer RFI
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/rfis/answer \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "rfi_id": "f846c1c3-8e8e-4560-b1a8-5318e858df1c",
  "answer": [
    {
      "key": "basic_certificate_of_incorporation",
      "type": "ATTACHMENT",
      "attachments": [
        "63d75f6d-97a3-478c-bdbf-b050c650d72a"
      ]
    }
  ]
}
'
{
  "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.

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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

​
x-idempotency-key
string<uuid>
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Body

application/json
​
rfi_id
string
required

A unique identifier of the RFI.

Example:

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

​
answer
object[]
required

The list of answers, one per question. Each answer.key must match the corresponding question.key returned by Retrieve RFI.

Response

200 - application/json

OK - Successfully answered the RFI.

​
account_id
string

A unique identifier of the account.

Example:

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

​
rfi_id
string

A unique identifier of the RFI.

Example:

"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.
Available options:
SUBMITTED_PENDING,
REJECTED,
APPROVED,
ACTION_REQUIRED
Example:

"SUBMITTED_PENDING"

​
create_time
string

Creation time of the RFI.

Example:

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

​
update_time
string

Last updated time of the RFI.

Example:

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

​
request
object[]

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