Feel free to reach techsupport@surepass.io for any technical support or guidance.
License OCR V2
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
License OCR V2
Description
Key Benefits
Use Cases
Financial Services
Transportation & Logistics
Government & Public Sector
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 Different authentication tokens are used for sandbox and production environments: Sandbox: Production:
1.
2.
3.
Authorization header as Bearer TOKEN.https://sandbox.surepass.iohttps://kyc-api.surepass.ioRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer token authentication using JWT |
| Content-Type | Yes | Must be multipart/form-data for direct image upload or application/json for base64/URL inputs |
Request Body
Method 1: Direct Image Upload
| Parameter | Type | Required | Description |
|---|---|---|---|
| front | Image or PDF | Yes | Front side image of the driver's license |
| back | Image or PDF | Yes | Back side image of the driver's license |
| use_pdf | Text | Optional | Set this parameter to "true" when uploading license documents in PDF format. |
Method 2: Base64 Encoded Images
| Parameter | Type | Required | Description |
|---|---|---|---|
| front_base64 | String | Yes | Base64 encoded string of the front side image |
| back_base64 | String | Yes | Base64 encoded string of the back side image |
Method 3: Image URLs
| Parameter | Type | Required | Description |
|---|---|---|---|
| front_link | String | Yes | URL/link to the front side image of the license |
| back_link | String | Yes | URL/link to the back side image of the license |
Example Request
# Using multipart/form-data
Content-Disposition: form-data; name="front";
filename="front.jpg"
Content-Type: image/jpeg
or
filename="front.pdf"
Content-Type: application/pdf
--boundary
Content-Disposition: form-data; name="back";
filename="back.jpg"
Content-Type: image/jpeg
or
filename="back.pdf"
Content-Type: application/pdf
Process Response
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | Contains the extracted license information |
| data.client_id | String | Unique identifier for the OCR request |
| data.license_number | String | Extracted license number |
| data.dob | String | Date of birth in YYYY-MM-DD format |
| data.address | String | Full address extracted from the license |
| data.name | String | Full name of the license holder |
| status_code | Integer | HTTP status code of the response |
| success | Boolean | Indicates if the request was successful |
| message | String | Additional information or error message (null if successful) |
| message_code | String | Code indicating the status of the request |
Example Successful Response
{
"data": {
"client_id": "ocr_license_v2_peMjfqmmkooUlVNFzhWw",
"license_number": "UP12 20200123456",
"dob": "2000-07-20",
"address": "SOUTH CIVIL LINE, Muzaffarnagar, UP 251001",
"name": "SUDHANSHU"
},
"status_code": 200,
"success": true,
"message": null,
"message_code": "success"
}Possible Error Responses
Authentication Error
Invalid Image
Invalid File Format
Server Error
{
"error": null,
"message": "Your token is invalid. Please ensure that correct token is being used.",
"status_code": 401,
"success": false,
"message_code": "invalid_token"
}Integration Best Practices
Security Recommendations
User Experience Guidelines
Code Samples
cURL
Python
Node.js
Related APIs
Compliance and Legal Considerations
Request
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ocr/license-v2' \
--header 'Authorization: Bearer <token>' \
--form 'front=@""' \
--form 'back=@""' \
--form 'use_pdf="true"'Response Response Example
200 - Image Success
{
"data": {
"client_id": "ocr_license_v2_peMjfqmmkooUlVNFzhWw",
"license_number": "UP12 20200123456",
"dob": "2000-07-20",
"address": "SOUTH CIVIL LINE, Muzaffarnagar, UP 251001",
"name": "SUDHANSHU"
},
"status_code": 200,
"success": true,
"message": null,
"message_code": "success"
}