Verify Australian Address with Addressfinder API

Pipedream makes it easy to connect APIs for Addressfinder and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Verify Australian Address with the Addressfinder API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Verify Australian Address with the Addressfinder API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Verify Australian Address action
1. Connect your Addressfinder account
2. Configure Address
3. Select one or more Database(s)
4. Optional- Configure GPS Coordinates
5. Optional- Configure Extended
6. Optional- Configure Domain
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Verify Australian Address with Addressfinder API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Addressfinder

Try it

Verify Australian Address with Addressfinder API on New Submission from Typeform API

Typeform + Addressfinder

Try it

Verify Australian Address with Addressfinder API on New Submission (Instant) from Jotform API

Jotform + Addressfinder

Try it

Verify Australian Address with Addressfinder API on New Scheduled Tasks from Pipedream API

Pipedream + Addressfinder

Try it

Verify Australian Address with Addressfinder API on New Download Counts from npm API

npm + Addressfinder

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Verify Australian Address on Addressfinder

Description:Validates an Australian address. [See the documentation](https://addressfinder.com.au/api/au/address/verification/)

Version:0.0.1

Key:addressfinder-verify-address-au

View on GitHub

Code#

import addressfinder from "../../addressfinder.app.mjs";

export default {
  key: "addressfinder-verify-address-au",
  name: "Verify Australian Address",
  description: "Validates an Australian address. [See the documentation](https://addressfinder.com.au/api/au/address/verification/)",
  version: "0.0.1",
  type: "action",
  props: {
    addressfinder,
    address: {
      type: "string",
      label: "Address",
      description: "The Australian address to be verified, e.g. `30 Hoipo Road, SOMERSBY NSW`",
    },
    database: {
      type: "string[]",
      label: "Database(s)",
      description: "Which database(s) to return data from",
      options: [
        {
          value: "gnaf",
          label: "Return physical addresses from the GNAF database.",
        },
        {
          value: "paf",
          label: "Return postal addresses from the PAF database.",
        },
      ],
    },
    gps: {
      type: "boolean",
      label: "GPS Coordinates",
      description: "Return GPS coordinates from the datasource specified (when available)",
      optional: true,
    },
    extended: {
      type: "boolean",
      label: "Extended",
      description: "Returns extended information from the GNAF database",
      optional: true,
    },
    domain: {
      propDefinition: [
        addressfinder,
        "domain",
      ],
    },
  },
  async run({ $ }) {
    const {
      address, database, domain,
    } = this;
    const response = await this.addressfinder.verifyAustralianAddress({
      $,
      params: {
        q: address,
        ...(database?.includes?.("gnaf") && {
          gnaf: 1,
        }),
        ...(database?.includes?.("paf") && {
          paf: 1,
        }),
        ...(this.gps && {
          gps: 1,
        }),
        ...(this.extended && {
          extended: 1,
        }),
        domain,
      },
    });

    $.export("$summary", `Successfully verified AU address "${address}"`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Addressfinder	`addressfinder`	`app`	This component uses the Addressfinder app.
Address	`address`	`string`	The Australian address to be verified, e.g. `30 Hoipo Road, SOMERSBY NSW`
Database(s)	`database`	`string[]`	Select a value from the drop down menu:`{ "value": "gnaf", "label": "Return physical addresses from the GNAF database." }{ "value": "paf", "label": "Return postal addresses from the PAF database." }`
GPS Coordinates	`gps`	`boolean`	Return GPS coordinates from the datasource specified (when available)
Extended	`extended`	`boolean`	Returns extended information from the GNAF database
Domain	`domain`	`string`	Used to identify which of your services is calling the API for activity monitoring purposes. See the documentation for more information.

Authentication#

Addressfinder uses API keys for authentication. When you connect your Addressfinder account, Pipedream securely stores the keys so you can easily authenticate to Addressfinder APIs in both code and no-code steps.

To retrieve your API's Key and Secret,