v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

Applicants

Trigger file recollection for an applicant

Creates a file recollection request for a specific applicant file. This endpoint triggers a recollection process that notifies the applicant to resubmit a file.

post/api/v2/applicants/{applicant_id}/file_upload_requests

Request body

data_keystring required

The data field key for the file

recollect_reason'blurry' | 'corrupt' | 'incorrect' | 'expired' | 'custom' required

Reason for recollection

email_subjectstring

Custom email subject (optional)

email_contentstring

Custom email content (optional, defaults to reason-specific content)

send_smsboolean

Whether to send SMS notification (optional, defaults to false)

sms_contentstring

Custom SMS content (optional, defaults to existing SMS template)

notify_ownerboolean

Whether to notify owner when file is resubmitted (optional, defaults to false)

Example request

{
  "data_key": "credit_card_photo",
  "recollect_reason": "blurry",
  "email_subject": "Please resubmit your document",
  "email_content": "Hello, please resubmit your file as it appears to be blurry: [PORTAL_UPLOAD_REQUEST_LINK]",
  "sms_content": "Please resubmit your file."
}

Response

File recollection request created successfully

idinteger required

File upload request ID

recollection_reasonstring required

Reason for recollection

document_namestring required

Name of the document

notify_users_on_submitboolean required

Whether to notify users on submit

created_atstring datetime required

Creation timestamp