NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Addressfinder

addressfinder

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

Developer ToolsWeb del proveedor
Acciones
17
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (17)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

AU Address AutocompleteADDRESSFINDER_AU_ADDRESS_AUTOCOMPLETE_APIAcción

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.

Parámetros de entrada

  • qstring

    The partial address being searched

  • maxinteger

    Maximum results to return (1-100, default: 10)

  • asciistring

    Convert special characters: 1 for ASCII equivalents

  • domainstring

    Service identifier for activity monitoring

  • formatstring

    Response format: json or xml (default: json)

  • sourcestring

    Address dataset source: GNAF, PAF, or GNAF,PAF (default)

  • post_boxstring

    Filter PO Box addresses: 0 (exclude), 1 (only), or omit (include all)

  • canonicalstring

    Return canonical/alias addresses: 1 (canonical only) or omit

  • highlightstring

    Enable highlighting: 1 to wrap matches with <span class='af_hl'></span>

  • state_codesstring

    Comma-separated state filters (ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AU Address MetadataADDRESSFINDER_AU_ADDRESS_METADATAAcción

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.

Parámetros de entrada

  • idstring

    Unique address identifier from Address Autocomplete API. Must supply either id, gnaf_id, or dpid.

  • gpsstring

    Set to '1' to include GPS coordinates in the response.

  • dpidstring

    Australia Post delivery point identifier. Must supply either id, gnaf_id, or dpid.

  • asciistring

    Set to '1' to convert special characters to ASCII.

  • censusintegerenum

    Census year - 2016 or 2021. Defaults to 2016.

    20162021
  • domainstring

    Service identifier for activity monitoring.

  • formatstringenum

    Response format - 'json' or 'xml'. Defaults to json.

    jsonxml
  • sourcestring

    Address source - 'GNAF', 'PAF', or 'GNAF,PAF'. Defaults to GNAF,PAF.

  • gnaf_idstring

    Unique id from the G-NAF dataset. Must supply either id, gnaf_id, or dpid.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

AU Address VerificationADDRESSFINDER_AU_ADDRESS_VERIFICATIONAcción

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.

Parámetros de entrada

  • qstringObligatorio

    Full address to be verified (e.g., '274 Harbour Drive, COFFS HARBOUR NSW 2450')

  • gpsstring

    Include latitude/longitude coordinates when available. Set to '1' to enable.

  • pafstring

    Query PAF database for postal addresses. Set to '1' to enable (default).

  • gnafstring

    Query GNAF database for physical addresses. Set to '1' to enable (default).

  • asciistring

    Convert special characters to ASCII equivalents. Set to '1' to enable.

  • censusintegerenum

    Census year for statistical area identifiers (2016 or 2021).

    20162021
  • domainstring

    Service identifier for activity monitoring.

  • formatstringenum

    Response format: 'json' or 'xml'. Defaults to 'json'.

    jsonxml
  • extendedstring

    Return additional GNAF data (lga_name, lga_type_code, gnaf_id, legal_parcel_id). Set to '1' to enable.

  • post_boxstring

    Set to '0' to exclude PO Box-type addresses from results.

  • state_codesstring

    Filter by state(s): ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Comma-separated for multiple states.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

AU Location AutocompleteADDRESSFINDER_AU_LOCATION_AUTOCOMPLETE_APIAcción

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.

Parámetros de entrada

  • qstringObligatorio

    Query string to match against Australian locations (streets, suburbs, states).

  • maxinteger

    Maximum number of results to return, range 1-100. Defaults to 10.

  • domainstring

    Service identifier for Portal activity monitoring; must be registered in your account.

  • formatstringenum

    Response format - 'json' or 'xml'. Defaults to 'json'.

    jsonxml
  • secretstring

    Secret key from Portal Credentials; required only for server-to-server calls.

  • highlightintegerenum

    Set to 1 to include highlighted matching terms wrapped in <span class='af_hl'></span>.

    01
  • state_codesstring

    Comma-separated state/territory codes to filter by: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT.

  • location_typesstring

    Comma-separated filter for location types: 'street', 'locality' (suburb), 'state'. Example: 'street,locality'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AU Location MetadataADDRESSFINDER_AU_LOCATION_METADATA_APIAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique location identifier from the Location Autocomplete API. This identifies the specific street, suburb, or state to retrieve metadata for.

  • domainstring

    Optional service identifier for tracking activity in the Portal. Must be a registered domain.

  • formatstringenum

    Response format. Either 'json' or 'xml'. Defaults to 'json'.

    jsonxml

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Email Verification APIADDRESSFINDER_EMAIL_VERIFICATION_APIAcción

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.

Parámetros de entrada

  • emailstringObligatorio

    The email address to be verified. Can contain spelling mistakes or errors that will be validated.

  • domainstring

    Used to identify which of your services is calling the API for activity monitoring purposes.

  • formatstringenum

    Response format - json or xml. Default is json.

    jsonxml
  • featuresstring

    Comma-separated list controlling verification methods: domain, connection, provider. Default: domain,connection

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

International Address AutocompleteADDRESSFINDER_INT_ADDRESS_AUTOCOMPLETE_APIAcción

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.

Parámetros de entrada

  • qstringObligatorio

    Partial address search query. Maximum 200 characters. This is the text that users type to search for addresses.

  • maxinteger

    Maximum number of results to return. Must be between 1 and 15 inclusive. Defaults to 10.

  • domainstring

    Service identifier for Portal activity monitoring. Must be registered in your account.

  • formatstringenum

    Response format - either 'json' or 'xml'. Defaults to 'json'.

    jsonxml
  • secretstring

    Secret key from Portal Credentials. Required for server-to-server API calls.

  • countrystringObligatorioenum

    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).

    aubecaczdkfrdeienznlptsg+4

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get International Address MetadataADDRESSFINDER_INT_ADDRESS_METADATA_APIAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique address identifier obtained from the Address Autocomplete API.

  • gpsinteger

    Include GPS coordinates in the response. Set to 1 to include, 0 to exclude. Default is 0.

  • domainstring

    Used to identify in the Addressfinder Portal which of your services is calling the API.

  • formatstring

    Response format: json or xml. Default is json.

  • countrystringObligatorio

    ISO 3166 alpha-2 country code (e.g., fr, us, ca, gb, au, nz, be, cz, dk, de, ie, nl, pt, sg, es, se).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

