Applicants

File Upload to S3

Changed on

Step 1 of 2 for adding files to an applicant profile.

post/v2/applicants/{id}/secure_documents/upload

Request

  • Base URL
    https://api.fountain.com
  • URL
    https://api.fountain.com/v2/applicants/{id}/secure_documents/upload
  • Auth
    API key in header X-ACCESS-TOKEN

Path parameters

idstring required

Request body

filenamestring

path/to/file.upload

attribute_to_applicantboolean

When true, attributes the upload to the applicant (rather than the caller) in the History panel.

Response

OK

urlstring uri required

The URL to upload the file to.

hoststring required

The HOST of the URL.

min_sizenumber required

Minimum file upload size.

max_sizenumber required

Maximum file upload size.

only_imagesboolean required

TRUE if only for uploading images.

typestring

HTTP verb to upload file.

Changes