Create Compliance Address - Kallabot Documentation

POST

/

regulatory

/

addresses

Create Address

curl --request POST \
  --url https://api.kallabot.com/regulatory/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "friendly_name": "Corporate Headquarters",
  "customer_name": "Acme Corporation",
  "street": "123 Business Ave",
  "city": "San Francisco",
  "region": "CA",
  "postal_code": "94105",
  "iso_country": "US",
  "street_secondary": "Suite 100"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    friendly_name: 'Corporate Headquarters',
    customer_name: 'Acme Corporation',
    street: '123 Business Ave',
    city: 'San Francisco',
    region: 'CA',
    postal_code: '94105',
    iso_country: 'US',
    street_secondary: 'Suite 100'
  })
};

fetch('https://api.kallabot.com/regulatory/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kallabot.com/regulatory/addresses"

payload = {
    "friendly_name": "Corporate Headquarters",
    "customer_name": "Acme Corporation",
    "street": "123 Business Ave",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105",
    "iso_country": "US",
    "street_secondary": "Suite 100"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "sid": "<string>",
  "friendly_name": "<string>",
  "customer_name": "<string>",
  "street": "<string>",
  "street_secondary": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postal_code": "<string>",
  "iso_country": "<string>",
  "emergency_enabled": true,
  "validated": true,
  "verified": true,
  "date_created": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z"
}

{
  "error": 123,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

friendly_name

string

required

Display name for address

Example:

"Corporate Headquarters"

customer_name

string

required

Name of customer/business

Example:

"Acme Corporation"

street

string

required

Street address

Example:

"123 Business Ave"

city

string

required

City name

Example:

"San Francisco"

region

string

required

State or province

Example:

"CA"

postal_code

string

required

ZIP or postal code

Example:

"94105"

iso_country

string

required

ISO country code

Example:

"US"

street_secondary

string

Apartment, suite, etc. (optional)

Example:

"Suite 100"

Response

Address created

sid

string

friendly_name

string

customer_name

string

street

string

street_secondary

string

city

string

region

string

postal_code

string

iso_country

string

emergency_enabled

boolean

validated

boolean

verified

boolean

date_created

string<date-time>

date_updated

string<date-time>

Create Address

curl --request POST \
  --url https://api.kallabot.com/regulatory/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "friendly_name": "Corporate Headquarters",
  "customer_name": "Acme Corporation",
  "street": "123 Business Ave",
  "city": "San Francisco",
  "region": "CA",
  "postal_code": "94105",
  "iso_country": "US",
  "street_secondary": "Suite 100"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    friendly_name: 'Corporate Headquarters',
    customer_name: 'Acme Corporation',
    street: '123 Business Ave',
    city: 'San Francisco',
    region: 'CA',
    postal_code: '94105',
    iso_country: 'US',
    street_secondary: 'Suite 100'
  })
};

fetch('https://api.kallabot.com/regulatory/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kallabot.com/regulatory/addresses"

payload = {
    "friendly_name": "Corporate Headquarters",
    "customer_name": "Acme Corporation",
    "street": "123 Business Ave",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105",
    "iso_country": "US",
    "street_secondary": "Suite 100"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "sid": "<string>",
  "friendly_name": "<string>",
  "customer_name": "<string>",
  "street": "<string>",
  "street_secondary": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postal_code": "<string>",
  "iso_country": "<string>",
  "emergency_enabled": true,
  "validated": true,
  "verified": true,
  "date_created": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z"
}

{
  "error": 123,
  "message": "<string>"
}