Managing Beneficial Owner Addresses

How to add, delete, and update existing Beneficial Owner addresses.

Use the operations shown below to manage Beneficial Owner addresses:

Creating a Beneficial Owner's address

To create a Beneficial Owner's address, use the POST /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses operation and provide parameters as shown in the table below.

ParameterTypeDescription
address_type
required
stringMAILING or PHYSICAL
street
required
stringFreeform name between 1 and 40 characters. May contain only alphanumeric and these special characters . , _ - #
street2stringFreeform name, maximum 40 characters.
city
required
stringFreeform name between 2 and 40 characters.
state
required
stringTwo-character US state code. Non-US state code maximum 20 characters.
zip_code
required
stringFive-digit US zip code, (for example 12345) or nine-digit US zip code, (for example 12345-1234).
Non-US state code maximum 20 characters.
country
required
stringISO 3166-1 alpha-2 country code, maximum two characters.
is_primary
required
booleanIs this the primary address; either true or false.

An example of a request to create a Beneficial Owner's address is shown below.

curl --request GET \ --url https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6 \ --header 'Accept: application/json' \ --header 'Authorization: YOUR-AUTHENTICATION' \ --header 'Identity: YOUR-IDENTITY'
require 'uri' require 'net/http' require 'openssl' url = URI("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/json' request["Identity"] = 'YOUR-IDENTITY' request["Authorization"] = 'YOUR-AUTHENTICATION' response = http.request(request) puts response.read_body
const options = { method: 'GET', headers: { Accept: 'application/json', Identity: 'YOUR-IDENTITY', Authorization: 'YOUR-AUTHENTICATION' } }; fetch('https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6', 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/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6" headers = { "Accept": "application/json", "Identity": "YOUR-IDENTITY", "Authorization": "YOUR-AUTHENTICATION" } response = requests.get(url, headers=headers) print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/json"); request.AddHeader("Identity", "YOUR-IDENTITY"); request.AddHeader("Authorization", "YOUR-AUTHENTICATION"); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/002e0f0e-e39d-4351-876c-afcad30d9c37/addresses/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6") .get() .addHeader("Accept", "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 create a Beneficial Owner's address is shown below.

{ "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" }

For a complete specification and interactive examples, see Creating a Beneficial Owner's address in the Bond API Reference.

Retrieving addresses associated with a Beneficial Owner

To retrieve all addresses associated with a Beneficial Owner, use the GET /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses operation with no further parameters.

An example of a request to retrieve the addresses associated with a Beneficial Owner is shown below.

curl --request GET \ --url https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845 \ --header 'Accept: application/json' \ --header 'Authorization: YOUR-AUTHENTICATION' \ --header 'Identity: YOUR-IDENTITY'
require 'uri' require 'net/http' require 'openssl' url = URI("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/json' request["Identity"] = 'YOUR-IDENTITY' request["Authorization"] = 'YOUR-AUTHENTICATION' response = http.request(request) puts response.read_body
const options = { method: 'GET', headers: { Accept: 'application/json', Identity: 'YOUR-IDENTITY', Authorization: 'YOUR-AUTHENTICATION' } }; fetch('https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845', 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/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845" headers = { "Accept": "application/json", "Identity": "YOUR-IDENTITY", "Authorization": "YOUR-AUTHENTICATION" } response = requests.get(url, headers=headers) print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/json"); request.AddHeader("Identity", "YOUR-IDENTITY"); request.AddHeader("Authorization", "YOUR-AUTHENTICATION"); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/e2b37ab8-5e6e-4538-bbe0-35121b481845") .get() .addHeader("Accept", "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 retrieve all business addresses associated with a Beneficial Owner is shown below.

{ "page_info": { "page_size": 2, "page": 1, "pages": 1 }, "data": [ { "date_created": "2019-08-24T14:15:22.000Z", "date_updated": "2020-06-24T14:15:22.000Z", "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_created": "2019-08-24T14:15:22.000Z", "date_updated": "2021-04-24T14:15:22.000Z", "address_id": "12348579-5d05-4e3e-a5e3-e61e3a5b1234", "address_type": "MAILING", "street": "123 Oregon Ave.", "street2": "Suite 100", "city": "San Portier", "state": "AL", "zip_code": "12345-1234", "country": "US", "is_primary": false, "deliverability": "deliverable" } ] }

To retrieve a single business address associated with a Beneficial Owner, use the GET /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses/{address_id} operation with no further parameters.

An example of a request to retrieve an address associated with a Beneficial Owner is shown below.

curl --request GET \ --url https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402 \ --header 'Accept: application/json' \ --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/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/12348579-5d05-4e3e-a5e3-e61e3a5b1234") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/json' request["Identity"] = 'YOUR-IDENTITY' request["Authorization"] = 'YOUR-AUTHORIZATION' response = http.request(request) puts response.read_body
const options = { method: 'GET', headers: {Accept: 'application/json', Identity: 'YOUR-IDENTITY', Authorization: 'YOUR-AUTHORIZATION'} }; fetch('https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/12348579-5d05-4e3e-a5e3-e61e3a5b1234', 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/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/12348579-5d05-4e3e-a5e3-e61e3a5b1234" headers = { "Accept": "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/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/12348579-5d05-4e3e-a5e3-e61e3a5b1234"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/json"); request.AddHeader("Authorization", "YOUR-AUTHORIZATION"); request.AddHeader("Identity", "YOUR-IDENTITY"); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/12348579-5d05-4e3e-a5e3-e61e3a5b1234") .get() .addHeader("Accept", "application/json") .addHeader("Identity", "YOUR-IDENTITY") .addHeader("Authorization", "YOUR-AUTHORIZATION") .build(); Response response = client.newCall(request).execute();

For a complete specification and interactive examples, see Retrieving an address associated with a Beneficial Owner and Retrieving all addresses associated with a Beneficial Owner.

Updating a Beneficial Owner's address

To update a Beneficial Owner's address, use the PATCH /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses/{address_id} operation and provide the optional parameters that you want to update, as shown in the table below.

ParameterTypeDescription
address_typestringEither MAILING or PHYSICAL
streetstringFreeform name between 1 and 40 characters. May contain only alphanumeric and these special characters . , _ - #
street2stringFreeform name maximum 40 characters.
citystringFreeform name between 2 and 40 characters.
statestringTwo-character US state code. Non-US state code maximum 20 characters.
zip_codestringFive-digit US zip code, (for example 12345) or nine-digit US zip code, (for example 12345-1234).
Non-US state code between 2 and 20 characters.
countrystringISO 3166-1 alpha-2 country code, maximum two characters.
is_primarybooleanIs this the primary address; either true or false.

An example of a request to update a Beneficial Owner's address is shown below.

curl --request PATCH \ --url https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402 \ --header 'Accept: application/json' \ --header 'Identity: YOUR-IDENTITY' \ --header 'Authorization: YOUR-AUTHORIZATION' \ --header 'Content-Type: application/json'
require 'uri' require 'net/http' require 'openssl' url = URI("https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402") 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-AUTHORIZATION' request.body = "{\"address_type\":\"PHYSICAL\",\"street\":\"345 California Ave.\",\"street2\":\"Suite 888\",\"city\":\"San Francisco\",\"state\":\"CA\",\"zip_code\":\"12345-1234\",\"country\":\"US\",\"is_primary\":false}" 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-AUTHORIZATION' }, body: JSON.stringify({ address_type: 'PHYSICAL', street: '345 California Ave.', street2: 'Suite 888', city: 'San Francisco', state: 'CA', zip_code: '12345-1234', country: 'US', is_primary: false }) }; fetch('https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402', 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/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402" payload = { "address_type": "PHYSICAL", "street": "345 California Ave.", "street2": "Suite 888", "city": "San Francisco", "state": "CA", "zip_code": "12345-1234", "country": "US", "is_primary": False } headers = { "Accept": "application/json", "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.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402"); 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-AUTHORIZATION"); request.AddParameter("application/json", "{\"address_type\":\"PHYSICAL\",\"street\":\"345 California Ave.\",\"street2\":\"Suite 888\",\"city\":\"San Francisco\",\"state\":\"CA\",\"zip_code\":\"12345-1234\",\"country\":\"US\",\"is_primary\":false}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"address_type\":\"PHYSICAL\",\"street\":\"345 California Ave.\",\"street2\":\"Suite 888\",\"city\":\"San Francisco\",\"state\":\"CA\",\"zip_code\":\"12345-1234\",\"country\":\"US\",\"is_primary\":false}"); Request request = new Request.Builder() .url("https://sandbox.bond.tech/api/v0.1/businesses/002e0f0e-e39d-4351-876c-afcad30d9c37/beneficial_owners/3a7fe4e4-79a4-4a58-942a-c3d00a2406a6/addresses/148050c1-3dee-41fb-a924-7cae7518b402") .patch(body) .addHeader("Accept", "application/json") .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 a Beneficial Owner's address is shown below.

