Delete Processor

Endpoint Overview

POST /api/v1/sureparser/delete-processor

Description

The Delete Processor API endpoint allows you to permanently remove a processor from the Surepass SureParse platform by specifying its unique processor ID. This operation is essential for maintaining a clean and efficient processing environment, ensuring that obsolete or redundant processors do not clutter your system. Deleting unused processors helps streamline document workflows, reduces potential confusion, and enhances overall system performance.

Key Benefits

Enables secure and permanent removal of processors by ID.

Helps maintain an organized and efficient processing environment.

Reduces risk of accidental use of outdated or deprecated processors.

Supports automation of processor lifecycle management.

Use Cases

Financial Services

Healthcare

Logistics

Remove processors associated with outdated KYC document templates.

Automate cleanup of processors after regulatory changes.

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 delete.

Example Request

{
  "processor_id": "studio_processor_ZsyAumAbqPrniLzjjzUP"
}

Process Response

Response Parameters

Parameter	Type	Description
processor_id	string	Unique identifier of the deleted processor.

Example Successful Response

{
  "processor_id": "studio_processor_CBcEVOPAnusIaqbPGkDE"
}

Possible Error Responses

Processor Not Found

Authentication Error

{
  "processor_id": null,
  "error": "Processor not found"
}

The specified processor_id does not exist or has already been deleted.

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 delete permissions to trusted users and monitor API usage.

User Experience Guidelines

Confirm processor deletion with the user before making the API call.

Display clear error messages if the processor cannot be deleted.

Code Samples

cURL

Python

Node.js

Related APIs

Get Processor Details: Retrieve metadata and configuration for a specific processor.

List Processors: Fetch a list of all processors in the system.

Create Processor: Add a new processor to the SureParse platform.

Compliance and Legal Considerations

Ensure that processor deletions comply with your organization’s data retention and audit policies. Deleting a processor is irreversible and may impact workflows that depend on it. Always verify authorization and maintain audit logs for all deletion operations.

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

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

Delete Processor

Delete 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

Delete 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