Delete Folder

Endpoint Overview

POST /api/v1/sureparser/delete-folder

Description

The Delete Folder API endpoint allows you to permanently remove a folder from the Surepass SureParse platform. You can specify whether to also delete all processors contained within the folder. This operation is essential for maintaining an organized and efficient document processing environment, ensuring that obsolete or redundant folders and their contents do not clutter your workspace.

Key Benefits

Permanently remove folders to keep your workspace organized.

Optionally delete all processors within a folder for complete cleanup.

Reduces risk of accidental use of outdated or unnecessary folders and processors.

Supports automation of folder and processor lifecycle management.

Use Cases

Financial Services

Healthcare

Logistics

Delete folders associated with outdated compliance periods or products.

Clean up processors and folders after regulatory changes or audits.

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.app

Production: https://kyc-api.surepass.app

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication (JWT)
Content-Type	Yes	Must be `application/json`

Request Body

Parameter	Type	Required	Description
folder_id	string	Yes	Unique identifier of the folder to delete. This value is obtained from create-folder API
delete_processors	boolean	Yes	If true, all processors in the folder will also be deleted; if false, they will be retained

Example Request

{
  "folder_id": "studio_folder_ABC123XYZ",
  "delete_processors": true
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Contains details of the deleted folder
├─ folder_id	string	Unique identifier for the deleted folder
├─ name	string	Name of the deleted folder
├─ processor_count	int	Number of processors in the folder at deletion
├─ created_at	string	ISO timestamp of folder creation
status_code	int	HTTP status code (e.g., 200 for success)
success	bool	Indicates if the request was successful
message	string	Human-readable status message
message_code	string	Machine-readable status code

Example Successful Response

{
  "data": {
    "folder_id": "studio_folder_ABC123XYZ",
    "name": "Financial Documents",
    "processor_count": 0,
    "created_at": "2025-12-18T10:28:54.816000"
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Folder Not Found

Authentication Error

{
  "data": null,
  "status_code": 404,
  "success": false,
  "message": "Folder not found",
  "message_code": "folder_not_found"
}

The specified folder_id does not exist.

Integration Best Practices

Security Recommendations

Always use HTTPS for all API requests to protect sensitive data in transit.

Store JWT tokens securely and rotate them regularly.

Restrict folder deletion permissions to authorized users only.

User Experience Guidelines

Confirm folder deletion with the user before making the API call, especially if deleting processors.

Display clear success or error messages to users after folder deletion.

Code Samples

cURL

Python

Node.js

Related APIs

List Folders: Retrieve a paginated list of all folders in the workspace.

Create Execution History Folder: Create a new folder for organizing execution history.

Rename Folder: Update the name of an existing folder.

Compliance and Legal Considerations

Ensure that folder and processor deletions comply with your organization’s data retention and privacy policies. Only authorized users should be allowed to delete folders or processors, and all actions should be logged for audit purposes. Deleting processors is irreversible and may impact workflows that depend on them.

This documentation provides a complete, implementation-focused guide for integrating with the Delete Folder API endpoint. For further support, consult the Surepass developer portal or contact your Surepass technical representative.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/sureparser/delete-folder' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "folder_id": "folder_id", "delete_processors": false }'

{ "data": { "folder_id": "processor_folderABCDEFGHIJKLMNOP", "name": "Financial Documents", "created_at": "2024-12-13T12:00:00.000000" }, "status_code": 200, "message": "Success", "success": true }

Delete Folder

Delete Folder#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Delete Folder

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples