Get Processor Details

Endpoint Overview

POST /api/v1/sureparser/get-processor

Description

The Get Processor Details API endpoint retrieves comprehensive information about a specific processor configured within the Surepass SureParse platform. By providing a processor ID, clients can fetch metadata and configuration details such as processor name, type, associated file, categories, context, and creation timestamp. This endpoint is essential for applications that need to programmatically access processor configurations for document parsing, workflow automation, or audit purposes.

Key Benefits

Instantly retrieve all configuration details for any processor by ID.

Enables dynamic integration with document processing workflows.

Supports audit, monitoring, and troubleshooting of processor setups.

Facilitates seamless automation and orchestration of document parsing tasks.

Use Cases

Financial Services

Healthcare

Logistics

Retrieve processor details for KYC document verification workflows.

Audit processor configurations for compliance and reporting.

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

Example Request

{
  "processor_id": "studio_processor_ZsyAumAbqPrniLzjjzUP"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Contains processor details and metadata
└─ data	object	Processor configuration details
├─ processor_id	string	Unique identifier of the processor
├─ processor_name	string	Name of the processor
├─ file_id	string	Associated file identifier
├─ 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	Folder identifier (nullable)
├─ created_at	string	ISO timestamp of processor creation
status_code	integer	HTTP status code (e.g., 200 for success)
success	boolean	Indicates if the request was successful
message	string	Human-readable status message
message_code	string	Machine-readable status code

Example Successful Response

{
  "data": {
    "data": {
      "processor_id": "studio_processor_ZsyAumAbqPrniLzjjzUP",
      "processor_name": "updateed testing",
      "file_id": "studio_file_lyoWkhcQyExjuhhzcqof",
      "filename": "Pan_and_Aadhar_in_Same_PDF.pdf",
      "processor_type": "splitter",
      "categories": [
        {
          "type": "passport",
          "description": ""
        }
      ],
      "context": "Updated context for processing",
      "folder_id": null,
      "created_at": "2025-12-18T07:31:16.906000"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
  }
}

Possible Error Responses

Invalid Processor ID

Authentication Error

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

The provided processor_id does not exist or is invalid.

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 API access to trusted IPs and monitor usage for anomalies.

User Experience Guidelines

Validate processor_id before making requests to avoid unnecessary errors.

Display clear error messages to users when processor details cannot be fetched.

Code Samples

cURL

Python

Node.js

Related APIs

Get File Details: Retrieve metadata and status for a specific file.

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

Update Processor: Modify configuration details of an existing processor.

Compliance and Legal Considerations

Ensure all API usage complies with local data protection and privacy regulations. Do not expose sensitive processor or file information to unauthorized users. Audit API access and usage regularly for compliance.

This documentation provides a complete, implementation-focused guide for integrating with the Get Processor Details 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 ********************

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

Get Processor

Get Processor Details#

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