Business Registration Certificate.
API Documentation for Business Registration Certificate.
Description
Business Registration Certificate is an API service to extrct information from the Certificate of Business Registration issued by DBD.
Response Schema
| Key | Type | Description |
|---|---|---|
| status | str | The API processing status. "success or error" |
| error | list[Dict of error details] | Error details. |
| data | list[Data-Object] | The extracted data from each page. |
Data Object Schema
| Key | Type | Description |
|---|---|---|
| head_company_address | ObjField | Headqualter fully address. |
| head_house_building_number | ObjField | Headqualter House/Building address No. |
| head_street_address | ObjField | Headqualter Street. |
| head_sub_district | ObjField | Headqualter Sub-district. |
| head_district | ObjField | Headqualter district. |
| head_province | ObjField | Headqualter provience. |
| head_postcode | ObjField | Headqualter zip code. |
| branch_company_address | ObjFieldList | Branch fully addresses. |
| branch_house_building_number | ObjFieldList | Branch house/building address No. |
| branch_street_address | ObjFieldList | Branch street. |
| branch_sub_district | ObjFieldList | Branch sub-district. |
| branch_district | ObjFieldList | Branch district. |
| branch_province | ObjFieldList | Branch provience. |
| branch_postcode | ObjFieldList | Branch zip code |
| committee_name | ObjFieldList | The list of committee names. |
| company_name | ObjField | The name of company. |
| legal_entity_id | ObjField | The registered ID No. |
| registered_cap | ObjField | The registration capitals amount. |
| registration_date | ObjField | The date of register. |
| registration_objective | ObjFieldList | The list of registration objective. |
| issued_date | ObjField | The documetn issued date |
ObjField Schema
| Key | Type | Description |
|---|---|---|
| value | str | The designed field extracted from document. |
| bboxes | List[List[List[int]]] | The list of four point bboxes. |
| bboxes_norm | List[List[List[float]]] | The list of four point normalized bboxes. |
| confidence | float | The confidence value. |
ObjFieldList Schema
| Key | Type | Description |
|---|---|---|
| value | List[str] | The designed field extracted from document. |
| bboxes | List[List[List[int]]] | The list of four point bboxes. |
| bboxes_norm | List[List[List[float]]] | The list of four point normalized bboxes. |
| confidence | float | The confidence value. |
Response Definition
| HTTP Status | Code | Message | Description |
|---|---|---|---|
| success | 200 | success | IDcard Fraud Detection API works successfully. |
| Bad Request | 400 | Bad Request | Not a valid base64 image request (must be .jpg, .jpeg, .png, .pdf) or invalid size, request schema. The api can not retrieve information on any image. |
| Unprocessable Content | 422 | Unprocessable Content | The request body is not valid. |
| Request Body too large | 413 | Request entity too large | The request image base64 size is larger than the specified image size. |
| Error | 500 | Internal server error | There is some error in the internal servers. |
Requests My-Template
POST https://apis.aigen.online/aiscript/business-registration-certificate/v3
Requests Body
| Name | Type | Description |
|---|---|---|
| image* | String | Base64 image encoded string |
API Response Examples.
- 200: OK Success
- 400: Bad Request Bad Request
- 500: Internal Server Error Internal Server Error
View Response
{'status': 'success',
'error': [],
'data':[
{
"committee_name": {
"value": [
"xxx",
"xxx",
"xxx"
],
"bboxes": [
[
[
196,
860
],
[
588,
860
],
[
588,
916
],
[
196,
916
]
],
[
[
201,
930
],
[
540,
930
],
[
540,
968
],
[
201,
968
]
],
[
[
866,
867
],
[
1142,
867
],
[
1142,
914
],
[
866,
914
]
]
],
"bboxes_norm": [
[
[
0.1185,
0.3677
],
[
0.3555,
0.3677
],
[
0.3555,
0.3916
],
[
0.1185,
0.3916
]
],
[
[
0.1215,
0.3976
],
[
0.3265,
0.3976
],
[
0.3265,
0.4139
],
[
0.1215,
0.4139
]
],
[
[
0.5236,
0.3707
],
[
0.6904,
0.3707
],
[
0.6904,
0.3908
],
[
0.5236,
0.3908
]
]
],
"confidence": [
0.9887,
0.9599,
0.9982
]
},
"head_company_address": {
"value": "xxx",
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"confidence": 0.9396,
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"branch_company_address": {},
"company_name": {
"value": "xxx",
"bboxes": [
[
[
162,
748
],
[
684,
748
],
[
684,
790
],
[
162,
790
]
]
],
"bboxes_norm": [
[
[
0.0979,
0.3198
],
[
0.4135,
0.3198
],
[
0.4135,
0.3378
],
[
0.0979,
0.3378
]
]
],
"confidence": 0.9254
},
"legal_entity_id": {
"value": "xxx",
"bboxes": [
[
[
110,
626
],
[
886,
626
],
[
886,
675
],
[
110,
675
]
]
],
"bboxes_norm": [
[
[
0.0665,
0.2676
],
[
0.5357,
0.2676
],
[
0.5357,
0.2886
],
[
0.0665,
0.2886
]
]
],
"confidence": 0.9904
},
"registered_cap": {
"value": "xxx",
"bboxes": [
[
[
387,
1045
],
[
841,
1045
],
[
841,
1089
],
[
387,
1089
]
]
],
"bboxes_norm": [
[
[
0.234,
0.4468
],
[
0.5085,
0.4468
],
[
0.5085,
0.4656
],
[
0.234,
0.4656
]
]
],
"confidence": 0.9982
},
"registration_date": {
"value": "10 กันยายน 2563",
"bboxes": [
[
[
110,
626
],
[
886,
626
],
[
886,
675
],
[
110,
675
]
]
],
"bboxes_norm": [
[
[
0.0665,
0.2676
],
[
0.5357,
0.2676
],
[
0.5357,
0.2886
],
[
0.0665,
0.2886
]
]
],
"confidence": 0.9903999999999998
},
"issued_date": {
"value": "30 กันยายน 2565",
"bboxes": [
[
[
922,
1342
],
[
1429,
1342
],
[
1429,
1391
],
[
922,
1391
]
]
],
"bboxes_norm": [
[
[
0.5574,
0.5737
],
[
0.864,
0.5737
],
[
0.864,
0.5947
],
[
0.5574,
0.5947
]
]
],
"confidence": 0.9847
},
"registration_objective": {},
"head_full_address": {
"value": "xxxx",
"confidence": 0.9999491638177401,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_house_building_number": {
"value": "xxxx",
"confidence": 0.9999078710873922,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_street_address": {
"value": "xxx",
"confidence": 0.9999642173449199,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_sub_district": {
"value": "xxxx",
"confidence": 0.9999763114111764,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_district": {
"value": "xxxx",
"confidence": 0.999899705251058,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_province": {
"value": "xxxxx",
"confidence": 0.9999826604669745,
"bboxes": [
[
[
157,
1106
],
[
1301,
1106
],
[
1301,
1155
],
[
157,
1155
]
]
],
"bboxes_norm": [
[
[
0.0949,
0.4729
],
[
0.7866,
0.4729
],
[
0.7866,
0.4938
],
[
0.0949,
0.4938
]
]
]
},
"head_postcode": {},
"branch_house_building_number": {},
"branch_street_address": {},
"branch_sub_district": {},
"branch_district": {},
"branch_province": {},
"branch_postcode": {}
}
]
}
{
"request_id": "",
"error": [
{ "object": "error", "code": "bad_request", "message": "Bad Request" }
],
"data": [{}],
"status": "error"
}
{
"request_id": "",
"error": [
{
"object": "error",
"code": "internal_server_error",
"message": "Page 1 : Internal Server Error"
}
],
"data": [{}],
"status": "error"
}
API Request Examples.
- Python
- Javascript
- PHP
- CURL
import requests
api = "https://apis.aigen.online/aiscript/business-registration-certificate/v3"
headers = {"x-aigen-key": "<key>"}
data = {'image':imgb64}
res = requests.post(api, json=data, headers=headers)
print(res.json())
const axios = require("axios");
const api = "https://apis.aigen.online/aiscript/business-registration-certificate/v3";
const headers = {
"x-aigen-key": "<key>",
};
const data = {image: "<base64_string>",
};
axios
.post(api, data, { headers: headers })
.then((res) => {
console.log(res.data);
})
.catch((err) => {
console.error(err.response.data);
});
<?php
$curl = curl_init();
// Data to be sent in the POST request
$data = [
'image' => $imgb64,
];
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://apis.aigen.online/aiscript/business-registration-certificate/v3',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => json_encode($data),
CURLOPT_HTTPHEADER => array(
'X-AIGEN-KEY: <aigen-key>',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
curl -X POST "https://apis.aigen.online/aiscript/business-registration-certificate/v3" \
-H "X-AIGEN-KEY: your_real_api_key" \
-H "Content-Type: application/json" \
-d '{"image": "<base64_string>"}'