The purpose of OCR is to extract information from Kartu Keluarga (KK) documents. The result will
be in “text” format. All the data inside the document will be extracted.

🎈Endpoint

Method	Endpoint
POST	https://api.verihubs.com/v2/ocr/kk

🎈Request

Headers

Key	Type	Notes	Description
app-id	String	Required	Application ID that generated from Application Menu in Verihubs Client Dashboard. To hit in Testing and Live mode you need a Production Application ID.
api-key	String	Required	API-Key that generated from Application Menu in Verihubs Client Dashboard that related to specific Application ID.

You can generate your Application ID and API-Key in the Application page in Verihubs Client Dashboard..

Body Parameters

Parameter	Type	Description	Example
`image`	file	Kartu Keluarga image file File Type JPEG, JPG, PNG or PDF Max File size: 10MB `image` is required

🎈Responses

Response Code

Code	Description
200	Successful Response
400	Bad Request
401	Unauthorized
500	Internal Server Error

Response Parameters

Key	Type	Description
message	string	Message that describe the overall response.
data	object	Shows the extraction result
data.id	string	Used as the identity of the extraction result.
data.reference_id	string	The identity of the extraction result which want to be pulled
data.result_data	string	Describes the detail extracted from Kartu Keluarga. family_members kartu_keluarga
data.result_data.family_members	string	Describes the detail extracted from Table Kartu Keluarga. agama ayah ibu jenis_kelamin jenis_pekerjaan kewarganegaraan nama_lengkap nik no_kitas_kitap no_paspor pendidikan status_hubungan_dalam_keluarga status_pernikahan tanggal_lahir tempat_lahir
data.result_data.kartu_keluarga	string	Description of details extracted from information located outside the table on the Kartu Keluarga. alamat desa_kelurahan kabupaten_kota kecamatan kode_pos nama_kepala_keluarga nomor_kk provinsi rt_rw tanggal_dikeluarkan

Error Code

Response Code	Errror code	Error Message	Description
400	OCR_40001	There's a problem with your JSON payload	No value in payload / incorrect payload / missing payload image / invalid image extension / image size exceeds maximum
400	OCR_40004	You don't have enough quota, please contact our admin	Insufficient quota (applicable in testing mode only)
500	OCR_50000	There's a problem from our system.	Internal server error

Sample Responses

Response Code	Response	Description
200	{ "message": "Success Extract Data", "data": { "id": "e29629c0-1884-4703-9c31-2ef5faaf3057", "reference_id": "e35bc239-cfb4-4535-984d-f8d68be5ea35", "result_data": { "family_members": [ { "agama": "ISLAM", "ayah": "SUPARLAN, S.PD", "ibu": "ARISAH, S.PD", "jenis_kelamin": "LAKI-LAKI", "jenis_pekerjaan": "KARYAWAN SWASTA", "kewarganegaraan": "WNI", "nama_lengkap": "ERI KURNIAWAN, ST", "nik": "3303062705840001", "no_kitas_kitap": "N/A", "no_paspor": "N/A", "pendidikan": "DIPLOMA IV/STRATA I", "status_hubungan_dalam_keluarga": "KEPALA KELUARGA", "status_pernikahan": "KAWIN", "tanggal_lahir": "27-06-1984", "tempat_lahir": "PURBALINGGA" }, { "agama": "ISLAM", "ayah": "H. JAMBURI", "ibu": "HJ.ENDANG TUTI KASWATI, SE", "jenis_kelamin": "PEREMPUAN", "jenis_pekerjaan": "DOKTER", "kewarganegaraan": "WNI", "nama_lengkap": "DRG. NIKEN WULANSARI", "nik": "3404085304840001", "no_kitas_kitap": "N/A", "no_paspor": "N/A", "pendidikan": "DIPLOMA IV/STRATA I", "status_hubungan_dalam_keluarga": "ISTRI", "status_pernikahan": "KAWIN", "tanggal_lahir": "13-04-1984", "tempat_lahir": "BANTUL" }, { "agama": "ISLAM", "ayah": "ERI KURNIAWAN, ST", "ibu": "DRG. NIKEN WULANSARI", "jenis_kelamin": "LAKI-LAKI", "jenis_pekerjaan": "BELUM/TIDAK BEKERJA", "kewarganegaraan": "WNI", "nama_lengkap": "DASTAN FAWWAZ KURNIAWAN", "nik": "3404081204110005", "no_kitas_kitap": "N/A", "no_paspor": "N/A", "pendidikan": "TIDAK/BLM SEKOLAH", "status_hubungan_dalam_keluarga": "ANAK", "status_pernikahan": "BELUM KAWIN", "tanggal_lahir": "12-04-2011", "tempat_lahir": "YOGYAKARTA" } ], "kartu_keluarga": { "alamat": "TEGALSARI, DAWUKAN", "desa_kelurahan": "SENDANGTIRTO", "kabupaten_kota": "SLEMAN", "kecamatan": "BERBAH", "kode_pos": "55573", "nama_kepala_keluarga": "ERI KURNIAWAN, ST", "nomor_kk": "3404080111110002", "provinsi": "DAERAH ISTIMEWA YOGYAKARTA", "rt_rw": "006/005", "tanggal_dikeluarkan": "18-11-2011" } } } }	Request data parameter is valid.
400	`{ "message": "There's a problem with your JSON payload", "error_code": "OCR_40001", "error_fields": [ { "field": "image", "message": "there is a problem with the image provided" } ] }`	Invalid Payload.
400	`{ "message": "You don't have enough quota, please contact our admin", "error_code": "OCR_40004" }`	The transaction is in Testing mode and not enough remaining quota. Please contact Verihubs Customer Support.
401	`{ "message": "Authorization failed" }`	Authorization Failed. Transaction that unauthorized due to Application ID or API-Key issue. To hit in Testing and Live mode you need a Production Application ID and API-Key.
500	`{ "message": "Internal server error", "error_code": "OCR_50000" }`	Internal server error.