OCR Result

Cập nhật lần cuối: 26/02/2024

API to get the OCR results of the uploaded images

Request

• Endpoint: /v1/api/ekyc-verify/result/ocr

• Method: POST

• Header

  Name	Type	Required	Description
  api_key	string	yes	The API key associated with your account to authenticate requests (for development, check the Credentials section).

• Parameters

  Name	Type	Required	Description
  session_id	string	yes	Current session ID.
  image_type	string (enum)	yes	Supported image types: ID card front image: idcard ID card back image: back_idcard Driver license front image: driver_license Passport front image: passport Documentation front image (unknown type): front_id_doc Documentation back image (unknown type): back_id_doc QR image: qr
  uid	string	no	User ID.

Response

• Status: 200 OK

• Body: JSON

  {
    "code": 0,
    "message": "Successful",
    "data": "<ENCRYPTED_DATA_IN_BASE64>",
    "sign": "8f4642cdb4c555f9a6d5926f4df9b73e44da2e675512d65d44c0a212",
    "request_id": "12345678"
  }

  • Field “request_id”: Request's identifier, used for auditing later.

  • Field “data”: Decrypt the “data” field as described in the Decrypt response data section to get the JSON object with following fields.

    Name	Type	Description
    status	number	The current status of the image to verify. Check the Appendix A1 for detailed status values of uploaded images.
    msg	string	Message value corresponding to the status.
    photo_id	string (128)	ID of the uploaded image.
    info	json	OCR information

  • Field “sign”: The “sign” field is created by encrypted data and a secret key, described in the Signature section.