📄 Thai Civil Registration Certificate OCR 🆕

📄 แบบรับรองรายการทะเบียนราษฎร

Welcome to the Thai Civil Registration Certificate OCR API, an AI-powered solution developed by iApp Technology Co., Ltd. for extracting data from Thai civil registration documents. This documentation will help you integrate and use our OCR service effectively.

Try Demo!

Example Images (Click to try)

API Key

Demo key is limited to 10 requests per day per IP
Click here to get your API key

Endpoint URL

cURL Command

Upload Civil Registration Certificate

Getting Started

Prerequisites
- An API key from iApp Technology
- Thai civil registration document images
- Supported file formats: JPEG, JPG, PNG, PDF
- Maximum file size: 10MB
Quick Start
- Fast processing (5-10 seconds per document)
- High accuracy text extraction
- Support for multiple file formats
Key Features
- Detailed field extraction including:
  - Personal information (name, ID, gender, nationality)
  - Birth details (date, age)
  - Family information (parents' names and nationalities)
  - Residential details (address, status, registration)
  - Document metadata (dates, remarks, registrar info)
- Support for single-page documents
- Option to return original OCR text and processed images
- Flexible JSON response format
Security & Compliance
- GDPR and PDPA compliant
- Secure API endpoints
- No data retention after processing

How to get API Key?

Please visit API Portal to view your existing API key or request a new one.

Example

Here's a sample civil registration certificate and its extracted data:

Request:

cURL

curl -X POST https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file \
-H apikey: YOUR_API_KEY \
-F file=@/path/to/document.jpg \
-F return_image=false \
-F return_ocr=false

Response:

{
    "message": "success",
    "processed": {
        "header": "(ท้องถิ่นเขตยานนาวา) ท.ร. 14/1",
        "title": "แบบรับรองรายการทะเบียนราษฎร จากฐานข้อมูลการทะเบียน\nสำนักทะเบียนกลาง กรมการปกครอง กระทรวงมหาดไทย",
        "nationalIdNumber": "X-XXXX-XXXXX-XX-X",
        "houseRegistrationNumber": "XXXX-XXXXXX-X",
        "name": "นายสXXXXX XXXXXXXXXXX",
        "gender": "ชาย",
        "nationality": "ไทย",
        "dateOfBirth": "8 XXXXXXX 2498",
        "age": 64,
        "residentialStatus": "เจ้าบ้าน",
        "mothersName": "XXXXX",
        "mothersNationality": "จีน",
        "fathersName": "XXXXX",
        "fathersNationality": "จีน",
        "address": "XXX XXXXXXX XXX แขวงตลิ่งชัน เขตตลิ่งชัน กรุงเทพมหานคร",
        "registrationOffice": "ท้องถิ่นเขตตลิ่งชัน",
        "moveInDate": "28 เดือน XXXXXXX พ.ศ. 2537",
        "additionalNotes": "บุคคลนี้ถูกจำหน่ายชื่อจากทะเบียนบ้านเนื่องจากตาย เมื่อ 14 XXXXXXXX 2562",
        "remarks": "คัดรับรองตามคำร้องที่ ๗๙๐๘/๒๕๖๗ ลงวันที่ ๒ กันยายน ๒๕๖๗",
        "lastUpdated": "วันที่ 2 เดือน กันยายน พ.ศ. 2567",
        "footer": {
            "text": "รับรองว่าเป็นรายการจากฐานข้อมูลการทะเบียนราษฎร",
            "date": "2 เดือน กันยายน พ.ศ. 2567",
            "registrar": "นายอิทธิพัทธ์ เล็กชลยุทธ"
        }
    },
    "process_ms": 8115
}

Features & Capabilities

Core Features

Document Processing
- High accuracy text extraction and field recognition
- Thai language supported
- Printed document format supported
- Fast processing time of 5-10 seconds per document
- Multi-format support (JPEG, JPG, PNG, PDF)
- Single-page document handling
- Option to return original OCR text and processed images
- GDPR and PDPA compliant processing
Data Extraction
- Flexible JSON response format with detailed field extraction

Supported Fields

Field	Type	Description
header	String	Document type and form number
title	String	Official document title
nationalIdNumber	String	13-digit Thai national ID number
houseRegistrationNumber	String	House registration code
name	String	Full name of the person
gender	String	Gender of the person
nationality	String	Nationality of the person
dateOfBirth	String	Date of birth in Thai format
age	Number	Current age
residentialStatus	String	Status in the household
mothersName	String	Mother's full name
mothersNationality	String	Mother's nationality
fathersName	String	Father's full name
fathersNationality	String	Father's nationality
address	String	Current residential address
registrationOffice	String	Name of registration office
moveInDate	String	Date of moving to current address
additionalNotes	String	Additional information
remarks	String	Official remarks
lastUpdated	String	Last update date
footer	Object	Contains certification text, date and registrar info

API Reference

Recognizing Civil Registration Certificate

There are two endpoints available for processing civil registration certificates:

1. File Upload

POST https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file

Request Headers

Name	Type	Required	Description
apikey	string	Yes	Your API key

Request Body (multipart/form-data)

Parameter	Type	Required	Description
file	file	Yes	Document image (JPEG, PNG) or PDF document
return_image	boolean	No	Include base64 encoded image in response (default: false)
return_ocr	boolean	No	Include raw OCR text in response (default: false)

Response Format

{
    "message": "success",
    "raw": {
        "image": "string", // Base64 encoded, only if return_image=true
        "text": "string" // Only if return_ocr=true
    },
    "processed": {
        "header": "string",
        "title": "string",
        "nationalIdNumber": "string",
        "houseRegistrationNumber": "string",
        "name": "string",
        "gender": "string",
        "nationality": "string",
        "dateOfBirth": "string",
        "age": "number",
        "residentialStatus": "string",
        "mothersName": "string",
        "mothersNationality": "string",
        "fathersName": "string",
        "fathersNationality": "string",
        "address": "string",
        "registrationOffice": "string",
        "moveInDate": "string",
        "additionalNotes": "string",
        "remarks": "string",
        "lastUpdated": "string",
        "footer": {
            "text": "string",
            "date": "string",
            "registrar": "string"
        }
    },
    "process_ms": "number"
}

Error Handling

Status	Code	Description
400	BAD_REQUEST	Invalid parameters or file format
401	UNAUTHORIZED	Invalid or missing API key
404	NOT_FOUND	Invalid endpoint
500	INTERNAL_SERVER_ERROR	Processing failed

2. Base64 Image

POST https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64

Request Headers

Name	Type	Required	Description
apikey	string	Yes	Your API key

Request Body

You can send the base64 data either as JSON or form data:

JSON Format:

{
    "base64_string": "string", // Base64 encoded image data
    "return_image": false, // Optional
    "return_ocr": false // Optional
}

Form Data Format:

Parameter	Type	Required	Description
base64_string	string	Yes	Base64 encoded image data
return_image	boolean	No	Include base64 encoded image in response (default: false)
return_ocr	boolean	No	Include raw OCR text in response (default: false)

Response Format

Same as file upload endpoint

Code Examples

Python (File Upload)

import requests
apiKey = 'YOUR_API_KEY'
filePath = '/path/to/civil-registeration-certificate.jpg'
url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file"

headers = {'apikey': apiKey}
files = {'file': ('civil-registeration-certificate.jpg', open(filePath, 'rb'), 'image/jpeg')}
data = {'return_image': 'false', 'return_ocr': 'false'}

response = requests.post(url, headers=headers, files=files, data=data)
print(response.json())

Python (Base64)

import requests
import base64

apiKey = 'YOUR_API_KEY'
filePath = '/path/to/civil-registeration-certificate.jpg'
url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64"

# Read image file and convert to base64
with open(filePath, 'rb') as image_file:
    base64_string = base64.b64encode(image_file.read()).decode()

headers = {
    'apikey': apiKey,
    'Content-Type': 'application/json'
}

data = {
    'base64_string': base64_string,
    'return_image': False,
    'return_ocr': False
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

Javascript (File Upload)

const axios = require("axios")
const FormData = require("form-data")
const fs = require("fs")

const apiKey = "YOUR_API_KEY"
const filePath = "/path/to/civil-registeration-certificate.jpg"
const url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file"

const form = new FormData()
form.append("file", fs.createReadStream(filePath))
form.append("return_image", "false")
form.append("return_ocr", "false")

try {
    const response = await axios.post(url, form, {
        headers: {
            ...form.getHeaders(),
            apikey: apiKey,
        },
    })
    return response.data
} catch (error) {
    throw error
}

Javascript (Base64)

const axios = require("axios")
const fs = require("fs")

const apiKey = "YOUR_API_KEY"
const filePath = "/path/to/civil-registeration-certificate.jpg"
const url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64"

// Read image file and convert to base64
const base64String = fs.readFileSync(filePath, { encoding: "base64" })

const data = {
    base64_string: base64String,
    return_image: false,
    return_ocr: false,
}

try {
    const response = await axios.post(url, data, {
        headers: {
            "Content-Type": "application/json",
            apikey: apiKey,
        },
    })
    return response.data
} catch (error) {
    throw error
}

PHP (File Upload)

$url = 'https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file';
$apiKey = 'YOUR_API_KEY';
$filePath = '/path/to/civil-registeration-certificate.jpg';

$headers = array(
    'apikey: ' . $apiKey
);

$postFields = array(
    'file' => new CURLFile($filePath),
    'return_image' => 'false',
    'return_ocr' => 'false'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

PHP (Base64)

$url = 'https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64';
$apiKey = 'YOUR_API_KEY';
$filePath = '/path/to/civil-registeration-certificate.jpg';

// Read image file and convert to base64
$base64String = base64_encode(file_get_contents($filePath));

$data = array(
    'base64_string' => $base64String,
    'return_image' => false,
    'return_ocr' => false
);

$headers = array(
    'Content-Type: application/json',
    'apikey: ' . $apiKey
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Swift (File Upload)

import Foundation

let url = URL(string: "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file")!
let filePath = "/path/to/civil-registeration-certificate.jpg"
let apiKey = "YOUR_API_KEY"

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue(apiKey, forHTTPHeaderField: "apikey")

let boundary = UUID().uuidString
request.setValue("multipart/form-data; boundary=\(boundary)", forHTTPHeaderField: "Content-Type")

var body = Data()
body.append("--\(boundary)\r\n".data(using: .utf8)!)
body.append("Content-Disposition: form-data; name=\"file\"; filename=\"civil-registeration-certificate.jpg\"\r\n".data(using: .utf8)!)
body.append("Content-Type: image/jpeg\r\n\r\n".data(using: .utf8)!)
body.append(try! Data(contentsOf: URL(fileURLWithPath: filePath)))
body.append("\r\n--\(boundary)\r\n".data(using: .utf8)!)
body.append("Content-Disposition: form-data; name=\"return_image\"\r\n\r\nfalse\r\n".data(using: .utf8)!)
body.append("--\(boundary)\r\n".data(using: .utf8)!)
body.append("Content-Disposition: form-data; name=\"return_ocr\"\r\n\r\nfalse\r\n".data(using: .utf8)!)
body.append("--\(boundary)--\r\n".data(using: .utf8)!)

request.httpBody = body

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print("Error: \(error?.localizedDescription ?? "Unknown error")")
        return
    }
    print(String(data: data, encoding: .utf8)!)
}

task.resume()

Swift (Base64)

import Foundation

let url = URL(string: "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64")!
let filePath = "/path/to/civil-registeration-certificate.jpg"
let apiKey = "YOUR_API_KEY"

// Read image file and convert to base64
guard let imageData = try? Data(contentsOf: URL(fileURLWithPath: filePath)) else {
    print("Error reading file")
    return
}
let base64String = imageData.base64EncodedString()

let parameters: [String: Any] = [
    "base64_string": base64String,
    "return_image": false,
    "return_ocr": false
]

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue(apiKey, forHTTPHeaderField: "apikey")
request.httpBody = try? JSONSerialization.data(withJSONObject: parameters)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print("Error: \(error?.localizedDescription ?? "Unknown error")")
        return
    }
    print(String(data: data, encoding: .utf8)!)
}

