vBiz API¶

Quick reference¶

Resource	Operation	Description
vBiz	GET /api/vbiz/search/(string:keyword)	Find business by {vbiz_code} or {vbiz_name}
vBiz	GET /api/vbiz/(string:vbiz_code)	Get business details with {vbiz_code}
vBiz	GET /api/vbiz/cat/(string:vbiz_category_id)	Get list business with {vbiz_category_id}

Details¶

GET /api/vbiz/search/(string: keyword)¶

This function allows users to search Vietnamese businesses by business tax’s ID or by business name

Request:

GET /api/vbiz/search/{keyword} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_name": "",
            "vbiz_code": ""
        }
    ]
}

Response Headers

Content-Type – application/json

Status Codes

200 OK – results

GET /api/vbiz/cat/(string: vbiz_category_id)¶

This function allows users to get list of Vietnamese business information followed by business category

Request:

GET /api/vbiz/cat/{vbiz_category_id} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_code": "",
            "vbiz_address": "",
            "vbiz_phone": "",
            "vbiz_email": "",
            "vbiz_website": "",
            "vbiz_register_date": ""
        }
    ]
}

Response Headers

Content-Type – application/json

Status Codes

200 OK – results

GET /api/vbiz/(string: vbiz_code)¶

This function allows users to get Vietnamese business information followed by business tax’s ID

Request:

GET /api/vbiz/{vbiz_code} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_code": "",
            "vbiz_address": "",
            "vbiz_phone": "",
            "vbiz_email": "",
            "vbiz_website": "",
            "vbiz_register_date": ""
        }
    ]
}

Response Headers

Content-Type – application/json

Status Codes

200 OK – results