Skip to main content

Rfi

idstring<uuid>

Unique identifier of the RFI.

caseNumberstring

Human-readable case reference, e.g. RFI-20260611-9F3A21B7. Stable for the lifetime of the case and safe to quote to customers (in emails, support tickets, or your own UI). Immutable once issued.

subjectTypestring

The subject the RFI is raised against.

Possible values: [ONBOARDING_APPLICATION, TRANSACTION, MULTI_TRANSACTION]

subjectIdstring<uuid>

Unique identifier of the subject. For ONBOARDING_APPLICATION this is the same value as accountId; for TRANSACTION it is the transaction id.

subjectReferencestring

Human-readable reference for the subject. Null for onboarding-application RFIs.

accountIdstring<uuid>

Unique identifier of the account the RFI is associated with. For onboarding-application RFIs this is the same value as subjectId.

statusstring

Lifecycle status of the RFI.

Possible values: [OPEN, CLOSED, CANCELLED]

customerDisplayMessagestring

Customer-facing message describing what's being asked.

lastRespondedAtstring<date-time>

Timestamp of the most recent customer response. Null if none yet.

closedAtstring<date-time>

Timestamp when the RFI was closed. Null while OPEN.

cancelledAtstring<date-time>

Timestamp when the RFI was cancelled. Null unless cancelled.

createdAtstring<date-time>

Timestamp when the RFI was created.

questions object[]

Questions the customer must answer.

  • Array [
    • idstring<uuid>

    Unique identifier of the question.

    promptstring

    The question prompt to display to the customer.

    displayOrderinteger<int32>

    Display order of the question within the RFI.

    answerstring

    The customer's answer, if one has been submitted. Null while pending.

    answeredAtstring<date-time>

    Timestamp when the answer was submitted. Null while pending.

  • ]
    • documentRequests object[]

    Document requests the customer must fulfil.

  • Array [
    • idstring<uuid>

    Unique identifier of the document-request slot. Use this as documentRequestId when calling POST /v1/rfi/{rfiId}/document-requests/{documentRequestId}/attach.

    documentTypeIdstring<uuid>

    The document type the customer is being asked to provide.

    displayTitlestring

    Default title to display to the customer for this document request.

    customLabelstring

    Optional custom label that overrides the default title, if set by Hubpay.

    perItemDisplayMessagestring

    Optional per-item message that explains why this document is required.

    displayOrderinteger<int32>

    Display order of the document request within the RFI.

    documentIdstring<uuid>

    Unique identifier of the document the customer has attached to this slot. Null while pending. This is the same UUID surfaced as data.documentId in v1.rfi.document.* webhook events. Persist documentId → rfiId at attach time so partners can correlate webhook events back to the parent RFI.

    documentStatusstring

    Review status of the attached document. Null while pending.

    Possible values: [NOT_SUBMITTED, PENDING_REVIEW, DECLINED, APPROVED, PENDING_VERIFICATION, VALIDATION_WARNINGS]

    documentUploads object[]

    The files attached to this slot. Empty list when nothing has been attached yet.

  • Array [
    • idstring<uuid>required
    fileNamestringrequired
    contentTypestringrequired
    createdAtstring<date-time>required
  • ]
  • ]
    • Rfi
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "caseNumber": "string",
      "subjectType": "ONBOARDING_APPLICATION",
      "subjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subjectReference": "string",
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "OPEN",
      "customerDisplayMessage": "string",
      "lastRespondedAt": "2024-07-29T15:51:28.071Z",
      "closedAt": "2024-07-29T15:51:28.071Z",
      "cancelledAt": "2024-07-29T15:51:28.071Z",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "questions": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "prompt": "string",
          "displayOrder": 0,
          "answer": "string",
          "answeredAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "documentRequests": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "documentTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayTitle": "string",
          "customLabel": "string",
          "perItemDisplayMessage": "string",
          "displayOrder": 0,
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "documentStatus": "NOT_SUBMITTED",
          "documentUploads": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "fileName": "string",
              "contentType": "string",
              "createdAt": "2024-07-29T15:51:28.071Z"
            }
          ]
        }
      ]
    }