RfiDocumentRequest

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

]

RfiDocumentRequest

{
  "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"
    }
  ]
}