Thailand ID Card OCR

id number + name recognition

Code example:

curl --location --request POST 'https://api.ekycpro.com/v1/th_ocr/general' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Response for recognition success

{
  "status": "OK",
  "message": {
    "cardTypeTh": "บัตรประจำตัวประชาชน",
    "cardTypeEn": "Thai National ID Card",
    "idNumber": "1842356782169",
    "serialNumber": "8407-03-22251350",
    "nameTh": "น.ส.  พรนภา ยิ่งเภตรา",
    "nameEn": "Miss. Ponnapa",
    "lastNameEn": "Yinthpetra",
    "birthTh": "29 ม.ค. 2540",
    "birthEn": "29 Jan. 1997",
    "issueDateEN": "12 Apr. 2017",
    "issueDateTH": "12 เม.ย. 2560",
    "expiryDateEN": "22 Jun. 2025",
    "expiryDateTH": "22 มิ.ย. 2568",
    "religion": "พุทธ",
    "address": "ที่อยู่ 125 หมู่ที่ 7 ต.ช้างขวา อ.กาญจนดิษฐ์"
  }
}

Response for recognition fail

{
  "status": "FAIL",
  "message": "check input image and retry"
}

Response for invalid request parameters

{
  "status": "INVALID_REQUEST",
  "message": "check request params"
}

Response for invalid image format

{
  "status": "IMAGE_INVALID_FORMAT",
  "message": "image format not support"
}

Response for image size larger than 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Response for server error

{
  "status": "INNER_ERROR",
  "message": "Inner error, please retry later"
}

HTTP request

POST https://api.ekycpro.com/v1/th_ocr/general

Request parameters

parameter	description
`img`	`string`, base64 encoded image. It is recommended that the image be less than 200KB, so it will be returned within 2 seconds, otherwise the return time will be longer.

Response format

fields	description
`status`	status code
`message`	`cardTypeTh`: th card type `cardTypeEn`: en card type `idNumber`: id number `serialNumber`: serial number `nameTh`: name `nameEn`: name `lastNameEn`: last name of En `birthTh`: birth day of th `birthEn`: birth day of en `issueDateEN`: en issue date `issueDateTH`: th issue date `expiryDateEN`: expiry date `expiryDateTH`: expiry date `religion`: religion `address`: address

Status code

status	description
`OK`	`charge`, success
`FAIL`	`charge`, image recognition error, please check input image
`INVALID_REQUEST`	`free`, invalid request parameters
`IMAGE_INVALID_FORMAT`	`free`, invalid image format, image format should be one of jpeg/jpg/png/bmp
`IMAGE_INVALID_SIZE`	`free`, invalid image size, should be less than 2M
`INNER_ERROR`	`free`, server error