Upload one or more documents for a loan application.

Accepts a multipart/form-data request only — this endpoint does not accept application/json.

Array binding convention

Documents is bound from form-data as a list, so each item's fields must use an
indexed key format: Documents[i].PropertyName (zero-based index). A plain
Documents key without an index will not bind.
Example — uploading two documents for one loan application:

KeyValue
ApplicationId3fa85f64-5717-4562-b3fc-2c963f66afa6
Documents[0].File(binary file)
Documents[0].DocumentTypeId8f14e45f-ceea-467a-9575-...
Documents[0].DocumentNameBank Statement.pdf
Documents[1].File(binary file)
Documents[1].DocumentTypeId...
Documents[1].DocumentNamePayslip.pdf

Field notes

  • ApplicationId — internal GUID of the loan application the documents belong to.
  • Documents[i].File — binary content of the file for item i.
  • Documents[i].DocumentTypeId — GUID identifying the document type. Must be a valid ID for the caller's
    workspace
    — call
    GET /api/v1/core/resources/get-upload-document-types-by-workspace first to retrieve the allowed document type IDs
    for the current workspace.
    Passing an arbitrary or cross-workspace GUID will be rejected.
  • Documents[i].DocumentName — display name shown to users; does not need to match the uploaded filename.

Common mistakes

  • Sending Documents as a JSON string/array instead of individual indexed form fields.
  • Manually setting a Content-Type: multipart/form-data header without a boundary — let your HTTP client generate
    it.
  • Omitting the index (e.g. Documents.File instead of Documents[0].File) — the model binder can't map this to a
    list item.
  • Hardcoding or reusing a DocumentTypeId from another workspace/environment instead of fetching it from
    get-upload-document-types-by-workspace.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid

Internal GUID for the loan application

Documents
array of objects

List of documents to upload, each with a file, document type, and display name

Documents
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Language
Credentials
LoadingLoading…
Response
Choose an example:
text/plain
application/json
text/json