Submit

Endpoint Overview

POST /api/v1/ocr/vehicle-insurance/submit

Description

This API endpoint allows you to submit a vehicle insurance policy certificate for OCR (Optical Character Recognition) processing. The service extracts relevant information from the uploaded insurance document, processes it, and returns a unique client ID that can be used to track the status of the processing. This automated document processing eliminates manual data entry, reduces errors, and accelerates verification workflows.

Key Benefits

Automated extraction of vehicle insurance details from policy certificates

Reduced processing time compared to manual data entry

Higher accuracy in data extraction with advanced OCR technology

Simplified document verification workflow with status tracking

Use Cases

Insurance

Automotive

Financial Services

Streamline customer onboarding by automatically extracting policy details

Verify insurance coverage during claims processing

Validate policy information during policy renewals

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

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication (JWT format)
Content-Type	Yes	Must be set to `multipart/form-data` for file upload

Request Body

Parameter	Type	Required	Description
file	PDF	Yes	Vehicle Insurance Policy Certificate to be processed via OCR

Example Request

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the response data
data.client_id	String	Unique identifier for tracking the OCR request
data.status	String Enum	Current status of the certificate processing
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Human-readable description of the response
message_code	String	Code indicating the type of response message

Status Values

processing: Document is currently being processed

success: Document was successfully processed

failed: Document processing failed

Example Successful Response

{
    "data": {
        "client_id": "ocr_vehicle_insurance_mfgqMpFKmzkqzCiMsXvY",
        "status": "processing"
    },
    "status_code": 200,
    "success": true,
    "message": "Request Successfully Submitted",
    "message_code": "success"
}

Possible Error Responses

Invalid File Format

Authentication Error

{
    "data": null,
    "status_code": 400,
    "success": false,
    "message": "Invalid file format. Only PDF files are supported.",
    "message_code": "invalid_file_format"
}

The uploaded file is not in PDF format. Please ensure you're uploading a valid PDF document.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement token refresh mechanisms to handle token expiration

Validate the file type and size before uploading to prevent security issues

Implement proper error handling for failed API requests

User Experience Guidelines

Provide clear feedback to users while the document is being processed

Implement a status checking mechanism to poll for updates on processing status

Display helpful error messages when document processing fails

Consider implementing a retry mechanism for failed uploads

Code Samples

cURL

Python

Node.js

Related APIs

OCR Vehicle Registration Certificate: Extract information from vehicle registration documents

OCR Driving License: Process and extract data from driving licenses

OCR Vehicle Insurance Status: Check the current status of a previously submitted insurance document

Compliance and Legal Considerations

When processing insurance documents, ensure you have proper consent from users to handle their personal and insurance information. The data extracted may be subject to data protection regulations such as GDPR or other local privacy laws. Ensure your application's privacy policy clearly communicates how this data is used and stored.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "data": { "client_id": "ocr_vehicle_insurance_mfgqMpFKmzkqzCiMsXvY", "status": "processing" }, "status_code": 200, "success": true, "message": "Request Successfully Submitted", "message_code": "success" }

Submit

Submit#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Status Values#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Submit

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Status Values

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples