Filtering addresses

Below is a list of attributes available for filtering addresses.

Attribute	Type
type	string Valid values are main, alternative, and other.
propertyNumber	string
buildingName	string
line	string
city	string
state	string
country	string This will be the two-letter country ISO code.

Example - Get all addresses for one type

In the example below, we will request to get all addresses that are of type main.

cURL

curl -X GET https://api.complycube.com/v1/addresses?clientId={:clientId}&type=main \
     -H 'Authorization: <YOUR_API_KEY>'

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

filtered = cc_api.addresses.list('CLIENT_ID',type='main')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$filtered = $ccapi->address()->list($clientId , ['type' => 'main']);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Addresses;

var addressApi = new AddressApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var filter = new AddressRequest { type = "main" };

var address = await addressApi.ListAsync("CLIENT_ID", filter);