Sync

This API extracts information from the user’s KTP card image using OCR and returns the extracted data in response.

API Description

KTP OCR Sync Call

POST https://{vida.host}/verify/v1/ktp/ocr/transaction

Headers

Name	Type	Description
Authorization*		OAuth access token. Get the token by calling the Get Access Token API
Content-Type*	application/json	Format type of request body

Request Body

Name	Type	Description
ktp_image*	String	Data URI scheme, Base64 encoded KTP image. Supported image formats: JPG/JPEG.

Sample request json

Sample Request

{
    "parameters": {
        "ktp_image": "base64 encoded.."
}
}

API Response

OCR Request Successful

OCR API Request Successful.

HTTP Status Code: 200

JSON Response

{
	"data": {
		"result": {
			"provinsi": "JAWA BARAT",
			"kabupaten_kota": "KOTA BANDUNG",
			"golongan_darah": "",
			"agama": "ISLAM",
			"alamat": "SARIMANIS 13 TOWN HOUSE B3",
			"berlaku_hingga": "SEUMUR HIDUP",
			"kewarganegaraan": "WNI",
			"nik": "1234567890123456",
			"nama": "TEST NAME",
			"pekerjaan": "KARYAWAN SWASTA",
			"tempat_lahir": "BUKIT TINGGI",
			"kecamatan": "SUKASARI",
			"jenis_kelamin": "",
			"rt_rw": "002/006",
			"tanggal_lahir": "01-01-2001",
			"status_perkawinan": "KAWIN",
			"kelurahan_desa": "SARIJADI"

		},
		"status": "success",
		"transaction_id": "1fa03f48-12db-4abc-9c4b-c25bb7d98eab"
	}
}

Invalid Image Extension

Invalid image extension type Recommendation: ensure to give KTP image file extension JPEG/JPG.

HTTP Status Code: 400

JSON Response

{
    "errors": [
        {
            "code": 2006,
            "title": "Unsupported media type",
            "detail": "Unsupported media or image type"
        }
       ]
}

Invalid KTP Image Format

Invalid image format due to below reasons:

• The KTP object resolution is less than 300x400 pixels

• The KTP object resolution is greater than 3000x4000 pixels

• No text in the KTP image

Recommendation: Ensure to give KTP image input as the specific recommendation

HTTP Status Code: 400

JSON Response

{
	"errors": [
		{
		"code": 2000,
		"title": "Bad Request",
		"detail": "Invalid image format"
	}
	]
}

Image File Size Error

The image file size is greater than 2 MB.

Recommendation: ensure to give image file size less than 2 MB

HTTP Status Code: 400

JSON Response

{
    "errors": [
        {
            "code": 2000,
            "title": "Bad Request",
            "detail": "Please recheck your image file size"
        }
    ]
}

KTP OCR Sync Call

POST https://{vida.host}/verify/v1/ktp/ocr/transaction

Headers

Name	Type	Description
Authorization*		3szVklNVpfJL
Content-Type*	application/json	QNRmJHAy55OO

Request Body

Name	Type	Description
ktp_image*	String	fRUTRr5l3FPA

Error Response

Bad Request Invalid Image Extension

HTTP Status Code: 400

Error Response

{
    "errors": [
        {
            "code": 2006,
            "title": "Unsupported media type",
            "detail": "Unsupported media or image type"
        }
       ]
}

Bad Request Invalid image format due to some reasons

The KTP object resolution is less than 300x400 pixels. The KTP object resolution is greater than 3000x4000 pixels No text in the KTP image

Recommendation: ensure to give KTP image input as the specific recommendation

HTTP Status Code: 400

Error Response

{
    "errors": [
        {
            "code": 2000,
            "title": "Bad Request",
            "detail": "Invalid image format"
        }
    ]
}

Bad Request The image file size is greater than 2 MB

HTTP Status Code: 400

Error Response

{
    "errors": [
        {
            "code": 2000,
            "title": "Bad Request",
            "detail": "Please recheck your image file size"
        }
    ]
}