{ "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 Updating a Beneficial Owner's address.

Deleting a Beneficial Owner's address

To delete a Beneficial Owner's address, use the DELETE /businesses/{business_id}/beneficial_owners/{beneficial_owner_id}/addresses/{address_id} operation with no other parameters, as shown in the example below.

curl --request DELETE \ --url https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34 \ --header 'Accept: application/json' \ --header 'Authorization: YOUR-AUTHENTICATION' \ --header 'Identity: YOUR-IDENTITY'
require 'uri' require 'net/http' require 'openssl' url = URI("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Delete.new(url) request["Accept"] = 'application/json' request["Identity"] = 'YOUR-IDENTITY' request["Authorization"] = 'YOUR-AUTHENTICATION' response = http.request(request) puts response.read_body
const options = { method: 'DELETE', headers: { Accept: 'application/json', Identity: 'YOUR-IDENTITY', Authorization: 'YOUR-AUTHENTICATION' } }; fetch('https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34', 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/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34" headers = { "Accept": "application/json", "Identity": "YOUR-IDENTITY", "Authorization": "YOUR-AUTHENTICATION" } response = requests.delete(url, headers=headers) print(response.text)
var client = new RestClient("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34"); var request = new RestRequest(Method.DELETE); request.AddHeader("Accept", "application/json"); request.AddHeader("Identity", "YOUR-IDENTITY"); request.AddHeader("Authorization", "YOUR-AUTHENTICATION"); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://sandbox.bond.tech/api/v0.1/businesses/12348579-5d05-4e3e-a5e3-e61e3a5b1234/beneficial_owners/7b18da9e-0217-4ecb-8454-8c0ab8bedc14/addresses/8559dec0-2edb-4c3c-a3c5-32de10174c34") .delete(null) .addHeader("Accept", "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 delete a Beneficial Owner's address is shown below.

{ "date_created": "2019-08-24T14:15:22Z", "date_deleted": "2019-08-19:22: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" }

For a complete specification and interactive examples, see Deleting a Beneficial Owner's address.


Did this page help you?