CLclaimkit
files

Unlock File

Re-process a password-protected file using the supplied password.

Resets processing state and re-enqueues the background task with the password held transiently in memory. The password is never persisted to the DB nor written to logs.

Returns 200 with the updated row; 404 if missing; 409 if already processing.

post/claims/{claim_id}/files/{file_id}/unlock

Request

  • Base URL
    https://api.claimkit.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.claimkit.co/claims/{claim_id}/files/{file_id}/unlock
  • Auth
    none declared

Path parameters

claim_idinteger required
file_idinteger required

Request body

passwordstring required

Response

Successful Response

idinteger required
filenamestring required
file_typestring required
file_sizeinteger required
categorystring nullable required
report_yearinteger nullable
statusstring required
uploaded_atstring required
ai_summarystring nullable
sourcestring nullable
processing_statusstring required
processing_error_codestring nullable
processing_error_messagestring nullable
extracted_qaobject nullable
tax_return_detailsobject nullable
tax_return_mismatchesobject[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.