NZ Address AutocompleteADDRESSFINDER_NZ_ADDRESS_AUTOCOMPLETEAcción

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.

Parámetros de entrada

  • qstring

    The partial address being searched. Provide the address query string to search for matching New Zealand addresses.

  • maxinteger

    Maximum number of results to return. Defaults to 10. Valid range is 1-100.

  • asciistring

    Set to '1' to convert special characters to ASCII equivalents in the response.

  • ruralstring

    Filter rural vs. urban addresses. Set to '0' for urban addresses only, '1' for rural addresses only.

  • domainstring

    Service identifier for activity monitoring. Used to track and monitor API usage by domain.

  • formatstring

    Response format - 'json' or 'xml'. Defaults to json.

  • strictstring

    Match strictness level. '0' for normal matching, '1' for strict matching, '2' for fuzzy matching.

  • post_boxstring

    Include or exclude PO Box style addresses. Set to '0' to exclude PO Boxes, '1' to include only PO Boxes.

  • deliveredstring

    Filter by NZ Post delivery status. Set to '0' to exclude delivered addresses, '1' to include only delivered addresses.

  • highlightstring

    Set to '1' to wrap matching terms in highlighting span tags in the response.

  • region_codestring

    Filter by NZ region code. Valid codes are 1-9 and A-H representing different New Zealand regions.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NZ Address MetadataADDRESSFINDER_NZ_ADDRESS_METADATAAcción

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.

Parámetros de entrada

  • dpidstring

    Unique reference number assigned to a delivery address by NZ Post

  • pxidstring

    Unique address identifier obtained from the Address Autocomplete API

  • asciistring

    Set to 1 to convert special characters to ASCII equivalents

  • censusinteger

    Data source year - 2018 or 2023. Default is 2023

  • domainstring

    Used to identify which service is calling the API for activity monitoring

  • formatstring

    Response format - json or xml

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

NZ Address Reverse GeocodeADDRESSFINDER_NZ_ADDRESS_REVERSE_GEOCODEAcción

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.

Parámetros de entrada

  • xstringObligatorio

    Longitude in WGS84 format (example: 174.773068233188)

  • ystringObligatorio

    Latitude in WGS84 format (example: -41.2917018846201)

  • maxinteger

    Maximum results to return (1-100, default: 10)

  • domainstring

    Service identifier for portal usage tracking; must be registered

  • formatstringenum

    Response format; accepts 'json' or 'xml'

    jsonxml

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

