Status

Endpoint Overview

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

Description

This API endpoint allows you to check the status of a vehicle insurance OCR extraction request and retrieve the extracted data. After submitting a vehicle insurance document for OCR processing, you can use this endpoint to poll for results until the processing is complete. The API returns comprehensive details extracted from the insurance document, including policy information, vehicle details, and coverage amounts.

Key Benefits

Track the real-time status of vehicle insurance document processing

Retrieve structured data from insurance documents without manual entry

Access comprehensive vehicle and policy details in a standardized format

Automate insurance verification workflows with reliable data extraction

Use Cases

Insurance

Automotive

Financial Services

Automate policy verification during claims processing

Streamline customer onboarding with automatic document extraction

Validate insurance details 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	JWT Bearer token for authentication. Format: `Bearer YOUR_JWT_TOKEN`
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	Unique client ID received from the document submission endpoint

Example Request

{
    "client_id": "ocr_vehicle_insurance_ukmvplRutiGWpsjHUyeO"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the extracted insurance document data
data.client_id	String	Unique client ID that was sent in the request
data.policy_number	String	Extracted policy number from the insurance document
data.policy_issue_date	String	Date when the policy was issued (YYYY-MM-DD format)
data.policy_start_date	String	Date when the policy coverage begins (YYYY-MM-DD format)
data.policy_end_date	String	Date when the policy coverage expires (YYYY-MM-DD format)
data.insurance_company	String	Name of the insurance company that issued the policy
data.vehicle_number	String	Vehicle registration number
data.vehicle_segment	String	Vehicle segment classification (may be null if not available)
data.make	String	Vehicle manufacturer name
data.model	String	Vehicle model name
data.manufacture_year	Integer	Year when the vehicle was manufactured
data.fuel_type	String	Type of fuel used by the vehicle
data.seating_capacity	String	Number of seats in the vehicle
data.gross_vehicle_weight	String	Gross weight of the vehicle
data.cubic_capacity	String	Engine capacity in cubic centimeters
data.compulsory_personal_accident_cover	String	Personal accident coverage amount
data.no_claim_bonus	String	No claim bonus details (may be null if not available)
data.own_damage	String	Own damage insurance coverage amount
data.third_party	String	Third party insurance coverage amount
data.status	String	Status of the OCR processing (processing, success, or failed)
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the API request was successful
message	String	Human-readable message describing the result
message_code	String	Code representing the message type

Example Successful Response

{
    "data": {
        "client_id": "ocr_vehicle_insurance_ukmvplRutiGWpsjHUyeO",
        "policy_number": "1234/03123456/000/00",
        "policy_issue_date": "2023-03-07",
        "policy_start_date": "2023-03-06",
        "policy_end_date": "2024-03-05",
        "insurance_company": "CHOLAMANDALAM MS GENERAL INSURANCE COMPANY LTD",
        "vehicle_number": "TN-12-AA-3459",
        "vehicle_segment": null,
        "make": "ASHOK LEYLAND",
        "model": "DOST-RLS BSIV",
        "manufacture_year": 2013,
        "fuel_type": "DIESEL",
        "seating_capacity": "2",
        "gross_vehicle_weight": "2435",
        "cubic_capacity": "1478",
        "compulsory_personal_accident_cover": "1,500,000.00",
        "no_claim_bonus": null,
        "own_damage": "4,584.00",
        "third_party": "16,049.00",
        "status": "success"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid Client ID

Processing In Progress

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid client_id provided",
    "message_code": "invalid_client_id"
}

This error occurs when the client_id provided in the request is invalid or does not exist.

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

Use HTTPS for all API communications to ensure data encryption in transit

Implement proper error handling to avoid exposing sensitive information

User Experience Guidelines

Implement a polling strategy with exponential backoff to check document status

Display a progress indicator to users while document processing is in progress

Provide clear error messages to users when document processing fails

Format monetary values appropriately when displaying to end-users

Code Samples

cURL

Python

Node.js

Related APIs

Vehicle Insurance OCR Submit - Allows submission of vehicle insurance documents for OCR processing

Vehicle Insurance Verification - Verifies the authenticity of extracted insurance information

Document OCR Status - General purpose API for checking OCR processing status

Compliance and Legal Considerations

When handling vehicle insurance data, ensure compliance with data protection regulations such as GDPR or local data privacy laws. The extracted data may contain personally identifiable information (PII) that requires proper handling and storage. Implement appropriate data retention policies and obtain necessary user consent before processing insurance documents.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ocr/vehicle-insurance/status' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "ocr_vehicle_insurance_ukmvplRutiGWpsjHUyeO" }'

{ "data": { "client_id": "ocr_vehicle_insurance_ukmvplRutiGWpsjHUyeO", "policy_number": "1234/03123456/000/00", "policy_issue_date": "2023-03-07", "policy_start_date": "2023-03-06", "policy_end_date": "2024-03-05", "insurance_company": "CHOLAMANDALAM MS GENERAL INSURANCE COMPANY LTD", "vehicle_number": "TN-12-AA-3459", "vehicle_segment": null, "make": "ASHOK LEYLAND", "model": "DOST-RLS BSIV", "manufacture_year": 2013, "fuel_type": "DIESEL", "seating_capacity": "2", "gross_vehicle_weight": "2435", "cubic_capacity": "1478", "compulsory_personal_accident_cover": "1,500,000.00", "no_claim_bonus": null, "own_damage": "4,584.00", "third_party": "16,049.00", "status": "success" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Status

Status#

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

Status

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples