App-ID

String

Required

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

Required

API-Key that generated from Application Menu in Verihubs Client Dashboard that related to specific Application ID.

message

string

Message that describe the overall response.

data

object

Shows the extraction result

id

string

Used as the identity of the extraction result.

reference_id

string

The identity of the extraction result which want to be pulled

address
birth_date
birth_place
blood_type
domain
gender
height
name
occupation
sim_number
sim_type
valid_until

string

Describes the detail extracted from SIM

200

{
    "message": "Success Extract Data",
    "data": {
        "id": "6bc212b8-5386-440e-aecc-70912d5dbc82",
        "reference_id": "c1118464-1364-4083-9a63-b4e2866e5310",
        "result_data": {
            "address": "JL SWADAYA 1 RT 14/09",
            "birth_date": "17-08-1945",
            "birth_place": "JAKARTA",
            "blood_type": "O",
            "domain": "METRO JAYA",
            "gender": "PEREMPUAN",
            "height": "N/A",
            "name": "SITI DEWI MARIA",
            "occupation": "PELAJAR/MHS",
            "sim_number": "0123-4567-891011",
            "sim_type": "A",
            "valid_until": "21-01-2024"
        }
    }
}

Request data parameter is valid.

400

{
    "message": "There's a problem with your JSON payload",
    "error_code": "OCR_40001",
    "error_fields": "validation error details"
}

Invalid Payload.

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.

400

{
    "message": "You don't have enough quota, please contact our admin",
    "error_code": "OCR_40004"
}

The transaction is in Testing mode and not enough remaining quota. Please contact Verihubs Customer Support.

500

{
    "message": "Internal server error",
    "error_code": "OCR_50000"
}

Internal server error.