task.resume()

Kotlin (File Upload)

import okhttp3.*
import java.io.File

val client = OkHttpClient()
val apiKey = "YOUR_API_KEY"
val filePath = "/path/to/civil-registeration-certificate.jpg"
val url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file"

val file = File(filePath)
val requestBody = MultipartBody.Builder()
    .setType(MultipartBody.FORM)
    .addFormDataPart("file", file.name, RequestBody.create(MediaType.parse("image/jpeg"), file))
    .addFormDataPart("return_image", "false")
    .addFormDataPart("return_ocr", "false")
    .build()

val request = Request.Builder()
    .url(url)
    .post(requestBody)
    .addHeader("apikey", apiKey)
    .build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        e.printStackTrace()
    }

    override fun onResponse(call: Call, response: Response) {
        response.use {
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body()?.string())
        }
    }
})

Kotlin (Base64)

import okhttp3.*
import java.io.File
import android.util.Base64
import org.json.JSONObject

fun processBase64Image() {
    val client = OkHttpClient()
    val apiKey = "YOUR_API_KEY"
    val filePath = "/path/to/civil-registeration-certificate.jpg"
    val url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64"

    // Read file and convert to base64
    val file = File(filePath)
    val bytes = file.readBytes()
    val base64String = Base64.encodeToString(bytes, Base64.DEFAULT)

    val json = JSONObject()
    json.put("base64_string", base64String)
    json.put("return_image", false)
    json.put("return_ocr", false)

    val requestBody = RequestBody.create(
        MediaType.parse("application/json"),
        json.toString()
    )

    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Content-Type", "application/json")
        .addHeader("apikey", apiKey)
        .build()

    client.newCall(request).enqueue(object : Callback {
        override fun onFailure(call: Call, e: IOException) {
            e.printStackTrace()
        }

        override fun onResponse(call: Call, response: Response) {
            response.use {
                if (!response.isSuccessful) throw IOException("Unexpected code $response")
                println(response.body()?.string())
            }
        }
    })
}

