ID Verification
Verify you user using the data registered in government database. You can use the NIK, fullname dan date of birth to get results checked for each field.
🎈Endpoint
Method | Endpoint |
---|---|
POST | https://api.verihubs.com/data-verification/id-verification/verify |
🎈Headers
Key | Type | Description |
---|---|---|
App-ID | String | 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 | API-Key that generated from Application Menu in Verihubs Client Dashboard that related to specific Application ID. |
🎈Request
Request Parameter
Parameter | Type | Description | Example |
---|---|---|---|
nik | String | 16 digits of Nomor Induk Kependudukan as stated on the KTP. | 9171022512990011 |
name | String | Full name as stated on the KTP. | John Doe |
birth_date | String | Birth date in DD-MM-YYYY format as stated on the KTP. | 01-01-1901 |
reference_id | String | This reference_id can be used to indicate your company’s transaction and must be unique. If the reference_id is not inputted, then Verihubs will generate one for you | ID_CHECK_123 |
🎈Response
HTTP Code
HTTP Code | Description | Response |
---|---|---|
200 | Successful Transaction; Transaction that is considered successful and has been successfully verified by the data source. | { "message": "ID Check verification has been done", "data": { "id": "e3c0326e-23f7-49d0-8876-71528a860a0c", "nik": true, "name": false, "birth_date": true, "reference_id": "f3c0326e-23f7-49d0-8876-71528a860a0d" } } |
400 | Invalid Payload; Transaction that is considered failed due to validation errors, an error_field will appear explaining the error. | { "message": "Invalid payload", "error_code": "INVALID_PAYLOAD", "error_fields": [ { "field": "nik", "message": "nik length should consist of 16 digit(s)" } ] } |
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. | { "message": "Authorization Failed", "error_code": "UNAUTHORIZED", "error_fields": [] } |
403 | Forbidden; The transaction is in Testing mode and not enough remaining quota. Please contact Verihubs Customer Support. This condition only apply in Testing Mode. | { "message": "Insufficient testing quota", "error_code": "FORBIDDEN", "error_fields": [] } |
429 | Too Many Request; Spam Error as the transaction is read as spam, please wait 10 seconds before re-performing the hit process with the same identity. | { "message": "Too many request in the allowed time frame", "error_code": "TOO_MANY_REQUEST", "error_fields": [] } |
500 | Internal Server Error; The transaction failed due to a server error that could be caused by data source constraints, timeout, internal error. | { "message": "Internal Server Error", "error_code": "INTERNAL_SERVER_ERROR", "error_fields": [] } |
Response Parameter
Parameter | Type | Description | Example |
---|---|---|---|
message | string | The message of your transaction. | ID Check verification has been done |
data.id | string | Verihubs auto generated Transaction ID. | e3c0326e-23f7-49d0-8876-71528a860a0c |
data.nik | boolean | The verification result of your NIK. | true |
data.name | boolean | The verification result of your name. | true |
data.birth_date | boolean | The verification result of your date of birth. | true |
data.reference_id | boolean | Client inputted unique ID. If you did not input any, Verihubs will auto generate the ID. | f3c0326e-23f7-49d0-8876-71528a860a0d |
Response Example
Case | Description | Response |
---|---|---|
Verified | All data inputted (NIK, Name, Date of Birth) verified. | { "message": "Identity verification has been done", "data": { "id": "e3c0326e-23f7-49d0-8876-71528a860a0c", "nik": true, "name": true, "birth_date": true, "reference_id": "f3c0326e-23f7-49d0-8876-71528a860a0d" } } |
NIK Not Found | NIK inputted not found in the government database. | { "message": "Identity verification has been done", "data": { "id": "e3c0326e-23f7-49d0-8876-71528a860a0c", "nik": false, "name": null, "birth_date": null, "reference_id": "f3c0326e-23f7-49d0-8876-71528a860a0d" } } |
Name Not Match | Name inputted did not match the name recorded in the government database. | { "message": "Identity verification has been done", "data": { "id": "e3c0326e-23f7-49d0-8876-71528a860a0c", "nik": true, "name": false, "birth_date": true, "reference_id": "f3c0326e-23f7-49d0-8876-71528a860a0d" } } |
Date of Birth Not Match | Date of Birth inputted did not match the date of birth recorded in the government database. | { "message": "Identity verification has been done", "data": { "id": "e3c0326e-23f7-49d0-8876-71528a860a0c", "nik": true, "name": true, "birth_date": false, "reference_id": "f3c0326e-23f7-49d0-8876-71528a860a0d" } } |
Updated 21 days ago