# Addressfinder

A reliably smart, reliably accurate data quality platform for address, email, and phone verification

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `ADDRESSFINDER`
- **Version:** 00000000_00

## Tools

### AU Address Autocomplete

**Slug:** `ADDRESSFINDER_AU_ADDRESS_AUTOCOMPLETE_API`

Tool to perform interactive search of Australian addresses from the AddressFinder database. Use when you need to search for and autocomplete Australian addresses based on partial input.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | The partial address being searched |
| `max` | integer | No | Maximum results to return (1-100, default: 10) |
| `ascii` | string | No | Convert special characters: 1 for ASCII equivalents |
| `domain` | string | No | Service identifier for activity monitoring |
| `format` | string | No | Response format: json or xml (default: json) |
| `source` | string | No | Address dataset source: GNAF, PAF, or GNAF,PAF (default) |
| `post_box` | string | No | Filter PO Box addresses: 0 (exclude), 1 (only), or omit (include all) |
| `canonical` | string | No | Return canonical/alias addresses: 1 (canonical only) or omit |
| `highlight` | string | No | Enable highlighting: 1 to wrap matches with <span class='af_hl'></span> |
| `state_codes` | string | No | Comma-separated state filters (ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AU Address Metadata

**Slug:** `ADDRESSFINDER_AU_ADDRESS_METADATA`

Tool to retrieve full metadata for an Australian address selected from the Address Autocomplete API. Use when you need complete address details including GPS coordinates and census data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Unique address identifier from Address Autocomplete API. Must supply either id, gnaf_id, or dpid. |
| `gps` | string | No | Set to '1' to include GPS coordinates in the response. |
| `dpid` | string | No | Australia Post delivery point identifier. Must supply either id, gnaf_id, or dpid. |
| `ascii` | string | No | Set to '1' to convert special characters to ASCII. |
| `census` | integer ("2016" | "2021") | No | Census year - 2016 or 2021. Defaults to 2016. |
| `domain` | string | No | Service identifier for activity monitoring. |
| `format` | string ("json" | "xml") | No | Response format - 'json' or 'xml'. Defaults to json. |
| `source` | string | No | Address source - 'GNAF', 'PAF', or 'GNAF,PAF'. Defaults to GNAF,PAF. |
| `gnaf_id` | string | No | Unique id from the G-NAF dataset. Must supply either id, gnaf_id, or dpid. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AU Address Verification

**Slug:** `ADDRESSFINDER_AU_ADDRESS_VERIFICATION`

Tool to verify Australian addresses against PAF/GNAF databases. Use when you need to validate or standardize an Australian address and retrieve associated metadata like coordinates, statistical identifiers, and GNAF data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Full address to be verified (e.g., '274 Harbour Drive, COFFS HARBOUR NSW 2450') |
| `gps` | string | No | Include latitude/longitude coordinates when available. Set to '1' to enable. |
| `paf` | string | No | Query PAF database for postal addresses. Set to '1' to enable (default). |
| `gnaf` | string | No | Query GNAF database for physical addresses. Set to '1' to enable (default). |
| `ascii` | string | No | Convert special characters to ASCII equivalents. Set to '1' to enable. |
| `census` | integer ("2016" | "2021") | No | Census year for statistical area identifiers (2016 or 2021). |
| `domain` | string | No | Service identifier for activity monitoring. |
| `format` | string ("json" | "xml") | No | Response format: 'json' or 'xml'. Defaults to 'json'. |
| `extended` | string | No | Return additional GNAF data (lga_name, lga_type_code, gnaf_id, legal_parcel_id). Set to '1' to enable. |
| `post_box` | string | No | Set to '0' to exclude PO Box-type addresses from results. |
| `state_codes` | string | No | Filter by state(s): ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Comma-separated for multiple states. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AU Location Autocomplete

**Slug:** `ADDRESSFINDER_AU_LOCATION_AUTOCOMPLETE_API`

Tool to perform interactive autocomplete search for Australian streets, suburbs, and states. Use when you need to find or suggest Australian locations based on partial input.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Query string to match against Australian locations (streets, suburbs, states). |
| `max` | integer | No | Maximum number of results to return, range 1-100. Defaults to 10. |
| `domain` | string | No | Service identifier for Portal activity monitoring; must be registered in your account. |
| `format` | string ("json" | "xml") | No | Response format - 'json' or 'xml'. Defaults to 'json'. |
| `secret` | string | No | Secret key from Portal Credentials; required only for server-to-server calls. |
| `highlight` | integer ("0" | "1") | No | Set to 1 to include highlighted matching terms wrapped in <span class='af_hl'></span>. |
| `state_codes` | string | No | Comma-separated state/territory codes to filter by: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. |
| `location_types` | string | No | Comma-separated filter for location types: 'street', 'locality' (suburb), 'state'. Example: 'street,locality'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AU Location Metadata

**Slug:** `ADDRESSFINDER_AU_LOCATION_METADATA_API`

Tool to retrieve comprehensive metadata for an Australian location (street, suburb, or state) selected from the Location Autocomplete API. Use when you need detailed information about a specific Australian location including coordinates, street details, suburb, state, and postcode.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique location identifier from the Location Autocomplete API. This identifies the specific street, suburb, or state to retrieve metadata for. |
| `domain` | string | No | Optional service identifier for tracking activity in the Portal. Must be a registered domain. |
| `format` | string ("json" | "xml") | No | Response format. Either 'json' or 'xml'. Defaults to 'json'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Email Verification API

**Slug:** `ADDRESSFINDER_EMAIL_VERIFICATION_API`

Tool to verify email addresses including syntax validation, domain existence, and email account verification. Use when you need to validate an email address before sending messages or storing contact information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address to be verified. Can contain spelling mistakes or errors that will be validated. |
| `domain` | string | No | Used to identify which of your services is calling the API for activity monitoring purposes. |
| `format` | string ("json" | "xml") | No | Response format - json or xml. Default is json. |
| `features` | string | No | Comma-separated list controlling verification methods: domain, connection, provider. Default: domain,connection |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### International Address Autocomplete

**Slug:** `ADDRESSFINDER_INT_ADDRESS_AUTOCOMPLETE_API`

Tool to search for international addresses using autocomplete functionality. Use when users need to find and select addresses in supported countries (AU, BE, CA, CZ, DK, FR, DE, IE, NZ, NL, PT, SG, ES, SE, GB, US). Returns address IDs that can be used with the Address Metadata API to retrieve full address details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Partial address search query. Maximum 200 characters. This is the text that users type to search for addresses. |
| `max` | integer | No | Maximum number of results to return. Must be between 1 and 15 inclusive. Defaults to 10. |
| `domain` | string | No | Service identifier for Portal activity monitoring. Must be registered in your account. |
| `format` | string ("json" | "xml") | No | Response format - either 'json' or 'xml'. Defaults to 'json'. |
| `secret` | string | No | Secret key from Portal Credentials. Required for server-to-server API calls. |
| `country` | string ("au" | "be" | "ca" | "cz" | "dk" | "fr" | "de" | "ie" | "nz" | "nl" | "pt" | "sg" | "es" | "se" | "gb" | "us") | Yes | ISO 3166 alpha-2 country code for the address search. Supported countries: au (Australia), be (Belgium), ca (Canada), cz (Czech Republic), dk (Denmark), fr (France), de (Germany), ie (Ireland), nz (New Zealand), nl (Netherlands), pt (Portugal), sg (Singapore), es (Spain), se (Sweden), gb (United Kingdom), us (United States). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get International Address Metadata

**Slug:** `ADDRESSFINDER_INT_ADDRESS_METADATA_API`

Tool to retrieve full metadata for an international address selected from the Address Autocomplete API. Use when you need complete address details including street metadata and optional GPS coordinates for addresses outside your primary region.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique address identifier obtained from the Address Autocomplete API. |
| `gps` | integer | No | Include GPS coordinates in the response. Set to 1 to include, 0 to exclude. Default is 0. |
| `domain` | string | No | Used to identify in the Addressfinder Portal which of your services is calling the API. |
| `format` | string | No | Response format: json or xml. Default is json. |
| `country` | string | Yes | ISO 3166 alpha-2 country code (e.g., fr, us, ca, gb, au, nz, be, cz, dk, de, ie, nl, pt, sg, es, se). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### NZ Address Autocomplete

**Slug:** `ADDRESSFINDER_NZ_ADDRESS_AUTOCOMPLETE`

Tool to perform interactive search for New Zealand addresses. Use when you need to find closely matching NZ addresses based on partial address input. The tool searches the Addressfinder database and returns matching addresses which can then be selected by the user. Works with the Address Metadata API to retrieve associated address data using the pxid identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | The partial address being searched. Provide the address query string to search for matching New Zealand addresses. |
| `max` | integer | No | Maximum number of results to return. Defaults to 10. Valid range is 1-100. |
| `ascii` | string | No | Set to '1' to convert special characters to ASCII equivalents in the response. |
| `rural` | string | No | Filter rural vs. urban addresses. Set to '0' for urban addresses only, '1' for rural addresses only. |
| `domain` | string | No | Service identifier for activity monitoring. Used to track and monitor API usage by domain. |
| `format` | string | No | Response format - 'json' or 'xml'. Defaults to json. |
| `strict` | string | No | Match strictness level. '0' for normal matching, '1' for strict matching, '2' for fuzzy matching. |
| `post_box` | string | No | Include or exclude PO Box style addresses. Set to '0' to exclude PO Boxes, '1' to include only PO Boxes. |
| `delivered` | string | No | Filter by NZ Post delivery status. Set to '0' to exclude delivered addresses, '1' to include only delivered addresses. |
| `highlight` | string | No | Set to '1' to wrap matching terms in highlighting span tags in the response. |
| `region_code` | string | No | Filter by NZ region code. Valid codes are 1-9 and A-H representing different New Zealand regions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get NZ Address Metadata

**Slug:** `ADDRESSFINDER_NZ_ADDRESS_METADATA`

Tool to retrieve full metadata for a NZ address including coordinates, census data, and postal details. Use after selecting an address from the Address Autocomplete API to get complete address information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dpid` | string | No | Unique reference number assigned to a delivery address by NZ Post |
| `pxid` | string | No | Unique address identifier obtained from the Address Autocomplete API |
| `ascii` | string | No | Set to 1 to convert special characters to ASCII equivalents |
| `census` | integer | No | Data source year - 2018 or 2023. Default is 2023 |
| `domain` | string | No | Used to identify which service is calling the API for activity monitoring |
| `format` | string | No | Response format - json or xml |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### NZ Address Reverse Geocode

**Slug:** `ADDRESSFINDER_NZ_ADDRESS_REVERSE_GEOCODE`

Tool to reverse geocode NZ addresses from GPS coordinates. Use when you need to find the nearest addresses to a given longitude and latitude. Returns addresses ordered by distance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | string | Yes | Longitude in WGS84 format (example: 174.773068233188) |
| `y` | string | Yes | Latitude in WGS84 format (example: -41.2917018846201) |
| `max` | integer | No | Maximum results to return (1-100, default: 10) |
| `domain` | string | No | Service identifier for portal usage tracking; must be registered |
| `format` | string ("json" | "xml") | No | Response format; accepts 'json' or 'xml' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### NZ Address Verification

**Slug:** `ADDRESSFINDER_NZ_ADDRESS_VERIFICATION_API`

Tool to verify New Zealand addresses against the Addressfinder database. Use when you need to validate and enrich NZ addresses, correct spelling mistakes, or retrieve detailed address metadata including coordinates and postal information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | The address to be verified. Can contain spelling mistakes. |
| `ascii` | string | No | ASCII conversion: '1' reformats special characters to ASCII equivalents. |
| `census` | integer | No | Census year for statistics: 2018 or 2023. Default is 2023. |
| `domain` | string | No | Service identifier for portal tracking purposes. |
| `format` | string | No | Response format: 'json' or 'xml'. Default is 'json'. |
| `secret` | string | No | Secret key from Portal Credentials for server-to-server authentication. |
| `post_box` | string | No | Filter PO Box addresses: '0' excludes PO Boxes, '1' includes only PO Boxes. |
| `region_code` | string | No | Restrict search to specific NZ region. Valid codes are 1-H. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### NZ Location Autocomplete

**Slug:** `ADDRESSFINDER_NZ_LOCATION_AUTOCOMPLETE`

Tool to perform interactive search for New Zealand streets, suburbs, cities, and regions. Use when you need to find or autocomplete location names in New Zealand. Returns closely matching locations with unique identifiers for further metadata lookups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Query string to match against locations (streets, suburbs, cities, regions). Maximum 200 characters. |
| `max` | integer | No | Maximum number of results to return. Must be between 1 and 100. Default: 10 |
| `city` | string ("0" | "1") | No | Set to '0' to exclude cities, '1' for cities only. Omit for all types. |
| `domain` | string | No | Identifies calling service in Addressfinder Portal for analytics. |
| `format` | string ("json" | "xml") | No | Response format - 'json' or 'xml'. Default: json |
| `region` | string ("0" | "1") | No | Set to '0' to exclude regions, '1' for regions only. Omit for all types. |
| `secret` | string | No | Secret key from Portal Credentials; required for server-to-server calls. |
| `street` | string ("0" | "1") | No | Set to '0' to exclude streets, '1' for streets only. Omit for all types. |
| `strict` | string ("0" | "1" | "2") | No | Match strictness - '0' (normal), '1' (strict), '2' (fuzzy). Default: '0' |
| `suburb` | string ("0" | "1") | No | Set to '0' to exclude suburbs, '1' for suburbs only. Omit for all types. |
| `highlight` | integer ("0" | "1") | No | Set to 1 to highlight matched terms with '<span class="af_hl"></span>' tags. |
| `region_code` | string | No | Restrict results to specific region. Codes: 1-9, A-H (e.g., '1' for Northland, 'A' for Canterbury). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get NZ Location Metadata

**Slug:** `ADDRESSFINDER_NZ_LOCATION_METADATA`

Tool to retrieve full metadata for a New Zealand location selected from the Location Autocomplete API. Use when you need detailed information including coordinates and LINZ address data for a specific location.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pxid` | string | Yes | Unique location identifier from the Location Autocomplete API. |
| `domain` | string | No | Used to identify your calling service for usage tracking in the AddressFinder Portal. Must be registered in the Portal. |
| `format` | string ("json" | "xml") | No | Response format - 'json' or 'xml'. |
| `secret` | string | No | Secret key from Portal Credentials; only needed for server-to-server calls. Can also be passed via Authorization header. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### NZ POI Autocomplete

**Slug:** `ADDRESSFINDER_NZ_POI_AUTOCOMPLETE_API`

Tool to perform interactive search for points of interest in New Zealand. Use when you need to find POIs like hospitals, cafes, or schools based on partial name matching.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The query string to match against POI names and addresses |
| `max` | integer | No | Maximum results to return (1-100, default: 10) |
| `domain` | string | No | Used to identify your service in the AddressFinder Portal |
| `format` | string ("json" | "xml") | No | Response format; accepts 'json' or 'xml' |
| `highlight` | integer | No | Set to 1 to include highlighted matching text with <span class='af_hl'></span> |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get NZ POI Metadata

**Slug:** `ADDRESSFINDER_NZPOI_METADATA_API`

Tool to retrieve comprehensive metadata for New Zealand points of interest including coordinates and address details. Use when you need full POI information after selecting from autocomplete API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique POI identifier from the autocomplete API |
| `domain` | string | No | Service identifier in Addressfinder Portal (must be registered) |
| `format` | string ("json" | "xml") | No | Response format - 'json' or 'xml' |
| `secret` | string | No | Secret key from Portal Credentials (required for server-to-server calls) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Phone Verification API

**Slug:** `ADDRESSFINDER_PHONE_VERIFICATION_API`

Tool to verify phone numbers through syntax, range checks, and network verification. Use when you need to validate a phone number's format, line type, and connection status. Returns verified number details including line type, connection status, and formatted representations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | Service identifier for Portal activity monitoring. |
| `format` | string | No | Response format: 'json' or 'xml'. Defaults to 'json'. |
| `timeout` | number | No | Maximum wait time for verification in seconds. |
| `mobile_only` | boolean | No | Require the number to be a mobile phone. Set to True to restrict to mobile numbers only. |
| `phone_number` | string | Yes | The phone number to be verified. |
| `default_country_code` | string | Yes | ISO2 country code used when phone lacks country calling code (e.g., 'AU', 'US', 'GB'). |
| `allowed_country_codes` | string | No | Comma-separated ISO2 country codes restricting valid countries (e.g., 'AU,NZ,US'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |