Bank statement
1. Extract bank statement information with image URL or pdf URL input
API:
Method | URL |
---|---|
GET | https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement |
Params:
Key | Value | Description |
---|---|---|
img | https://example.com/image.png | URL of photo or pdf |
format_type | url | Type of data to pass in, receive value: url , file , base64 |
get_thumb | true /false | Returns a aligned image |
Demo Python:
import requestsapi_key = "YOUR_API_KEY"api_secret = "YOUR_API_SECRET"image_url = 'https://example.com/image.png'response = requests.get("https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement?img=%s&format_type=url&get_thumb=false"% image_url,auth=(api_key, api_secret))print(response.json())
2. Extract bank statement information with image file or pdf file input
API:
Method | URL | content-type |
---|---|---|
POST | https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement | multipart/form-data |
Params:
Key | Value | Description |
---|---|---|
format_type | file | Type of data to pass in, receive value: url , file , base64 |
get_thumb | true /false | Returns a aligned image |
Body:
Key | Type | Value | Description |
---|---|---|---|
img | file | example.jpg | Image file or pdf file |
Demo Python:
import requestsapi_key = "YOUR_API_KEY"api_secret = "YOUR_API_SECRET"image_path = '/path/to/your/image.jpg'response = requests.post("https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement?format_type=file&get_thumb=false",auth=(api_key, api_secret),files={'img': open(image_path, 'rb')})print(response.json())
3. Extract bank statement information with JSON input
API:
Method | URL | content-type |
---|---|---|
POST | https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement | application/json |
Params:
Key | Value | Description |
---|---|---|
format_type | base64 | Type of data to pass in, receive value: url , file , base64 |
get_thumb | true /false | Returns a aligned image |
Body:
{"img": "iVBORw0KGgoAAAANSU..." // string base64 of the image or pdf to extract}
Demo Python:
import base64import ioimport requestsfrom PIL import Imagedef get_byte_img(img):img_byte_arr = io.BytesIO()img.save(img_byte_arr, format='PNG')encoded_img = base64.encodebytes(img_byte_arr.getvalue()).decode('ascii')return encoded_imgapi_key = "YOUR_API_KEY"api_secret = "YOUR_API_SECRET"img_name = "path_img"encode_cmt = get_byte_img(Image.open(img_name))response = requests.post("https://cloud.computervision.com.vn/api/v2/ocr/document/bank_statement?format_type=base64&get_thumb=false",auth=(api_key, api_secret),json={'img' : encode_cmt})print(response.json())
4. Response
The response will be a JSON with the following format:
{"data": array,"errorCode": string,"errorMessage": string}
Each element in the data
array (corresponding to each extracted page) will be a JSON with the following format:
{"image_table": array, // List of pictures of the table in the page"json": array // List of information corresponding to each image in image_table}
Each element in the json
array has the following structure:
[[json_0, json_1, json_2, json_3, json_4], // Represents each row[...],...]
Each of these json has the following structure:
{"value": string,"score": float,"box": array // [left, top, right, bottom]}
Error code table:
Code | Message |
---|---|
0 | Success |
1 | Incorrect image format |
2 | Url is unavailable |
3 | Incorrect image format |
4 | Incorrect api_key or api_secret |
5 | Out of requests |
6 | Error when processing the request |