FreeXtract API Documentation

Learn how to integrate FreeXtract API into your application effortlessly.

1. API Endpoint

POST https://docubits.in/api/freextract/PerformOcr

2. Authentication

Pass your API key as a query parameter:

https://docubits.in/api/freextract/PerformOcr?Token=YOUR_API_KEY_HERE

3. Request Parameters

4. Example Request

JavaScript (Fetch API)

const formData = new FormData();
formData.append("front", document.querySelector("#frontFile").files[0]);
formData.append("back", document.querySelector("#backFile").files[0]); // optional

const token = "YOUR_API_KEY_HERE";
const url = `https://docubits.in/api/freextract/PerformOcr?Token=${token}`;

fetch(url, { method: "POST", body: formData })
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error(err));
        
C# (.NET HttpClient)

using var client = new HttpClient();
var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead("front.jpg")), "front", "front.jpg");
form.Add(new StreamContent(File.OpenRead("back.jpg")), "back", "back.jpg"); // optional

var token = "YOUR_API_KEY_HERE";
var response = await client.PostAsync($"https://docubits.in/api/freextract/PerformOcr?Token={token}", form);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
        
cURL

curl -X POST "https://docubits.in/api/freextract/PerformOcr?Token=YOUR_API_KEY_HERE" \
-F "front=front.jpg" \
-F "back=back.jpg"
        

5. Example Response

{
  "Name": "Rajat",
  "Mobile": "",
  "Address": "C/O Alex Singh, post pindvada,\nIndravali , Lalgate,\nUttar Pradesh - 247341",
  "Document Number": "1234 1234 1234",
  "Document Type": "AADHAAR",
  "DOB": "1997-02-26"
}
Need an API key? Click here to generate yours.