Java (File Upload)

import okhttp3.*;
import java.io.File;
import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        String apiKey = "YOUR_API_KEY";
        String url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file";
        String filePath = "/path/to/civil-registeration-certificate.jpg";

        File file = new File(filePath);
        RequestBody requestBody = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            .addFormDataPart("file", file.getName(), RequestBody.create(MediaType.parse("image/jpeg"), file))
            .addFormDataPart("return_image", "false")
            .addFormDataPart("return_ocr", "false")
            .build();

        Request request = new Request.Builder()
            .url(url)
            .post(requestBody)
            .addHeader("apikey", apiKey)
            .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
                System.out.println(response.body().string());
            }
        });
    }
}

Java (Base64)

import okhttp3.*;
import java.io.File;
import java.io.IOException;
import java.util.Base64;
import java.nio.file.Files;
import org.json.JSONObject;

public class Main {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        String apiKey = "YOUR_API_KEY";
        String url = "https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64";
        String filePath = "/path/to/civil-registeration-certificate.jpg";

        try {
            // Read file and convert to base64
            byte[] fileContent = Files.readAllBytes(new File(filePath).toPath());
            String base64String = Base64.getEncoder().encodeToString(fileContent);

            JSONObject json = new JSONObject();
            json.put("base64_string", base64String);
            json.put("return_image", false);
            json.put("return_ocr", false);

            RequestBody requestBody = RequestBody.create(
                MediaType.parse("application/json"),
                json.toString()
            );

            Request request = new Request.Builder()
                .url(url)
                .post(requestBody)
                .addHeader("Content-Type", "application/json")
                .addHeader("apikey", apiKey)
                .build();

            client.newCall(request).enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    e.printStackTrace();
                }

                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
                    System.out.println(response.body().string());
                }
            });
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Dart (File Upload)

