Dokumentasi

Semua endpoint memakai autentikasi yang sama: kirim header x-api-key berisi API key Anda. Batas wajar 60 permintaan per menit per kunci. Belum punya kunci? Minta ke pengelola.

OCR KTP

POST /api/v1/ocr/ktp

Kirim foto atau berkas PDF KTP sebagai multipart/form-data pada field image (JPG/PNG/WebP/PDF, maks 5 MB). PDF dibaca per halaman (maks 3 halaman pertama); PDF digital dibaca dari lapisan teksnya. Gambar buram otomatis dioptimalkan (diperbesar, dipertajam, dinormalkan kontrasnya) dan dibaca dalam beberapa varian — hasil terbaik yang dikembalikan. Semua berkas hanya diproses di memori, tidak disimpan.

curl -X POST https://api.muhammadroni.web.id/api/v1/ocr/ktp \
  -H "x-api-key: <API key Anda>" \
  -F "image=@foto-ktp.jpg"

{
  "success": true,
  "data": {
    "nik": "3171************",
    "nik_valid": true,
    "nama": "NAMA SESUAI KTP",
    "tempat_lahir": "JAKARTA",
    "tanggal_lahir": "1985-05-20",
    "jenis_kelamin": "LAKI-LAKI",
    "golongan_darah": "O",
    "alamat": "JL. CONTOH RAYA NO. 8",
    "rt_rw": "003/004",
    "kelurahan_desa": "CIPINANG",
    "kecamatan": "PULOGADUNG",
    "kabupaten_kota": "JAKARTA TIMUR",
    "provinsi": "DKI JAKARTA",
    "agama": "ISLAM",
    "status_perkawinan": "KAWIN",
    "pekerjaan": "WIRASWASTA",
    "kewarganegaraan": "WNI",
    "berlaku_hingga": "SEUMUR HIDUP"
  },
  "meta": { "engine": "tesseract-ocr", "language": "ind", "confidence": 91, "duration_ms": 1871 }
}

Field	Keterangan
nik	16 digit NIK, apa adanya dari kartu
nik_valid	Hasil validasi struktur NIK (wilayah + tanggal lahir + urutan)
nama	Nama lengkap
tempat_lahir / tanggal_lahir	Tanggal lahir diformat YYYY-MM-DD
jenis_kelamin	LAKI-LAKI atau PEREMPUAN
golongan_darah	A, B, AB, O, atau - bila tidak ada
alamat	Alamat jalan sesuai kartu
rt_rw	Format 003/004
kelurahan_desa / kecamatan	Kelurahan/desa dan kecamatan
kabupaten_kota / provinsi	Wilayah penerbit KTP
agama / status_perkawinan / pekerjaan	Sesuai kartu
kewarganegaraan	WNI atau WNA
berlaku_hingga	Umumnya SEUMUR HIDUP

Coba langsung

Unggah foto atau PDF KTP (diproses di memori, tidak disimpan) dan lihat hasil bacaannya.

API keyFoto KTP / PDF

Kesalahan umum

401 invalid_api_key — header x-api-key tidak ada atau tidak dikenal.
413 image_too_large — gambar melebihi 5 MB; kecilkan dulu.
422 ktp_not_detected — NIK dan nama tidak terbaca; foto ulang dengan cahaya lebih baik.
429 rate_limited — melebihi 60 permintaan per menit.