Thai Civil Registration Certificate OCR

Reads a Thai civil registration certificate (ท.ร. 14/1) and returns the person, parents, address and registrar's certification, with a confidence per field.

POST/ocr/v3/civil-registeration-certificate/file

+1 endpoints

Try it

• Price1 ICper page
• Served18.8Kcalls

• v3.0
• Active

Input

OutputPOST /ocr/v3/civil-registeration-certificate/file

header

(ท้องถิ่นเขตยานนาวา) ท.ร. 14/1

nationalIdNumber

X-XXXX-XXXXX-XX-X

houseRegistrationNumber

XXXX-XXXXXX-X

name

นายสXXXXX XXXXXXXXXXX

gender

ชาย

nationality

ไทย

dateOfBirth

8 XXXXXXX 2498

age

64

residentialStatus

เจ้าบ้าน

address

XXX XXXXXXX XXX แขวงตลิ่งชัน เขตตลิ่งชัน กรุงเทพมหานคร

registrationOffice

ท้องถิ่นเขตตลิ่งชัน

footer

text: รับรองว่าเป็นรายการจากฐานข้อมูลการทะเบียนราษฎร date: 2 เดือน กันยายน พ.ศ. 2567 registrar: นายXXXXX XXXXXXX

Every field, under ResponseOther endpoints: /civil-registeration-certificate see Request

Request

curl -X POST https://api.iapp.co.th/ocr/v3/civil-registeration-certificate/file \
  -H "apikey: YOUR_API_KEY" \
  -F "file=@certificate.jpg"

Response

200OK. The fields are explained under Response.

{
  "message": "success",
  "processed": {
    "header": "(ท้องถิ่นเขตยานนาวา) ท.ร. 14/1",
    "nationalIdNumber": "X-XXXX-XXXXX-XX-X",
    "houseRegistrationNumber": "XXXX-XXXXXX-X",
    "name": "นายสXXXXX XXXXXXXXXXX",
    "gender": "ชาย",
    "nationality": "ไทย",
    "dateOfBirth": "8 XXXXXXX 2498",
    "age": 64,
    "residentialStatus": "เจ้าบ้าน",
    "address": "XXX XXXXXXX XXX แขวงตลิ่งชัน เขตตลิ่งชัน กรุงเทพมหานคร",
    "registrationOffice": "ท้องถิ่นเขตตลิ่งชัน",
    "footer": { "text": "รับรองว่าเป็นรายการจากฐานข้อมูลการทะเบียนราษฎร",
                "date": "2 เดือน กันยายน พ.ศ. 2567", "registrar": "นายXXXXX XXXXXXX" }
  },
  "confidence": { "nationalIdNumber": 0.95, "name": 0.95, "dateOfBirth": 0.9, "address": 0.95 }
}

Request

multipart/form-data to /file. 1 IC per page; a PDF must be a single page.

Headers

apikeystringrequired

Your API key, created under API Keys in the control panel.

Body

filefilerequired

The certificate. JPEG, PNG or PDF, up to 10 MB.

return_imageboolean

true to get the processed image back as Base64.

return_ocrboolean

true to include the raw OCR text.

Endpoint	Takes
/ocr/v3/civil-registeration-certificate/file	The file

The same service also answers at /v3/store/ocr/civil-registeration-certificate.

Response

With return_ocr set to true, the response also carries raw, the OCR text.

processedobject

The fields read from the document

processed.headerprocessed.title

The form number and the document's title

processed.nationalIdNumberprocessed.houseRegistrationNumber

The 13-digit national ID and the house registration code

processed.nameprocessed.genderprocessed.nationalityprocessed.dateOfBirthprocessed.age

The person

processed.residentialStatusstring

The person's status in the household

processed.mothersNameprocessed.mothersNationalityprocessed.fathersNameprocessed.fathersNationality

The parents

processed.addressprocessed.registrationOfficeprocessed.moveInDate

The address, the office that registered it, and when the person moved in

processed.additionalNotesprocessed.remarksprocessed.lastUpdated

Notes, official remarks, and the last update

processed.footerobject

The certification

processed.footer.textstring

processed.footer.datestring

processed.footer.registrarstring

messagestring

Status message

confidenceobject

Confidence per field, 0 to 1

Status codes

Code	Meaning
400	Invalid parameters or file format
404	Unknown endpoint
500	Processing failed

Details

Measured

On a benchmark of 1,000 Thai civil registration certificates.

Measure	Result
ID numbers	99.5%
Names	99.2%
Dates	98.7%
Addresses	97.8%
All fields	98.8%
Time per document	5–10 s typical, 12 s at the 95th percentile, 15 s at most

Standard layouts read at 99% or better, non-standard layouts at 95% or better, handwritten parts at 90% or better.

Limits

• 10 requests per second per API key.
• Accuracy drops below 300 dpi, in poor light, and on damaged, faded or hand-amended copies.

Data handling

The service is GDPR and PDPA compliant.

Changelog

Version	Date	Changes
3.0	27 Dec 2024	First release.