Verify Address

Status Changelog Dashboard Create a Ticket
Search…
Verify Address
post
https://api.synapsefi.com
/v3.1/address-verification
Verify Address
Example Request
HTTP
Python
JavaScript
Ruby
PHP
Go
1
POST /v3.1/address-verification HTTP/1.1
2
Host: uat-api.synapsefi.com
3
Content-Type: application/json
4
​
5
{
6
    "address_street": "1 Market St. STE 500",
7
    "address_city": "San Francisco",
8
    "address_subdivision": "CA",
9
    "address_postal_code": "94105",
10
    "address_country_code": "US"
11
}
Copied!
1
conn = http.client.HTTPConnection("uat-api,synapsefi,com")
2
​
3
payload = "{
4
​
5
"address_street\": \"1 Market St. STE 500\",\n    \"address_city\": \"San Francisco\",\n    \"address_subdivision\": \"CA\",\n    \"address_postal_code\": \"94105\",\n    \"address_country_code\": \"US\"\n}"
6
​
7
headers = {
8
    'Content-Type': "application/json",
9
    'cache-control': "no-cache",
10
    'Postman-Token': "9f4649ad-9869-401d-b04b-96e145cde414"
11
    }
12
​
13
conn.request("POST", "v3.1,address-verification", payload, headers)
14
​
15
res = conn.getresponse()
16
data = res.read()
17
​
18
print(data.decode("utf-8"))
Copied!
1
var settings = {
2
  "async": true,
3
  "crossDomain": true,
4
  "url": "https://uat-api.synapsefi.com/v3.1/address-verification",
5
  "method": "POST",
6
  "headers": {
7
    "Content-Type": "application/json"
8
  },
9
  "processData": false,
10
  "data": "{\n    \"address_street\": \"1 Market St. STE 500\",\n    \"address_city\": \"San Francisco\",\n    \"address_subdivision\": \"CA\",\n    \"address_postal_code\": \"94105\",\n    \"address_country_code\": \"US\"\n}"
11
}
12
​
13
$.ajax(settings).done(function (response) {
14
  console.log(response);
15
});
Copied!
1
require 'uri'
2
require 'net/http'
3
​
4
url = URI("https://uat-api.synapsefi.com/v3.1/address-verification")
5
​
6
http = Net::HTTP.new(url.host, url.port)
7
​
8
request = Net::HTTP::Post.new(url)
9
request["Content-Type"] = 'application/json'
10
request.body = "{\n    \"address_street\": \"1 Market St. STE 500\",\n    \"address_city\": \"San Francisco\",\n    \"address_subdivision\": \"CA\",\n    \"address_postal_code\": \"94105\",\n    \"address_country_code\": \"US\"\n}"
11
​
12
response = http.request(request)
13
puts response.read_body
Copied!
1
<?php
2
​
3
$request = new HttpRequest();
4
$request->setUrl('https://uat-api.synapsefi.com/v3.1/address-verification');
5
$request->setMethod(HTTP_METH_POST);
6
​
7
$request->setHeaders(array(
8
  'Content-Type' => 'application/json'
9
));
10
​
11
$request->setBody('{
12
    "address_street": "1 Market St. STE 500",
13
    "address_city": "San Francisco",
14
    "address_subdivision": "CA",
15
    "address_postal_code": "94105",
16
    "address_country_code": "US"
17
}');
18
​
19
try {
20
  $response = $request->send();
21
​
22
  echo $response->getBody();
23
} catch (HttpException $ex) {
24
  echo $ex;
25
}
Copied!
1
package main
2
​
3
import (
4
	"fmt"
5
	"strings"
6
	"net/http"
7
	"io/ioutil"
8
)
9
​
10
func main() {
11
​
12
	url := "https://uat-api.synapsefi.com/v3.1/address-verification"
13
​
14
	payload := strings.NewReader("{\n    \"address_street\": \"1 Market St. STE 500\",\n    \"address_city\": \"San Francisco\",\n    \"address_subdivision\": \"CA\",\n    \"address_postal_code\": \"94105\",\n    \"address_country_code\": \"US\"\n}")
15
​
16
	req, _ := http.NewRequest("POST", url, payload)
17
​
18
	req.Header.Add("Content-Type", "application/json")
19
​
20
	res, _ := http.DefaultClient.Do(req)
21
​
22
	defer res.Body.Close()
23
	body, _ := ioutil.ReadAll(res.Body)
24
​
25
	fmt.Println(res)
26
	fmt.Println(string(body))
27
​
28
}
Copied!
Deliverability
Deliverability Result
​
Description
usps_deliverable
✅
Standard supplied address is a USPS deliverable address
deliverable
✅
Address is deliverable based on supplemental check. Check normalized_address object in response for deliverable address to use (e.g. in case "ST" supplied when deliverable address has "AVE")
deliverable_incorrect_unit
✅
Base address is deliverable but supplied unit appears incorrect (e.g. actual unit number may be "APT 103" and original input may point to a non-existent unit like "APT 1003")
deliverable_missing_unit
✅
Base address is deliverable but expected unit was not supplied. Check normalized_address object in response for deliverable address to use
deliverable_unneccessary_unit
✅
Address is deliverable but additional unit supplied when not necessary
google_undeliverable
❌
User will not be verified, please try reentering or inputting a new address
Deliverability Analysis Object
Key
Type
Description
deliverability_analysis. partial_valid
Boolean
True if address is partially valid
deliverability_analysis. primary_number_invalid
Boolean
True if primary address number is invalid
deliverability_analysis. primary_number_missing
Boolean
True if primary address number is missing
deliverability_analysis. secondary_invalid
Boolean
True if secondary address line (e.g. unit) is invalid or unnecessary
deliverability_analysis. secondary_missing
Boolean
Secondary address line (e.g. unit) missing
Dummy Transactions
Verify Routing Number
Last modified 7mo ago
Export as PDF
Copy link
Contents
Deliverability Analysis Object