import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;

String url = 'https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file';
String filePath = '/path/to/civil-registeration-certificate.jpg';
String apiKey = 'YOUR_API_KEY';

void main() async {
    var url = Uri.parse(url);
    var request = http.MultipartRequest('POST', url)
        ..headers['apikey'] = apiKey
        ..files.add(await http.MultipartFile.fromPath('file', filePath))
        ..fields['return_image'] = 'false'
        ..fields['return_ocr'] = 'false';

    var response = await request.send();

    if (response.statusCode == 200) {
        var responseData = await response.stream.bytesToString();
        print(responseData);
    } else {
        print('Error: ${response.statusCode}');
    }
}

Dart (Base64)

import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;

String url = 'https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/base64';
String filePath = '/path/to/civil-registeration-certificate.jpg';
String apiKey = 'YOUR_API_KEY';

void main() async {
    var url = Uri.parse(url);
    var request = http.MultipartRequest('POST', url)
        ..headers['apikey'] = apiKey
        ..fields['return_image'] = 'false'
        ..fields['return_ocr'] = 'false';

    // Read image file and convert to base64
    File file = File(filePath);
    List<int> fileBytes = await file.readAsBytes();
    String base64String = base64Encode(fileBytes);

    request.fields['base64_string'] = base64String;

    var response = await request.send();

    if (response.statusCode == 200) {
        var responseData = await response.stream.bytesToString();
        print(responseData);
    } else {
        print('Error: ${response.statusCode}');
    }
}

