v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Transition RFI status

[Available in Sandbox only]

put/sandbox/customer_profile/{cp_id}/rfi-requests/{rfi_id}/transition

Path parameters

cp_idstring required

Unique customer profile ID.

rfi_idstring required

Unique RFI ID.

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

Response

Example response

{
  "data": {
    "id": "rfi_request_32a7b51c-17e4-44cb-9e34-b1822ae844f2",
    "type": "rfiRequest",
    "attributes": {
      "customerProfileId": "customer_profile_a1cc2c3b-8e5e-4192-bf75-1d28bfa6248d",
      "activeRfiRequest": {
        "createdAt": "2025-11-06T09:07:39Z",
        "status": "completed",
        "rfiQuestions": [
          {
            "id": 1,
            "question": "What is your occupation?",
            "replyType": "TEXT",
            "questionStatus": "pending",
            "requiresAction": true
          }
        ]
      },
      "rfiProgressSummary": {
        "expiryDate": "2025-11-16T09:07:39Z",
        "daysUntilExpiry": 10,
        "totalQuestions": 3,
        "pendingQuestions": 3
      }
    }
  }
}