Introduction
Api Authentication
API Status Codes
Tool API's arrow
arrow Business Card Scanner
arrow Image to Text
arrow Handwriting to Text
arrow JPG to Excel
arrow PDF to Text
arrow Invoice OCR
arrow Passport OCR
arrow ID Card OCR

Introduction

Welcome to the CardScanner.co API, a collection of simple, secure, and high-performance APIs for converting, extracting, and digitizing documents and images.

Each tool on CardScanner.co, such as Image to Text, PDF to Excel, or Passport OCR, has its own dedicated API endpoint, allowing you to integrate only the tools your application actually needs.

Available APIs

Below is a list of all supported APIs you can connect to individually:

OCR / Recognition APIs

  • Business Card scanner
  • Image to Text
  • Handwriting to Text
  • Invoice OCR
  • Passport OCR
  • ID Card OCR
  • Bank Statement Converter

OCR / Recognition APIs

  • Conversion APIs
  • JPG to Word (With OCR)
  • JPG to Excel
  • JPG to PDF
  • PNG to Word
  • PNG to Excel
  • PNG to PDF
  • PDF to Word
  • PDF to Excel
  • PDF to Text
  • Word to PDF
  • Text to PDF
  • PDF to JPG

Data Conversion APIs

  • VCF to CSV
  • VCF to Excel

Each API operates independently with its own endpoint, parameters, and pricing (credit usage).

You can activate and manage access for each API separately from your CardScanner.co User Profile Dashboard.

Typical Workflow

  1. Obtain API Key for the tool you want to use.
  2. Send a POST request to that tool's endpoint with your file and parameters.
  3. Receive a JSON response containing either:
    • The extracted text/data, or
    • A download URL for the converted document.

Best Use Cases

  • Automating document digitization for businesses
  • Bulk OCR processing for scanned files or invoices
  • Integration into CRMs or content-management systems
  • Converting image uploads in your web or mobile app

Authentication

All CardScanner APIs require authentication via an API Key specific to the tool you've subscribed to.

How Authentication Works

  • Each API key is linked to a specific tool, not to the entire suite.
  • You must include your key in the request header as a Bearer Token.

Request Header:

Header Description Required Valid Value
Content-type Set the content type of the request. YES application/json
x-api-key Your API key for authentication YES qwerty

Important Notes

  • Keys are tool-specific e.g. your Image-to-Text key won't work for PDF-to-Excel.
  • Keep your keys confidential; never expose them in client-side code.
  • Each API has its own rate limit (e.g. 100 requests/minute for free tier).
  • Requests without valid authentication will return 401 Unauthorized.

API Status Code

All endpoints return standard HTTP status codes along with a structured JSON body describing the error.

HTTP Code Type Description
200 Success The request was processed successfully. Response will contain the result or download link.
400 Bad Request The request was invalid — usually due to missing parameters, unsupported format, or malformed data.
401 Unauthorized Your API key is missing, invalid, or revoked.
402 Payment Required Your account quota has been exceeded or a paid plan is required.
403 Forbidden The API key is valid, but you do not have permission to access this specific endpoint.
404 Not Found The requested API endpoint or resource doesn’t exist.
405 Method Not Allowed The HTTP method (GET, POST, PUT, DELETE, etc.) used is not supported for this endpoint.
406 Not Acceptable The requested response format or content type is not supported.
409 Conflict The request conflicts with an existing resource — for example, uploading the same file twice or job ID mismatch.
413 File Too Large The uploaded file exceeds the maximum allowed size for this API.
422 Unprocessable Entity The request was well-formed but could not be processed — often due to unreadable content or corrupted files.
429 Too Many Requests Too many requests in a short period. Slow down or upgrade your plan.
500 Internal Server Error Something went wrong on CardScanner’s servers. Retry after a short delay or contact support.

Business Card Scanner

The Business Card Scanner API extracts contact details from business card images with high accuracy. It identifies key fields such as name, company, phone number, email, address, and job title, returning clean, structured data ready for saving or integration into CRM systems.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • result: (json) - Extracted text from image.
Business Card Scanner URL
- POST - {base_url}/api/pro/cardscanner
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "result": "text (json)"
]

Image to Text

The Image to Text API extracts editable text from images using advanced OCR (Optical Character Recognition) technology. It efficiently identifies printed or typed text from various image formats, making it ideal for digitizing scanned documents, screenshots, or photographs.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • result: (json) - Converted text from image.
Image to Text URL
- POST - {base_url}/api/pro/image-to-text
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "result": "text (json)"
]

Handwriting to Text

The Handwriting to Text API converts handwritten notes or documents into digital, editable text. It’s designed to recognize different handwriting styles and is perfect for digitizing written forms, notes, or letters with high accuracy.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
Handwriting to Text URL
- POST - {base_url}/api/pro/handwriting-to-text
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

