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
POST /v3.1/address-verification HTTP/1.1
Host: uat-api.synapsefi.com
Content-Type: application/json
​
{
    "address_street": "1 Market St. STE 500",
    "address_city": "San Francisco",
    "address_subdivision": "CA",
    "address_postal_code": "94105",
    "address_country_code": "US"
}
conn = http.client.HTTPConnection("uat-api,synapsefi,com")
​
payload = "{
​
"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}"
​
headers = {
    'Content-Type': "application/json",
    'cache-control': "no-cache",
    'Postman-Token': "9f4649ad-9869-401d-b04b-96e145cde414"
    }
​
conn.request("POST", "v3.1,address-verification", payload, headers)
​
res = conn.getresponse()
data = res.read()
​
print(data.decode("utf-8"))
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://uat-api.synapsefi.com/v3.1/address-verification",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json"
  },
  "processData": false,
  "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}"
}
​
$.ajax(settings).done(function (response) {
  console.log(response);
});
require 'uri'
require 'net/http'
​
url = URI("https://uat-api.synapsefi.com/v3.1/address-verification")
​
http = Net::HTTP.new(url.host, url.port)
​
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
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}"
​
response = http.request(request)
puts response.read_body
<?php
​
$request = new HttpRequest();
$request->setUrl('https://uat-api.synapsefi.com/v3.1/address-verification');
$request->setMethod(HTTP_METH_POST);
​
$request->setHeaders(array(
  'Content-Type' => 'application/json'
));
​
$request->setBody('{
    "address_street": "1 Market St. STE 500",
    "address_city": "San Francisco",
    "address_subdivision": "CA",
    "address_postal_code": "94105",
    "address_country_code": "US"
}');
​
try {
  $response = $request->send();
​
  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
package main
​
import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)
​
func main() {
​
	url := "https://uat-api.synapsefi.com/v3.1/address-verification"
​
	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}")
​
	req, _ := http.NewRequest("POST", url, payload)
​
	req.Header.Add("Content-Type", "application/json")
​
	res, _ := http.DefaultClient.Do(req)
​
	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)
​
	fmt.Println(res)
	fmt.Println(string(body))
​
}
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 1yr ago
Export as PDF
Copy link
Outline
Deliverability Analysis Object