NZ Address VerificationADDRESSFINDER_NZ_ADDRESS_VERIFICATION_APIAcción

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.

Parámetros de entrada

  • qstring

    The address to be verified. Can contain spelling mistakes.

  • asciistring

    ASCII conversion: '1' reformats special characters to ASCII equivalents.

  • censusinteger

    Census year for statistics: 2018 or 2023. Default is 2023.

  • domainstring

    Service identifier for portal tracking purposes.

  • formatstring

    Response format: 'json' or 'xml'. Default is 'json'.

  • secretstring

    Secret key from Portal Credentials for server-to-server authentication.

  • post_boxstring

    Filter PO Box addresses: '0' excludes PO Boxes, '1' includes only PO Boxes.

  • region_codestring

    Restrict search to specific NZ region. Valid codes are 1-H.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

NZ Location AutocompleteADDRESSFINDER_NZ_LOCATION_AUTOCOMPLETEAcción

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.

Parámetros de entrada

  • qstringObligatorio

    Query string to match against locations (streets, suburbs, cities, regions). Maximum 200 characters.

  • maxinteger

    Maximum number of results to return. Must be between 1 and 100. Default: 10

  • citystringenum

    Set to '0' to exclude cities, '1' for cities only. Omit for all types.

    01
  • domainstring

    Identifies calling service in Addressfinder Portal for analytics.

  • formatstringenum

    Response format - 'json' or 'xml'. Default: json

    jsonxml
  • regionstringenum

    Set to '0' to exclude regions, '1' for regions only. Omit for all types.

    01
  • secretstring

    Secret key from Portal Credentials; required for server-to-server calls.

  • streetstringenum

    Set to '0' to exclude streets, '1' for streets only. Omit for all types.

    01
  • strictstringenum

    Match strictness - '0' (normal), '1' (strict), '2' (fuzzy). Default: '0'

    012
  • suburbstringenum

    Set to '0' to exclude suburbs, '1' for suburbs only. Omit for all types.

    01
  • highlightintegerenum

    Set to 1 to highlight matched terms with '<span class="af_hl"></span>' tags.

    01
  • region_codestring

    Restrict results to specific region. Codes: 1-9, A-H (e.g., '1' for Northland, 'A' for Canterbury).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NZ Location MetadataADDRESSFINDER_NZ_LOCATION_METADATAAcción

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.

Parámetros de entrada

  • pxidstringObligatorio

    Unique location identifier from the Location Autocomplete API.

  • domainstring

    Used to identify your calling service for usage tracking in the AddressFinder Portal. Must be registered in the Portal.

  • formatstringenum

    Response format - 'json' or 'xml'.

    jsonxml
  • secretstring

    Secret key from Portal Credentials; only needed for server-to-server calls. Can also be passed via Authorization header.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

NZ POI AutocompleteADDRESSFINDER_NZ_POI_AUTOCOMPLETE_APIAcción

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.

Parámetros de entrada

  • qstringObligatorio

    The query string to match against POI names and addresses

  • maxinteger

    Maximum results to return (1-100, default: 10)

  • domainstring

    Used to identify your service in the AddressFinder Portal

  • formatstringenum

    Response format; accepts 'json' or 'xml'

    jsonxml
  • highlightinteger

    Set to 1 to include highlighted matching text with <span class='af_hl'></span>

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NZ POI MetadataADDRESSFINDER_NZPOI_METADATA_APIAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique POI identifier from the autocomplete API

  • domainstring

    Service identifier in Addressfinder Portal (must be registered)

  • formatstringenum

    Response format - 'json' or 'xml'

    jsonxml
  • secretstring

    Secret key from Portal Credentials (required for server-to-server calls)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Phone Verification APIADDRESSFINDER_PHONE_VERIFICATION_APIAcción

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.

Parámetros de entrada

  • domainstring

    Service identifier for Portal activity monitoring.

  • formatstring

    Response format: 'json' or 'xml'. Defaults to 'json'.

  • timeoutnumber

    Maximum wait time for verification in seconds.

  • mobile_onlyboolean

    Require the number to be a mobile phone. Set to True to restrict to mobile numbers only.

  • phone_numberstringObligatorio

    The phone number to be verified.

  • default_country_codestringObligatorio

    ISO2 country code used when phone lacks country calling code (e.g., 'AU', 'US', 'GB').

  • allowed_country_codesstring

    Comma-separated ISO2 country codes restricting valid countries (e.g., 'AU,NZ,US').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not