Close File

This endpoint is used to close an existing file. Closing a file will change the file status to "Closed".

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

Response Schema

AttributeTypeDescription
statusCodeIntegerStandard HTTP response code. Status codes are outlined in the Errors section of this API reference.
messageStringA human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference.
dataBooleanTrue indicates that the file was closed.

False indicates that the file was not successfully closed.
errorsArray of StringsAn array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code.
Body Params
string
required

The unique reference ID created by treefort and passed back in response from the Create Verification Request or Update Verification Request endpoint. This ID is used to track all ID verifications associated with this request (i.e. all ID verifications associated to a file), and can be provided to TreeFort for troubleshooting purposes.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json