Guidelines

Passport

This method helps you to extract text in Passport image.

🎈Endpoint

MethodEndpoint
POSThttps://api.verihubs.com/v2/ocr/passport

🎈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
imagefileRequired

  • Passport image file - File Type JPEG, JPG, PNG and PDF - Max File size: 10MB

🎈Responses

Response Code

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

Details for 200

KeyTypeDescription
messagestringMessage that describe the overall response.
dataobjectShows the extraction result
idstringUsed as the identity of the extraction result.
reference_idstringThe identity of the extraction result which want to be pulled
authority
date_of_birth
date_of_expiry
date_of_issue
full_name
gender
mrz
nationality
passport_no
place_of_birth		stringDescribes the detail extracted from passport
valid_docbooleanDescribe whether the document is detected as passport. If "valid_doc" : true , then the document is considered as passport.

Error Code

Response CodeErrror codeError MessageDescription
200OCR_200004Passport Not DetectedThe file attached is not passport
(*replacing "valid_doc")
422OCR_40001There's a problem with your JSON payloadno value in payload / incorrect payload / missing payload image / invalid image extension / image size exceeds maximum
400OCR_40004You don't have enough quota, please contact our adminInsufficient quota (applicable in testing mode only)
500OCR_50000There's a problem from our system.Internal server error

Sample Responses

Response CodeResponseDescription
200
{
    "message": "Success Extract Data",
    "data": {
        "id": "f0cf2285-704d-4489-b011-504aab60b5ec",
        "reference_id": "eba032fc-7596-42c6-8efd-fe27137c5d67",
        "result_data": {
      "authority": "JAKARTA UTARA",
      "date_of_birth": "27/06/1977",
       "date_of_expiry": "23/08/2010",
       "date_of_issue": "25/08/2005",
       "full_name": "LINDA ROSE",
      "gender": "F",
      "mrz": "P<IDNCHEN<<LIEN<<<<<<<<<<<<<<<<<<<<<<<<<<<<5225LP1<<1IDN7112281F12033<<<<<<<<<<<<<<<14",
      "nationality": "INDONESIAN",
      "passport_no": "X00130410",
      "place_of_birth": "INDONESIA"
       }
    }
}
Request data parameter is valid.
200
{
      "message": "Passport Not Detected",
      "error_code": "OCR_200004"
}
Passport is not detected in the file attached.
400
{
    "message": "There's a problem with your JSON payload",
    "error_code": "OCR_40001",
    "error_fields": 
}
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.

Updated 8 months ago

Did this page help you?