Async

This API extracts information from the user’s KTP card image via OCR. This API initiates the OTP extraction process asynchronously and returns a transaction id for which status can be checked later.

API Description

POST https://services.vida.id/verify/v1/ktp/ocr

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

HTTP Status Code: 200

JSON Response

{
    "data": {
        "transaction_id": "faa24b24-0e1f-4ae0-9ca4-891c8a919d42"
    }
}

Get Transaction Status

To retrieve the details of an OCR API request, you can use the following API provided by the VIDA Identity API. The VIDA Identity API follows an asynchronous model, where you can obtain the transaction status and details through a separate API call after the request has been processed by the verifiers or processors within the VIDA system.

API Description

POST https://services.vida.id/verify/v1/transaction/{transaction_id}

Path Parameters

Name	Type	Description
transaction_id*	String	Transaction ID that is produced on KTP OCR request.

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

API Response

Transaction Status : COMPLETED

KTP OCR Asynchronous API status is COMPLETED

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"
	}
}

Transaction Status : ON Progress

KTP OCR Asynchronous API status is ON Progress

HTTP Status Code: 200

JSON Response

{
    "data": {
        "transaction_id": "b00ce4b5-51e5-4823-9c36-95c6cabfc4d6"
    }
}

Invalid KTP Image

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"
        }
    ]
}