Limitations & Best Practices

Limitations

Maximum file size: 10MB
Supported language: Thai
PDF files: Single page only
Rate limit: 10 requests per second per API key

Best Practices

Ensure good image quality for optimal results
Use JPEG or PNG format for images
Implement error handling for failed requests
Cache responses when processing the same document multiple times
Set appropriate timeouts for large files

Accuracy & Performance

Overall Accuracy

Based on our benchmark dataset of 1,000 Thai civil registration certificates:

Field Type	Accuracy (%)	Notes
ID Numbers	99.5%	National ID and house registration numbers
Names	99.2%	Person and parent names
Dates	98.7%	Birth dates and registration dates
Addresses	97.8%	Full address details
Overall	98.8%	Weighted average

Processing Speed

Average processing time: 5-10 seconds
95th percentile: 12 seconds
Maximum processing time: 15 seconds

Factors Affecting Accuracy

Image Quality
- Resolution (minimum 300 DPI recommended)
- Lighting conditions
- Image focus and clarity
Document Condition
- Physical damage
- Fading or wear
- Handwritten modifications
Document Format
- Standard formats: 99%+ accuracy
- Non-standard layouts: 95%+ accuracy
- Handwritten elements: 90%+ accuracy

History

Our model is continuously trained on new data to improve accuracy:

Version	Release Date	Accuracy	Key Improvements
3.0	2024-12-27	96.5%	Base version

Pricing

AI API Service Name	Pricing	On-Premise
Thai Civil Registration Certificate OCR	1 IC/Page	Contact

Try Demo!​

Example Images (Click to try)

Getting Started​

Example​

Request:​

Response:​

Features & Capabilities​

Core Features​

Supported Fields​

API Reference​

Recognizing Civil Registration Certificate​

1. File Upload​

Request Headers​

Request Body (multipart/form-data)​

Response Format​

Error Handling​

2. Base64 Image​

Request Headers​

Request Body​

Response Format​

Code Examples​

Python (File Upload)​

Python (Base64)​

Javascript (File Upload)​

Javascript (Base64)​

PHP (File Upload)​

PHP (Base64)​

Swift (File Upload)​

Swift (Base64)​

Kotlin (File Upload)​

Kotlin (Base64)​

Java (File Upload)​

Java (Base64)​

Dart (File Upload)​

Dart (Base64)​

Limitations & Best Practices​

Limitations​

Best Practices​

Accuracy & Performance​

Overall Accuracy​

Processing Speed​

Factors Affecting Accuracy​

History​

Pricing​

Try Demo!

Getting Started

Example

Request:

Response:

Features & Capabilities

Core Features

Supported Fields

API Reference

Recognizing Civil Registration Certificate

1. File Upload

Request Headers

Request Body (multipart/form-data)

Response Format

Error Handling

2. Base64 Image

Request Headers

Request Body

Response Format

Code Examples

Python (File Upload)

Python (Base64)

Javascript (File Upload)

Javascript (Base64)

PHP (File Upload)

PHP (Base64)

Swift (File Upload)

Swift (Base64)

Kotlin (File Upload)

Kotlin (Base64)

Java (File Upload)

Java (Base64)

Dart (File Upload)

Dart (Base64)

Limitations & Best Practices

Limitations

Best Practices

Accuracy & Performance

Overall Accuracy

Processing Speed

Factors Affecting Accuracy

History

Pricing