Managing Businesses
How to retrieve, delete, and update existing businesses.
Use the operations shown below to manage businesses:
Retrieving businesses
To retrieve all businesses, use the GET /businesses operation with no other parameters, as shown in the example below.
curl --request GET \
--url https://sandbox.bond.tech/api/v0.1/businesses \
--header 'Identity: YOUR-IDENTITY' \
--header 'Authorization: YOUR-AUTHORIZATION' \
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://sandbox.bond.tech/api/v0.1/businesses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Identity"] = YOUR-IDENTITY
request["Authorization"] = YOUR-AUTHORIZATION
response = http.request(request)
puts response.read_body
const options = {
method: 'GET',
headers: {
Identity: 'YOUR-IDENTITY',
Authorization: 'YOUR-AUTHORIZATION'
}
};
fetch('https://sandbox.bond.tech/api/v0.1/businesses', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://sandbox.bond.tech/api/v0.1/businesses"
headers = {
"Content-Type": "application/json",
"Identity": YOUR-IDENTITY,
"Authorization": YOUR-AUTHORIZATION
}
response = requests.request("GET", url, headers=headers)
print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses");
var request = new RestRequest(Method.GET);
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHORIZATION");
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://sandbox.bond.tech/api/v0.1/businesses")
.get()
.addHeader("Identity", "YOUR-IDENTITY")
.addHeader("Authorization", "YOUR-AUTHORIZATION")
.build();
Response response = client.newCall(request).execute();
An example of a successful request to retrieve all businesses is shown below.
{
"business_id": "96df8579-5d05-4e3e-a5e3-e61e3a5bdb38",
"ein": "12-1234567",
"phone": "+14085557788",
"email": "user@example.com",
"website": "https://www.specter.com",
"legal_business_name": "World Domination Inc.",
"dba_business_name": "World Domination Inc.",
"business_type": "limited_liability_company",
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"addresses": [
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
},
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "67898579-5d05-6789-a5e3-e61e3a5b6789",
"address_type": "PHYSICAL",
"street": "123 California Ave.",
"street2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": false,
"deliverability": "undeliverable"
}
],
"beneficial_owners": [
{
"beneficial_owner_id": "45628579-5d05-4562-a5e3-e61e3a5b4562",
"first_name": "James",
"last_name": "Bond",
"dob": "1970-12-12",
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"addresses": [
{
"address_id": "12347777-5d05-4e3e-a5e3-e61e3a5b7777",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
}
]
},
{
"beneficial_owner_id": "12345678-5d05-4562-a5e3-e61e12345678",
"first_name": "Le",
"last_name": "Chiffre",
"dob": "1980-04-04",
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"addresses": [
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "88887777-5d05-4e3e-a5e3-e61e88887777",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
}
]
}
]
}
To retrieve a single business, use the GET /businesses/{business_id} operation with no further parameters, as shown in the example below.
curl --request GET \
--url https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9 \
--header 'Identity: YOUR-IDENTITY' \
--header 'Authorization: YOUR-AUTHORIZATION' \
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Identity"] = YOUR-IDENTITY
request["Authorization"] = YOUR-AUTHORIZATION
response = http.request(request)
puts response.read_body
const options = {
method: 'GET',
headers: {
Identity: 'YOUR-IDENTITY',
Authorization: 'YOUR-AUTHORIZATION'
}
};
fetch('https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9"
headers = {
"Content-Type": "application/json",
"Identity": YOUR-IDENTITY,
"Authorization": YOUR-AUTHORIZATION
}
response = requests.request("GET", url, headers=headers)
print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9");
var request = new RestRequest(Method.GET);
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHORIZATION");
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9")
.get()
..addHeader("Identity", "YOUR-IDENTITY")
.addHeader("Authorization", "YOUR-AUTHORIZATION")
.build();
Response response = client.newCall(request).execute();
An example of a response to a successful request to retrieve a business is shown below.
{
"business_id": "96df8579-5d05-4e3e-a5e3-e61e3a5bdb38",
"ein": "12-1234567",
"phone": "+14085557788",
"email": "user@example.com",
"website": "https://www.specter.com",
"legal_business_name": "World Domination Inc.",
"dba_business_name": "World Domination Inc.",
"business_type": "limited_liability_company",
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"addresses": [
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
},
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "67898579-5d05-6789-a5e3-e61e3a5b6789",
"address_type": "PHYSICAL",
"street": "123 California Ave.",
"street2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": false,
"deliverability": "undeliverable"
}
],
"beneficial_owners": [
{
"beneficial_owner_id": "45628579-5d05-4562-a5e3-e61e3a5b4562",
"first_name": "James",
"last_name": "Bond",
"dob": "1970-12-12",
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"addresses": [
{
"address_id": "12347777-5d05-4e3e-a5e3-e61e3a5b7777",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
}
]
},
{
"beneficial_owner_id": "12345678-5d05-4562-a5e3-e61e12345678",
"first_name": "Le",
"last_name": "Chiffre",
"dob": "1980-04-04",
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"addresses": [
{
"date_updated": "2019-08-24T14:15:22Z",
"date_created": "2019-08-24T14:15:22Z",
"address_id": "88887777-5d05-4e3e-a5e3-e61e88887777",
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true,
"deliverability": "deliverable"
}
]
}
]
}
For a complete specification and interactive examples, see Retrieve a business and Retrieve all businesses in the Bond API Reference.
Deleting a business
To delete a business, use the DELETE /businesses/{business_id} operation with no further parameters, as shown in the example below.
curl --request DELETE \
--url https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f \
--header 'Identity: YOUR-IDENTITY' \
--header 'Authorization: YOUR-AUTHORIZATION' \
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Identity"] = YOUR-IDENTITY
request["Authorization"] = YOUR-AUTHORIZATION
response = http.request(request)
puts response.read_body
const options = {
method: 'DELETE',
headers: {
Identity: 'YOUR-IDENTITY',
Authorization: 'YOUR-AUTHORIZATION'
}
};
fetch('https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f"
headers = {
"Content-Type": "application/json",
"Identity": YOUR-IDENTITY,
"Authorization": YOUR-AUTHORIZATION
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHORIZATION");
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://sandbox.bond.tech/api/v0.1/businesses/68954424-a754-4919-9aab-3dfc613b0a1f")
.delete(null)
.addHeader("Identity", "YOUR-IDENTITY")
.addHeader("Authorization", "YOUR-AUTHORIZATION")
.build();
Response response = client.newCall(request).execute();
An example of a response to a successful request to delete a business is shown below.
{}
For a complete specification and interactive examples, see Deleting a business in the Bond API Reference.
Updating a business
To update a business, use the PATCH /businesses/{business_id} operation and provide the relevant, optional parameters that you want to update, as shown in the table below.
| Parameter | Type | Description |
|---|---|---|
ein | string | Unique type of tax identification number used to identify the business with the IRS, for example 12-1234599. |
legal_business_name | string | Freeform, alphanumeric, legal name of the business. |
dba_business_name | string | Freeform, alphanumeric, doing-business-as name (trade name). |
business_type | string | Select one of: cooperative, limited_liability_company, sole_proprietorship, partnership, limited_partnership, corporation, nonprofit_organization. |
date_established | date | Date of incorporation in YYYY-MM-DD format, for example 2021-06-28. |
phone | string | Freeform number, for example 01-324-5556684. |
email | string | Business contact email, for example jim_smith@acme.com. |
website | string | The official website, for example www.acme.com. |
An example of a request to update a business_type to cooperative is shown below.
curl --request PATCH \
--url https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9 \
--header 'Accept: application/json' \
--header 'Authorization: YOUR-AUTHENTICATION' \
--header 'Content-Type: application/json' \
--header 'Identity: YOUR-IDENTITY' \
--data @- <<EOF
{
"ein": "12-1234567",
"legal_business_name": "John Doe Business Corporation",
"dba_business_name": "John's",
"business_type": "limited_liability_company",
"date_established": "2020-01-01T00:00:00.000Z",
"phone": "+14157485052",
"email": "info@business.com",
"website": "www.business.com"
}
EOF
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request["Identity"] = 'YOUR-IDENTITY'
request["Authorization"] = 'YOUR-AUTHENTICATION'
request.body = "{\"ein\":\"12-1234567\",\"legal_business_name\":\"John Doe Business Corporation\",\"dba_business_name\":\"John's\",\"business_type\":\"limited_liability_company\",\"date_established\":\"2020-01-01T00:00:00.000Z\",\"phone\":\"12345678989\",\"email\":\"info@business.com\",\"website\":\"www.business.com\"}"
response = http.request(request)
puts response.read_body
const options = {
method: 'PATCH',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Identity: 'YOUR-IDENTITY',
Authorization: 'YOUR-AUTHENTICATION'
},
body: JSON.stringify({
ein: '12-1234567',
legal_business_name: 'John Doe Business Corporation',
dba_business_name: 'John\'s',
business_type: 'limited_liability_company',
date_established: '2020-01-01T00:00:00.000Z',
phone: '12345678989',
email: 'info@business.com',
website: 'www.business.com'
})
};
fetch('https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9"
payload = {
"ein": "12-1234567",
"legal_business_name": "John Doe Business Corporation",
"dba_business_name": "John's",
"business_type": "limited_liability_company",
"date_established": "2020-01-01T00:00:00.000Z",
"phone": "12345678989",
"email": "info@business.com",
"website": "www.business.com"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json",
"Identity": "YOUR-IDENTITY",
"Authorization": "YOUR-AUTHENTICATION"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHENTICATION");
request.AddParameter("application/json", "{\"ein\":\"12-1234567\",\"legal_business_name\":\"John Doe Business Corporation\",\"dba_business_name\":\"John's\",\"business_type\":\"limited_liability_company\",\"date_established\":\"2020-01-01T00:00:00.000Z\",\"phone\":\"12345678989\",\"email\":\"info@business.com\",\"website\":\"www.business.com\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ein\":\"12-1234567\",\"legal_business_name\":\"John Doe Business Corporation\",\"dba_business_name\":\"John's\",\"business_type\":\"limited_liability_company\",\"date_established\":\"2020-01-01T00:00:00.000Z\",\"phone\":\"12345678989\",\"email\":\"info@business.com\",\"website\":\"www.business.com\"}");
Request request = new Request.Builder()
.url("https://sandbox.bond.tech/api/v0.1/businesses/5e9d3360-c788-435e-9488-949c446639d9")
.patch(body)
.addHeader("Accept", "application/json")
.addHeader("Content-Type", "application/json")
.addHeader("Identity", "YOUR-IDENTITY")
.addHeader("Authorization", "YOUR-AUTHENTICATION")
.build();
Response response = client.newCall(request).execute();
An example of a response to a successful request to update the business type to cooperative is shown below.
{
"ein": "12-1234567",
"phone": "+14085557788",
"email": "user@example.com",
"website": "https://www.specter.com",
"legal_business_name": "World Domination Inc.",
"dba_business_name": "World Domination Inc.",
"business_type": "limited_liability_company",
"addresses": [
{
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true
},
{
"address_type": "PHYSICAL",
"street": "123 California Ave.",
"street2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": false
}
],
"beneficial_owners": [
{
"first_name": "James",
"last_name": "Bond",
"dob": "1970-12-12",
"addresses": [
{
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true
}
]
},
{
"first_name": "Le",
"last_name": "Chiffre",
"dob": "1980-04-04",
"addresses": [
{
"address_type": "MAILING",
"street": "345 California Ave.",
"street2": "Suite 600",
"city": "San Francisco",
"state": "CA",
"zip_code": "12345-1234",
"country": "US",
"is_primary": true
}
]
}
]
}
For a complete specification and interactive examples, see Update a business in the Bond API Reference.
Updated about 2 years ago