Overview

The address validation module is used for validating any number of domestic or international physical addresses. There are currently two resources available for use: one for validating a single address, and one for validating a batch of addresses. Each resource accepts a JSON object as a parameter and must be accessed using HTTP POST.

Authentication

In order to access any of the available resources, an authorization header must be added to the HTTP request. The authorization header needs to be present in the following format:
Authorization: Basic [secret key]
The secret key is basically a password that will be generated and provided to a user that needs to access the Connect Services API.

Content Type

The content type must be present in the HTTP request header in order to describe the incoming and outgoing payload as a JSON object. The header value must be present in the following format:
Content-Type: application/json

Resource Details

Verify Address (single address)

	Value	Example
Route	[domain]/api/addressvalidation/verifyaddress	http://fsravsdev.servercore.cc/api/addressvalidation/verifyaddress
HTTP Verb	POST	N/A
HTTP Header	Content-Type: application/json Authorization: Basic [secret key]	Content-Type: application/json Authorization: Basic mDkdimd73MCcmf3kS9
Body

The figure below describes what is returned by the service:

Verify Addresses (batch of addresses)

	Value	Example
Route	[domain]/api/addressvalidation/verifyaddressbatch	http://fsravsdev.servercore.cc/api/addressvalidation/verifyaddressbatch
HTTP Verb	POST	N/A
HTTP Header	Content-Type: application/json Authorization: Basic [secret key]	Content-Type: application/json Authorization: Basic mDkdimd73MCcmf3kS9
Body

The figure below describes what is returned by the service:

Status Codes

The following table shows all statuses that can be returned: