Get Document

Endpoint Overview

GET /api/v1/sureparser/get-doc

Description

The Get Document API endpoint retrieves a secure, temporary download URL for a specific document file stored within the Surepass SureParse platform. By providing a valid file_id, clients can programmatically access processed or uploaded documents for review, download, or further processing. This endpoint is essential for integrating document retrieval into automated workflows, supporting audit trails, and enabling seamless document management.

Key Benefits

Securely access and download documents using a temporary, signed URL.

Integrate document retrieval into automated business workflows.

Supports compliance and audit requirements with controlled document access.

Reduces manual effort by enabling programmatic document downloads.

Use Cases

Financial Services

Healthcare

Logistics

Retrieve processed KYC documents for compliance verification.

Download financial statements for audit or reporting purposes.

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
file_id	string	Yes	Unique identifier of the file to retrieve

Example Request

{
  "file_id": "studio_file_ABC123XYZ"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Contains the file download URL
├─ file_url	string	Secure, temporary URL to download the file
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": {
    "file_url": "https://dummy-bucket.s3.amazonaws.com/sample_folder/sample_file_ABC123XYZ/document_1234567890.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=DUMMYCREDENTIAL%2F20251217%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20251217T105604Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=dummysignature"
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

File Not Found

Authentication Error

{
  "data": null,
  "status_code": 404,
  "success": false,
  "message": "File not found",
  "message_code": "file_not_found"
}

The specified file_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.

Ensure that file URLs are only shared with authorized users and expire after use.

User Experience Guidelines

Clearly indicate to users when a file is available for download and when the link will expire.

Handle and display error messages if the file cannot be retrieved.

Code Samples

cURL

Python

Node.js

Related APIs

Get Usage: Retrieve usage statistics for processors or folders.

Execution History (GET): Retrieve a paginated list of all processor execution records.

Processor Status: Get the current status and results of a processor execution.

Compliance and Legal Considerations

Ensure that access to document files complies with your organization’s data privacy and retention policies. Only authorized users should be allowed to download files, and all access should be logged for audit purposes. Temporary URLs should expire after a set period to prevent unauthorized access.

This documentation provides a complete, implementation-focused guide for integrating with the Get Document 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": { "file_url": "https://s3.amazonaws.com/bucket/path/document.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&..." }, "status_code": 200, "message": "Success", "success": true }

Get Document URL

Get Document#

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