API Reference
Log In
API Reference

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.

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

External ID of the applicant

Body Params
string
required

The data field key for the file

string
enum
required

Reason for recollection

Allowed:
string

Custom email subject (optional)

string

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

boolean

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

string

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

boolean

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

Responses

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