Move Processor

Endpoint Overview

POST /api/v1/sureparser/move-processor

Description

The Move Processor API endpoint allows you to transfer a processor from its current folder to another folder within the Surepass SureParse platform. By specifying the processor’s unique identifier and the target folder’s identifier, you can reorganize your processing environment to reflect changing business needs, improve workflow management, and maintain a clean, logical folder structure.

Key Benefits

Easily reorganize processors across folders for better management.

Supports scalable and flexible document processing workflows.

Keeps your workspace organized as business requirements evolve.

Reduces manual effort and risk of misplacement by automating processor moves.

Use Cases

Financial Services

Healthcare

Logistics

Move processors to new folders for each fiscal year or compliance cycle.

Reorganize processors after mergers, acquisitions, or restructuring.

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
processor_id	string	Yes	Unique identifier of the processor to move (from create-processor)
folder_id	string	Yes	Unique identifier of the target folder (from create-folder)

Example Request

{
  "processor_id": "studio_processor_ABC123XYZ",
  "folder_id": "studio_folder_DEF456UVW"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Contains updated processor details
├─ processor_id	string	Unique identifier of the processor
├─ processor_name	string	Name of the processor
├─ file_id	string	Identifier of the associated file
├─ filename	string	Name of the associated file
├─ processor_type	string	Type of processor (e.g., splitter)
├─ categories	array	List of categories processed (type, description)
├─ context	string	Context or notes for the processor
├─ folder_id	string	Unique identifier of the target folder
├─ created_at	string	ISO timestamp of processor 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": {
    "processor_id": "studio_processor_ABC123XYZ",
    "processor_name": "Sample Processor",
    "file_id": "studio_file_9876543210",
    "filename": "Sample_Document.pdf",
    "processor_type": "splitter",
    "categories": [
      {
        "type": "passport",
        "description": ""
      }
    ],
    "context": "Sample context for processing",
    "folder_id": "studio_folder_DEF456UVW",
    "created_at": "2025-12-17T10:57:56.557000"
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Processor or Folder Not Found

Authentication Error

{
  "data": null,
  "status_code": 404,
  "success": false,
  "message": "Processor or folder not found",
  "message_code": "not_found"
}

The specified processor_id or 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 processor move permissions to authorized users only.

User Experience Guidelines

Validate processor and folder IDs before making the API call.

Display clear success or error messages to users after moving a processor.

Code Samples

cURL

Python

Node.js

Related APIs

Create Processor: Define a new processor for document parsing.

Create Execution History Folder: Create a new folder for organizing processors.

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

Compliance and Legal Considerations

Ensure that processor moves comply with your organization’s data retention and privacy policies. Only authorized users should be allowed to move processors, and all actions should be logged for audit purposes.

This documentation provides a complete, implementation-focused guide for integrating with the Move Processor 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/move-processor' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "processor_id": "processor_id", "folder_id": "folder_id" }'

{ "data": { "processor_id": "processor_configABCDEFGHIJKLMNOPQ", "processor_name": "Invoice Processor", "file_id": "fileABCDEFGHIJKLMNOPQRSTU", "filename": "sample.pdf", "processor_type": "splitter", "categories": [], "context": null, "folder_id": "processor_folderABCDEFGHIJKLMNOP", "created_at": "2024-12-13T12:00:00.000000" }, "status_code": 200, "message": "Success", "success": true }

Move Processor to Folder

Move Processor#

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