Request an upload URL for a bulk pre-qualification file

Requests a pre-signed S3 URL to upload a bulk pre-qualification data file. Once you have the upload URL, PUT your file bytes directly to S3 — no API key is needed for the S3 upload itself.

File size:

  • Files under 100 MB: a single uploadUrl is returned (uploadType: single)
  • Files 100 MB–200 MB: multipart upload URLs are returned (uploadType: multipart). Upload each part to its corresponding uploadUrl, collect the ETag from each S3 response header, then call POST /prequalification/multipart/complete.

Accepted file types: CSV, XLS, XLSX

Maximum file size: 200 MB

Body Params

File metadata for generating the upload URL

Request body for generating a pre-qualification file upload URL

string
required

Name of the file to upload (including extension)

string
enum
required

MIME type of the file

Allowed:
integer

Size of the file in bytes. Required for files over 100 MB to trigger multipart upload mode. Maximum 200 MB.

Headers
string
required

Your API key for authentication.

Responses

400

Invalid request — missing required fields, unsupported file type, or file too large

401

Unauthorized - Missing or invalid API key

403

Forbidden - Invalid or deactivated API key

500

Internal server error. Please contact support if the issue persists.

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