Skip to navigation

Upload an application document

Beta
View as MarkdownOpen in Claude

Uploads one document to an application as multipart form data. List the application’s document requirements first. Send the requirement’s fieldPath, one of its subjectTypes as subject, and, for a person requirement, its personReference.

The file can be up to 10 MB, in a format the requirement accepts. Payabli checks the file’s content, not only its name. Each requirement takes up to maxUploads documents.

Uploading doesn’t change the application’s status. When underwriting requests documents, upload them, then call provide documents to return the application to review.

Authentication

AuthorizationBearer

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

Path parameters

requestsReferencestringRequired
The application reference.

Request

This endpoint expects a multipart form containing a file.
filefileRequired

The file to upload, up to 10 MB. Payabli checks the file’s content, not only its name, against the requirement’s allowedFormats.

fieldPathstringRequired

The fieldPath of the requirement you’re uploading for, from List application document requirements.

subjectenumRequired

The record the document is about. Send one of the requirement’s subjectTypes.

Allowed values:
personReferencestringOptional

The person the document is about. Required when subject is person. Use the personReference from the person’s requirement.

Response

The document was uploaded.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject
A document uploaded to an application.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error