Skip to main content
GET
List documents for a deal

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dealId
string
required

Securitization Deal ID

Example:

"deal_abc123"

Query Parameters

page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

limit
number
default:20

Results per page

Required range: 1 <= x <= 100
Example:

20

documentType
enum<string>

Filter by document type (e.g. loan_tape, legal)

Available options:
legal,
internal,
loan_tape,
credit_union_export
Example:

"loan_tape"

status
enum<string>

Filter by document status (e.g. uploaded, processing)

Available options:
active,
archived,
all
Example:

"uploaded"

sortBy
enum<string>
default:createdAt

Field to sort by (e.g. createdAt)

Available options:
name,
type,
createdAt,
size
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort direction: asc or desc

Available options:
asc,
desc
Example:

"desc"

Search by file name

Example:

"w9"

Response

Documents grouped by type

success
boolean
Example:

true

data
object