API Reference
Log In
API Reference

Upload File and Link to Applicant

Upload a secure file and link it to an applicant in one request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to upload a secure file and link it to an applicant in one request. It replaces the separate S3 upload and link_upload calls.

Send a multipart/form-data request with these fields:

FieldRequiredDescription
fileYesThe file to upload. Allowed types are PDF, JPG, JPEG, PNG, GIF, HEIC, HEIF, WEBP, AVIF, DOC, DOCX, and TXT. The maximum size is 15 MB.
keyYesFountain file identifier, also called the data key.
attribute_to_applicantNoSet to true to show the applicant, rather than the account owner, as the actor for the upload in the History panel. Omit it to attribute the upload to the account owner.

Example request fields:

file=@/path/to/driver_license.pdf
key=driver_license
attribute_to_applicant=true

A successful request returns:

{ "uploaded": true }
Path Params
Body Params
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json