Processor Status

Endpoint Overview

GET /api/v1/sureparser/processor-status

Description

The Processor Status API endpoint allows you to retrieve the current status and results of a specific processor execution in the Surepass SureParse platform. By providing a valid processor_id, you can monitor the progress, completion, and output of document parsing or transformation jobs. This endpoint is essential for tracking processor activity, accessing extracted data, and integrating SureParse results into your business workflows.

Key Benefits

Real-time monitoring of processor execution status and results.

Access to detailed output data, including extracted fields from processed documents.

Supports robust integration with business automation and reporting systems.

Facilitates error handling and troubleshooting by exposing execution metadata and error messages.

Use Cases

Financial Services

Healthcare

Logistics

Track the status of KYC document parsing for compliance and onboarding.

Retrieve extracted data from processed financial documents for 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	No	Optional for GET requests

Query Parameters

Parameter	Type	Required	Description
processor_id	string	Yes	Unique identifier of the processor to check status. This value is obtained from the create-processor API.

Example Request

{
  "processor_id": "studio_processor_ABC123XYZ"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Contains execution and result details
├─ client_id	string	Unique identifier for the execution instance
├─ processor_id	string	Identifier of the processor used
├─ processor_name	string	Name of the processor
├─ file_id	string	Identifier of the associated file
├─ filename	string	Name of the file processed
├─ processor_type	string	Type of processor (e.g., splitter)
├─ status	string	Current status of the execution (e.g., "completed")
├─ created_at	string	ISO timestamp of execution creation
├─ updated_at	string	ISO timestamp of last update
├─ total_documents	integer	Number of documents processed
├─ total_pages	integer	Number of pages processed
├─ result_data	object	Parsed results, including extracted fields
├─ error_message	string	Error message if execution failed (nullable)
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": {
    "client_id": "studio_executor_XYZ987LMN",
    "processor_id": "studio_processor_ABC123XYZ",
    "processor_name": "Sample Processor",
    "file_id": "studio_file_DEF456GHI",
    "filename": "Sample_Document.pdf",
    "processor_type": "splitter",
    "status": "completed",
    "created_at": "2025-12-17T10:00:00.000000",
    "updated_at": "2025-12-17T10:01:00.000000",
    "total_documents": 2,
    "total_pages": 3,
    "result_data": {
      "documents": [
        {
          "start_page": 1,
          "end_page": 2,
          "identifier": "sample_id",
          "category": "sample_category",
          "fields": {
            "Field1": "Value1",
            "Field2": "Value2"
          }
        }
      ]
    },
    "error_message": null
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Processor Not Found

Authentication Error

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

The specified 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 access to processor status and results to authorized users only.

User Experience Guidelines

Display processor status and parsed results clearly to users.

Handle and display error messages if processor status cannot be fetched.

Code Samples

cURL

Python

Node.js

Related APIs

Create Processor: Define a new processor for document parsing.

Execute Processor: Initiate a processor execution and obtain a client_id.

Fetch Execution Details: Retrieve the status and results of a specific execution.

Compliance and Legal Considerations

Ensure that access to processor status and results complies with your organization’s data privacy and retention policies. Only authorized users should be allowed to view sensitive parsed data, and all access should be logged for audit purposes.

This documentation provides a complete, implementation-focused guide for integrating with the Processor Status 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": { "client_id": "processor_executorABCDEFGHIJKLMNO", "processor_id": "processor_configABCDEFGHIJKLMNOPQ", "processor_name": "Invoice Processor", "file_id": "fileABCDEFGHIJKLMNOPQRSTU", "filename": "sample.pdf", "processor_type": "splitter", "status": "completed", "created_at": "2024-12-13T12:00:00.000000", "updated_at": "2024-12-13T12:01:30.000000", "total_documents": 3, "total_pages": 10, "result_data": { "documents": [] }, "error_message": null }, "status_code": 200, "message": "Success", "success": true }

Get Processor Status

Processor Status#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Query Parameters#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses