Search Business Profiles
Search for businesses by business name, representative name, or business registration number. This API requires no issuer registration, no certificate, and no client reference id. Each result returned deducts 9 points, and a search with no results deducts nothing.
When hasMore is true, pass nextCursor in cursor to fetch the next results. hasMore can be true even when a response holds fewer results than limit, so keep calling based on hasMore. One keyword returns up to the first 1,000 results. A test key searches only the mock businesses listed in the guide. Business profile guide
curl --request GET \
--url https://xapi.bolta.io/v1/businessProfiles:search \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://xapi.bolta.io/v1/businessProfiles:search"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://xapi.bolta.io/v1/businessProfiles:search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://xapi.bolta.io/v1/businessProfiles:search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://xapi.bolta.io/v1/businessProfiles:search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://xapi.bolta.io/v1/businessProfiles:search")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://xapi.bolta.io/v1/businessProfiles:search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"items": [
{
"businessRegistrationNumber": "1000000014",
"organizationName": "테스트상사 주식회사",
"representativeName": "김*타",
"registration": {
"status": "ACTIVE"
},
"region": "서울특별시 강남구"
},
{
"businessRegistrationNumber": "1000000028",
"organizationName": "테스트상사 간이점",
"representativeName": "이*스",
"registration": {
"status": "ACTIVE"
},
"region": "서울특별시 마포구"
},
{
"businessRegistrationNumber": "1000000106",
"organizationName": "테스트상사 세금계산서점",
"representativeName": "박*의",
"registration": {
"status": "ACTIVE"
},
"region": "부산광역시 해운대구"
}
],
"nextCursor": "djE6MDotOjM6MzFmN2UxZGI0NjJkMzVhMQ",
"hasMore": true
}Authorizations
Append a colon to your API key, Base64-encode it, and put it in the header. Enter the API key as the username and leave the password empty.
Query Parameters
Search keyword. Matches the business name, former business name, English business name, representative name, three or more initial consonants of the business name, or a ten-digit business registration number. Enter 100 characters or fewer after trimming, with at least 2 characters once spaces and symbols are removed. A number search returns that one business.
Number of results per call. One call deducts at most limit × 9 points.
1 <= x <= 50The nextCursor of the previous response. Send it back unchanged. A cursor is bound to the keyword, excludeStatuses, and key mode (test or live) it was issued for. If you change the conditions or the key mode, search again from the start without a cursor.
Registration states to exclude from the results, separated by commas. The API removes businesses confirmed as suspended or closed and keeps businesses whose state Bolta has not checked.
1SUSPENDED, CLOSED Response
Search succeeded. When nothing matches, items is an empty array and the API deducts no points.
curl --request GET \
--url https://xapi.bolta.io/v1/businessProfiles:search \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://xapi.bolta.io/v1/businessProfiles:search"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://xapi.bolta.io/v1/businessProfiles:search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://xapi.bolta.io/v1/businessProfiles:search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://xapi.bolta.io/v1/businessProfiles:search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://xapi.bolta.io/v1/businessProfiles:search")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://xapi.bolta.io/v1/businessProfiles:search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"items": [
{
"businessRegistrationNumber": "1000000014",
"organizationName": "테스트상사 주식회사",
"representativeName": "김*타",
"registration": {
"status": "ACTIVE"
},
"region": "서울특별시 강남구"
},
{
"businessRegistrationNumber": "1000000028",
"organizationName": "테스트상사 간이점",
"representativeName": "이*스",
"registration": {
"status": "ACTIVE"
},
"region": "서울특별시 마포구"
},
{
"businessRegistrationNumber": "1000000106",
"organizationName": "테스트상사 세금계산서점",
"representativeName": "박*의",
"registration": {
"status": "ACTIVE"
},
"region": "부산광역시 해운대구"
}
],
"nextCursor": "djE6MDotOjM6MzFmN2UxZGI0NjJkMzVhMQ",
"hasMore": true
}