Get Extract - KTP Async

This method helps you to get the recognition result of Extract - KTP Asynchronous.

🎈Endpoint

🎈Request

Headers

KeyTypeNotesDescription
App-IDStringRequiredApplication ID that generated from Application Menu in Verihubs Client Dashboard.
To hit in Testing and Live mode you need a Production Application ID.
API-KeyStringRequiredAPI-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

ParameterTypeNotesDefaultDescription
reference_idStringRequired-the identity of the recognition result which want to be pulled

🎈Responses

Response Code

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

Details for 200 and 201

KeyTypeDescription
messagestringMessage that describe the overall response.
status_codestringStatus that indicate the billing calculation. See status code list in this link.
image_qualityobjectDescribes image quality detail.
blurbooleanDescribes whether input image is considered as blur (If it exceeds the threshold, it will detected as blur)
darkbooleanDescribes whether input image is considered as dark (If it exceeds the threshold, it will detected as dark)
flashlightbooleanDetects whether flashlight is detected or not
grayscalebooleanDetects whether KTP is black & white or no
addressstringShows address extracted from KTP
administrative_villagestringShows administrative village extracted from KTP
blood_typestringShows blood type extracted from KTP
citystringShows city extracted from KTP
date_of_birthstringShows dob extracted from KTP
districtstringShows district extracted from KTP
full_namestringShows full name extracted from KTP
genderstringShows gender extracted from KTP
marital_statusstringShows marital status extracted from KTP
nationalitystringShows nationality extracted from KTP
nikstringShows nik extracted from KTP
occupationstringShows occupation extracted from KTP
place_of_birthstringShows place of birth extracted from KTP
religionstringShows religion extracted from KTP
rt_rwstringShows RT and RW extracted from KTP
statestringShows state extracted from KTP

Error Code

Response CodeError MessageDescription
200FAIL_ON_1fail on quality
200KTP_NOT_DETECTEDKTP not detected from image
400INVALID_PAYLOAD_REFERENCE_IDreference_id is too short/too long
404INVALID_PAYLOAD_REFERENCE_ID_NOT_FOUNDreference_id is not found / reference_id payload is missing
500INTERNAL_SERVER_ERRORinternal server error

Sample Responses

Response CodeResponseDescription
200{
"message": "success extract ktp data",
"data": {
"nik": "3506042602660001",
"city": "KABUPATEN KEDIRI",
"rt_rw": "002/003",
"state": "PROVINSI JAWA TIMUR",
"gender": "LAKI-LAKI",
"address": "JL.AYYA DSN PURWOKERTO",
"district": "NGADILUWIH",
"religion": "ISLAM",
"full_name": "SULISTYONO",
"blood_type": "-",
"occupation": "GURU",
"nationality": "WNI",
"date_of_birth": "26-02-1966",
"marital_status": "KAWIN",
"place_of_birth": "KEDIRI",
"administrative_village":
"PURWOKERTO",
"image_quality": {
"blur": false,
"dark": false,
"grayscale": false,
"flashlight": false
}
}
}
Request data parameter is valid.
200{
"data": {},
"error_code": "KTP_NOT_DETECTED",
"message": "ktp not detected"
}
Request image is not a KTP image.
404{
"message": "Reference ID not found",
"error_code": "INVALID_PAYLOAD_REFERENCE_ID_NOT_FOUND"
}
Invalid Reference ID. Transaction that is considered failed due to reference ID not found.
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"
}
Internal server error.