Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Path Parameters

customerId
string
required

Customer ID

id
string
required

RFI ID

Body

application/json
fieldResponses
object | null
freeformResponse
string | null

Response

id
string
required
customerName
string
required
status
enum<string>
required
Available options:
DRAFT,
OPEN,
SUBMITTED,
UNDER_REVIEW,
RESOLVED,
CANCELLED
publicStatus
enum<string>
required

Customer-facing case status for applicant and parent portal surfaces.

Available options:
NEEDS_INFORMATION,
IN_REVIEW,
APPROVED,
REJECTED,
CANCELLED,
COMPLETED
requestedFields
object[]
required
requestedDocuments
object[]
required
documents
object[]
required
requestedSignings
object[]
required
dueAt
string<date-time> | null
openedAt
string<date-time> | null
submittedAt
string<date-time> | null
instructions
string | null
fieldResponses
object | null
freeformResponse
string | null