Get Extract - KTP Async
This method helps you to get the recognition result of Extract - KTP Asynchronous.
🎈Endpoint
| Method | Endpoint |
|---|---|
| GET | https://api.verihubs.com/ktp/id/extract-async/result |
🎈Request
Headers
Key | Type | Notes | Description |
|---|---|---|---|
App-ID | String | Required | Application ID that generated from Application Menu in Verihubs Client Dashboard. |
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 | Notes | Default | Description |
|---|---|---|---|---|
| reference_id | String | Required | - | the identity of the recognition result which want to be pulled |
🎈Responses
Response Code
| Code | Description |
|---|---|
| 200 | Successful Response |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |
Details for 200 and 201
| Key | Type | Description |
|---|---|---|
| message | string | Message that describe the overall response. |
| status_code | string | Status that indicate the billing calculation. See status code list in this link. |
| image_quality | object | Describes image quality detail. |
| blur | boolean | Describes whether input image is considered as blur (If it exceeds the threshold, it will detected as blur) |
| dark | boolean | Describes whether input image is considered as dark (If it exceeds the threshold, it will detected as dark) |
| flashlight | boolean | Detects whether flashlight is detected or not |
| grayscale | boolean | Detects whether KTP is black & white or no |
| address | string | Shows address extracted from KTP |
| administrative_village | string | Shows administrative village extracted from KTP |
| blood_type | string | Shows blood type extracted from KTP |
| city | string | Shows city extracted from KTP |
| date_of_birth | string | Shows dob extracted from KTP |
| district | string | Shows district extracted from KTP |
| full_name | string | Shows full name extracted from KTP |
| gender | string | Shows gender extracted from KTP |
| marital_status | string | Shows marital status extracted from KTP |
| nationality | string | Shows nationality extracted from KTP |
| nik | string | Shows nik extracted from KTP |
| occupation | string | Shows occupation extracted from KTP |
| place_of_birth | string | Shows place of birth extracted from KTP |
| religion | string | Shows religion extracted from KTP |
| rt_rw | string | Shows RT and RW extracted from KTP |
| state | string | Shows state extracted from KTP |
Error Code
| Response Code | Error Message | Description |
|---|---|---|
| 200 | FAIL_ON_1 | fail on quality |
| 200 | KTP_NOT_DETECTED | KTP not detected from image |
| 400 | INVALID_PAYLOAD_REFERENCE_ID | reference_id is too short/too long |
| 404 | INVALID_PAYLOAD_REFERENCE_ID_NOT_FOUND | reference_id is not found / reference_id payload is missing |
| 500 | INTERNAL_SERVER_ERROR | internal server error |
Sample Responses
Response Code | Response | Description |
|---|---|---|
200 | { | Request data parameter is valid. |
200 | { | Request image is not a KTP image. |
404 | { | Invalid Reference ID. Transaction that is considered failed due to reference ID not found. |
401 | { | 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 | { | Internal server error. |
Updated 3 months ago