JPG to Word

The Image to Word API transforms the given image into a fully editable Word document while maintaining the original layout. It is ideal for users who want to convert scanned pages, images, or printed materials into modifiable Word files.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
JPG to Word URL
- POST - {base_url}/api/pro/jpg-to-word
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

JPG to Excel

The Image to Excel API extracts tabular data from the given image and organizes it into structured Excel spreadsheets. It is especially useful for digitizing reports, or data tables captured as images.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • result: (json) - Converted excel file.
JPG to Excel URL
- POST - {base_url}/api/pro/jpg-to-excel
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "result": "file url (json)"
]

JPG to PDF

The Image to PDF API seamlessly converts the given image into a professional-quality PDF file. It supports multi-image merging and maintains the image resolution, making it suitable for archiving, sharing, or printing purposes.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
JPG to PDF URL
- POST - {base_url}/api/pro/jpg-to-pdf
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

PDF to Text

The PDF to Text API extracts raw text from PDF files accurately. It helps users convert PDF content into editable plain text for further processing, search indexing, or text analysis.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
PDF to Text URL
- POST - {base_url}/api/pro/pdf-to-text
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

PDF to Word

The PDF to Word API converts PDF files into editable Word documents while preserving the original formatting, fonts, and structure. It is ideal for users who want to modify or update content from existing PDFs.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
PDF to Word URL
- POST - {base_url}/api/pro/pdf-to-word
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

PDF to Excel

The PDF to Excel API extracts structured data and tables from PDF files and converts them into Excel sheets with complete layout retention. It’s useful for accounting, reporting, and data analysis tasks.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
PDF to Excel URL
- POST - {base_url}/api/pro/pdf-to-excel
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

WORD to PDF

The Word to PDF API converts Word documents into secure, high-quality PDF files. It maintains the formatting, fonts, and design elements, ensuring professional-grade document output.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
WORD to PDF URL
- POST - {base_url}/api/pro/word-to-pdf
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

PDF to JPG

The PDF to JPG API converts each page of a PDF document into high-resolution JPG images. It is useful for users who need image-based versions of PDF files for presentations, websites, or printing.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
PDF to JPG URL
- POST - {base_url}/api/pro/pdf-to-jpg
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

Text to PDF

The Text to PDF API converts plain or formatted text into clean, shareable PDF files. It’s perfect for generating reports, notes, or documents from raw text content.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
Text to PDF URL
- POST - {base_url}/api/pro/text-to-pdf
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

VCF to CSV

The VCF to CSV API converts contact files from VCF (vCard) format into CSV format. It's ideal for users who want to import or analyze contact lists using spreadsheet software.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
VCF to CSV URL
- POST - {base_url}/api/pro/vcf-to-csv
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

VCF to Excel

The VCF to Excel API transforms VCF contact files into structured Excel sheets. It's commonly used for managing, editing, or backing up large contact lists efficiently.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
VCF to Excel URL
- POST - {base_url}/api/pro/vcf-to-excel
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

Invoice OCR

The Invoice OCR API detects and extracts key information from invoices such as vendor name, date, invoice number, product details, and total amount. It simplifies financial data processing and automates record-keeping.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
Invoice OCR URL
- POST - {base_url}/api/pro/invoice-ocr
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

Passport OCR

The Passport OCR API reads and extracts essential details from passport images. It identifies key fields like name, nationality, passport number, and expiry date, making it ideal for verification and identity processing.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
Passport OCR URL
- POST - {base_url}/api/pro/passport-ocr
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

ID Card OCR

The ID Card OCR API recognizes and extracts text from ID card images. It accurately captures personal details such as name, ID number, date of birth, and issuing authority for identity verification purposes.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
ID Card OCR URL
- POST - {base_url}/api/pro/id-card-ocr
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]

Bank Statement Converter

The Bank Statement Converter API extracts and structures financial data from bank statements into Excel or CSV format. It helps automate transaction analysis, reconciliation, and bookkeeping workflows.

Request:

  • Content-Type: multipart/form-data
  • Headers: The request must include an API key in the header for authentication.
  • Body Parameters
  • image_url: (string) - The url of image file to convert in text.
  • file: (object) - The image file to convert in text.
  • Note: You can choose one of above parameters, if both have values than the priority will be image_url.

Response:

The API responds with a JSON object containing the converted text from image.

Response Parameters:

  • status: (integer) - HTTP status code (200 indicates success).
  • text: (string) - Converted text from image.
Bank Statement Converter URL
- POST - {base_url}/api/pro/bank-statement-converter
HTTP Request Header
['x-api-key: create_your_api_key']
HTTP Request Body
[
  "image_url" => "https://example.com/image.jpg",
  "file" => "file (object)"
]
Response
[
  "status": 200,
  "text": "text (string)"
]