Managing Businesses

How to retrieve, delete, and update existing businesses.

Suggest Edits

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/businesses \
     --header 'Identity: YOUR-IDENTITY' \
     --header 'Authorization: YOUR-AUTHORIZATION' \

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sandbox.bond.tech/api/v0/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/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/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/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/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": "[email protected]",
  "website": "https://www.specter.com",
  "legal_business_name": "World Domination Inc.",
  "dba_business_name": "string",
  "business_type": "sole_proprietorship",
  "date_updated": "2019-08-24T14:15:22Z",
  "date_created": "2019-08-24T14:15:22Z",
  "address": [
    {
      "date_created": "2019-08-24T14:15:22Z",
      "date_updated": "2019-08-24T14:15:22Z",
      "address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234",
      "address_type": "MAILING",
      "street": "345 California Ave.",
      "street2": "Suit 600",
      "city": "San Francisco",
      "state": "CA",
      "zip_code": "12345-1234",
      "country": "US",
      "is_primary": true,
      "deliverability": "deliverable"
    },
    {
      "date_created": "2019-08-24T14:15:22Z",
      "date_updated": "2019-08-24T14:15:22Z",
      "address_id": "67898579-5d05-6789-a5e3-e61e3a5b6789",
      "address_type": "PHYSICAL",
      "street": "123 California Ave.",
      "street2": "Suit 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",
      "date_created": "2019-08-24T14:15:22Z",
      "date_updated": "2019-08-24T14:15:22Z",
      "dob": "1990-04-04",
      "address": [
        {
          "date_created": "2019-08-24T14:15:22Z",
          "date_updated": "2019-08-24T14:15:22Z",
          "address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234",
          "address_type": "MAILING",
          "street": "345 California Ave.",
          "street2": "Suit 600",
          "city": "San Francisco",
          "state": "CA",
          "zip_code": "12345-1234",
          "country": "US",
          "is_primary": true,
          "deliverability": "deliverable"
        },
        {
          "date_created": "2019-08-24T14:15:22Z",
          "date_updated": "2019-08-24T14:15:22Z",
          "address_id": "67898579-5d05-6789-a5e3-e61e3a5b6789",
          "address_type": "PHYSICAL",
          "street": "123 California Ave.",
          "street2": "Suit 100",
          "city": "San Francisco",
          "state": "CA",
          "zip_code": "12345-1234",
          "country": "US",
          "is_primary": false,
          "deliverability": "undeliverable"
        }
      ],
    },
    {
      "beneficial_owner_id": "12345678-5d05-4562-a5e3-e61e12345678",
      "first_name": "Le",
      "last_name": "Chiffre",
      "date_created": "2019-08-24T14:15:22Z",
      "date_updated": "2019-08-24T14:15:22Z",
      "dob": "1990-04-04",
      "address": [
        {
          "date_created": "2019-08-24T14:15:22Z",
          "date_updated": "2019-08-24T14:15:22Z",
          "address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234",
          "address_type": "MAILING",
          "street": "345 California Ave.",
          "street2": "Suit 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 other parameters, as shown in the example below.

curl --request GET \
  --url https://sandbox.bond.tech/api/v0/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/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/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/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/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/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 with the business_id of 5e9d3360-c788-435e-9488-949c446639d9 is shown below.

{
	"date_created":"2021-06-18T12:13:22.623220+00:00",
	"date_updated":"2021-06-18T12:13:22.623228+00:00",
	"addresses":[
	{
		"date_created":"2021-06-18T12:13:22.634953+00:00",
		"date_updated":"2021-06-18T12:13:22.634960+00:00",
		"address_id":"d935b32c-65ae-4d94-bcfe-c9e0c91f3a48",
		"address_type":"PHYSICAL",
		"street":"222 California Ave.",
		"street2":"Suit 770",
		"city":"San Francisco",
		"state":"CA",
		"zip_code":"12345-1234",
		"country":"US",
		"is_primary":true,
		"deliverability":NULL	
	}
],
	"beneficial_owners":[
	{
		"date_created":"2021-06-18T12:13:22.645164+00:00",
		"date_updated":"2021-06-18T12:13:22.645171+00:00",
		"addresses":[
		{
			"date_created":"2021-06-18T12:13:22.648809+00:00",
			"date_updated":"2021-06-18T12:13:22.648815+00:00",
			"address_id":"c2c1385a-6c95-4fe3-9d33-4eac94c3e48e",
			"address_type":"PHYSICAL",
			"street":"345 California Ave.",
			"street2":"Suit 600",
			"city":"San Francisco",
			"state":"CA",
			"zip_code":"12345-1234",
			"country":"US",
			"is_primary":true,
			"deliverability":NULL
		}
],
		"beneficial_owner_id":"24568387-688e-46d5-8778-60b8c674bb69",
		"first_name":"John",
		"middle_name":NULL,
		"last_name":"Pasakovitch",
		"dob":"1992-12-12"
	}
],
	"business_id":"5e9d3360-c788-435e-9488-949c446639d9",
	"ein":"12-1234588",
	"legal_business_name":"Benny's Deli",
	"dba_business_name":"Benny's",
	"business_type":"partnership",
	"date_established":"2020-01-01",
	"phone":"+12345678989",
	"email":NULL,
	"website":"www.bennys.com"
}

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 other parameters, as shown in the example below.

curl --request DELETE \
  --url https://sandbox.bond.tech/api/v0/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/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/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/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/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/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 with the business_id of 68954424-a754-4919-9aab-3dfc613b0a1f is shown below.

{
  "date_created":"2021-06-24T13:01:29.529849+00:00",
  "date_deleted":"2021-06-24T13:03:22.803407+00:00",
  "addresses":[...],
  "beneficial_owners":[...],
  "business_id":"68954424-a754-4919-9aab-3dfc613b0a1f",
  "ein":"12-1234770",
  "legal_business_name":"Q Takeaways",
  "dba_business_name":"Q Takeaways",
  "business_type":"cooperative",
  "date_established":"2020-01-01",
  "phone":"+12345678770",
  "email":"[email protected]",
  "website":"www.q-takeaways.com"
}

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.

ParameterTypeDescription
einstringUnique type of tax identification number used to identify the business with the IRS, for example 12-1234599.
legal_business_namestringFreeform, alphanumeric, legal name of the business.
dba_business_namestringFreeform, alphanumeric, doing-business-as name (trade name).
business_typestringSelect one of: cooperative, limited_liability_company, sole_proprietorship, partnership, limited_partnership, corporation, nonprofit_organization
date_establisheddateDate of incorporation in YYYY-MM-DD format, for example 2021-06-28
phonestringFreeform number, for example 01-324-5556684
emailstringBusiness contact email of the form [email protected]
websitestringThe official website of the form 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/businesses/5e9d3360-c788-435e-9488-949c446639d9 \
  --header 'Identity: YOUR-IDENTITY' \
  --header 'Authorization: YOUR-AUTHORIZATION' \
  --header 'Content-Type: application/json' \
  --data '
{
     "business_type": "cooperative"
}

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sandbox.bond.tech/api/v0/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["Content-Type"] = 'application/json'
request["Identity"] = YOUR-IDENTITY
request["Authorization"] = YOUR-AUTHORIZATION
request.body = "{\"business_type\":\"cooperative\"}"

response = http.request(request)
puts response.read_body

const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    Identity: 'de9960e3-5af8-455a-9034-bbd4072d23d4',
    Authorization: 'RBF0ye9R5m9cpaOSRk/vY8/VqCVGWy/AV/qdZMPG/6s58aoK6WKyZ8D4W6jemiUY'
  },
  body: JSON.stringify({business_type: 'cooperative'})
};

fetch('https://sandbox.bond.tech/api/v0/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/businesses/5e9d3360-c788-435e-9488-949c446639d9"

payload = {"business_type": "cooperative"}
headers = {
  "Content-Type": "application/json",
  "Identity": YOUR-IDENTITY,
  "Authorization": YOUR-AUTHORIZATION
}

response = requests.request("PATCH", url, json=payload, headers=headers)

print(response.text)

var client = new RestClient("https://sandbox.bond.tech/api/v0/businesses/5e9d3360-c788-435e-9488-949c446639d9");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHORIZATION");
request.AddParameter("application/json", "{\"business_type\":\"cooperative\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"business_type\":\"cooperative\"}");
Request request = new Request.Builder()
  .url("https://sandbox.bond.tech/api/v0/businesses/5e9d3360-c788-435e-9488-949c446639d9")
  .patch(body)
  .addHeader("Content-Type", "application/json")
  .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 update the business type to cooperative is shown below.

{
	"date_created":"2021-06-18T12:13:22.623220+00:00",
	"date_updated":"2021-06-24T12:50:57.631590+00:00",
	"addresses":[...],
	"beneficial_owners":[...],
	"business_id":"5e9d3360-c788-435e-9488-949c446639d9",
	"ein":"12-1234588",
	"legal_business_name":"Benny's Deli",
	"dba_business_name":"Benny's",
	"business_type":"cooperative",
	"date_established":"2020-01-01",
	"phone":"+12345678989",
	"email":NULL,
	"website":"www.bennys.com"
}

For a complete specification and interactive examples, see Update a business in the Bond API Reference.

Updated about 2 years ago

Next Steps