VIP Address

Query and manage (add/remove) VIP Address data.
Key Name values are case sensitive, they must be lower case, address values are not case sensitive.
The delimiter is also case sensitive and must be exactly "%0A"
Note that all addresses submitted via the Restful API are “normalized” through our address service.

Endpoints

/rpc/v1/vip/address.html
The browsable documentation for this API endpoint.
/rpc/v1/vip/address.json
Endpoint that will return a JSON response.
/rpc/v1/vip/address.xml
Endpoint that will return an XML response.

Usage

Usage for HTTP GET

Key Name: ba
Bill Address to look up (optional).
Key Name: sa
Shipping Address to look up (optional).
Must provide one Key/Value pair, batch is NOT supported. The status code (review, decline, etc) will be returned. The value is a newline (\n) delimited address as shown below.
Example: ba=address1%0Aaddress2%0Acity%0A state%0Apostal code%0Acountry code
In GET only, spaces in any field of the address must be URL encoded to exacly "%20".
Example for address1: "123 First Street" must be "123%20First%20Street"
Other special characters may also need to be URL encoded.

Usage for HTTP POST

Key Name: r_ba[]
Review Bill Address to ADD to the Vip List (optional).
Key Name: r_sa[]
Review Shipping Address to ADD to the Vip List (optional).
Key Name: d_ba[]
Decline Bill Address to ADD to the Vip List (optional).
Key Name: d_sa[]
Decline Shipping Address to ADD to the Vip List (optional).
Key Name: x_ba[]
Delete Bill Address to DELETE from the Vip List (optional).
Key Name: x_sa[]
Delete Shipping Address to DELETE from the Vip List (optional).
Must provide at least one Key/Value pair, multiple pairs will be handled as a batch request. Brackets are required or only the last batch item will be handled. The value is a newline (\n) delimited address as shown below.
Example (without and with example values):
r_ba[]=AddressLine1%0AAddressLine2%0ACity%0AState or Region%0APostal Code%0ACountry Code
r_ba[]=54401 County Road%0AAPT 4%0AAstor%0AFL%0A32102%0AUS

Address in Example:
54401 Country Road
Apt 4
Astor, FL 32102
US

Error Codes

206 Partial Success
In batch requests, this signifies that there were a mix of successes and failures.
400 Validation
Incorrect/Invalid input data.
401 Authentication
The key provided could not be authenticated

Response Samples

Successful Response: GET [XML]
<?xml version="1.0" encoding="UTF-8"?>
<response>
 <status>ok</status>
 <count>
  <success>1</success>
  <failure>0</failure>
 </count>
 <errors/>
 <result>review</result>
</response>
Successful Response: GET [JSON]
{"status":"ok","count":{"success":1,"failure":0},"errors":[],"result":"review"}

Code Examples

POST
curl -d "r_ba[]=address1a%0Aaddress2a%0Acity%0Astate%0Apostal_code%0Acountry_code" \
     -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
     https://api.kount.net/rpc/v1/vip/address.json
POST (batch)
curl -d "r_ba[]=address1a%0Aaddress2a%0Acity%0Astate%0Apostal_code%0Acountry_code" \
     -d "r_ba[]=address1b%0Aaddress2b%0Acity%0Astate%0Apostal_code%0Acountry_code" \
     -d "r_sa[]=address1c%0Aaddress2c%0Acity%0Astate%0Apostal_code%0Acountry_code" \
     -d "d_ba[]=address1d%0Aaddress2d%0Acity%0Astate%0Apostal_code%0Acountry_code" \
     -d "x_ba[]=address1e%0Aaddress2e%0Acity%0Astate%0Apostal_code%0Acountry_code" \
	 -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
     https://api.kount.net/rpc/v1/vip/address.xml
GET
curl -G \
     -d "ba=address1a%0Aaddress2a%0Acity%0Astate%0Apostal_code%0Acountry_code" \
	 -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
     https://api.kount.net/rpc/v1/vip/address.json