Address validation (v1) - Fabric
Address validation (v1)
cURL
curl --request POST \
--url https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '
{
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"country": "<string>",
"line2": "<string>",
"line3": "<string>",
"postalCode": "<string>"
}
'
Python
import requests
url = "https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate"
payload = {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"country": "<string>",
"line2": "<string>",
"line3": "<string>",
"postalCode": "<string>"
}
headers = {
"x-site-context": "<x-site-context>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {
method: 'POST',
headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
body: JSON.stringify({
line1: '<string>',
city: '<string>',
region: '<string>',
country: '<string>',
line2: '<string>',
line3: '<string>',
postalCode: '<string>'
})
};
fetch('https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'line1' => '<string>',
'city' => '<string>',
'region' => '<string>',
'country' => '<string>',
'line2' => '<string>',
'line3' => '<string>',
'postalCode' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-site-context: <x-site-context>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
Go
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate"
payload := strings.NewReader("{\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"postalCode\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Unirest (Java)
HttpResponse<String> response = Unirest.post("https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate")
.header("x-site-context", "<x-site-context>")
.header("Content-Type", "application/json")
.body("{\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"postalCode\": \"<string>\"}\n")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://prod01-apigw.yourcompany.fabric.zone/api-tax/v1/address/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"postalCode\": \"<string>\"}\n"
response = http.request(request)
puts response.read_body
Response
200
{
"addressValid": true,
"validatedAddrSuggestions": [
{
"addressType": "UnknownAddressType",
"line1": "761 5TH AVE",
"line2": "<string>",
"line3": "<string>",
"city": "NEW YORK",
"region": "NY",
"country": "US",
"postalCode": "10153",
"latitude": 40.76368,
"longitude": -73.973311
}
],
"addressesFound": 1
}
Example Error Responses
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}
Headers
- x-site-context: string (required)
Thex-site-contextheader is a JSON object that contains information about the source you wish to pull from. The mandatoryaccountis the 24 character identifier found in Copilot. Thechannel(Sales channel ID),stage(environment name), anddateattributes can be used to further narrow the scope of your data source.
Example:"{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}"
Body
- application/json
- line1: string (required)
- city: string (required)
- region: string (required)
- country: string (required)
- line2: string
- line3: string
- postalCode: string
Response
200: application/json
addressValid: boolean
Example:truevalidatedAddrSuggestions: object[]
addressesFound: integer
Example:1