Skip to content
File Uploads

Get File Upload URL

Gets a presigned object storage upload URL and the file key. Upload the file content directly to url with HTTP PUT, set the Content-Type header to the file MIME type, and optionally set the file name with Content-Disposition: attachment; filename=<FILE_NAME>. After the upload succeeds, submit key to the business endpoint that needs the attachment.

This endpoint is used for file uploads in several features, including stock transfer-in attachments, account opening documents, professional investor verification materials, and electronic signatures. If an upload fails, get a new upload URL and upload again.

GEThttps://api.lbkrs.com/v1/file/upload_url

Parameters

servicestringqueryRequired

Business that owns the file, which determines where it is stored. Use the same value when uploading and when getting the download URL later. Known values:

  • lb.portfolio.atm - Attachments for funding services such as stock transfers in
  • user.account - Account opening and account documents
  • form.service - Forms and agreement signatures
prefixstringquery

File key prefix, used to group files within the same business.

content_typestringquery

File MIME type, such as image/jpeg or application/pdf.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get File Upload URL” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Presigned upload URL. Upload the file to it with HTTP PUT.

keystring

Object storage key of the file. Submit it to the business endpoint and use it to get a download URL.

Whale Docs