View as Markdown
FinerWorks icon

FinerWorks ACTION

Validate Address

Validate an address. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's FinerWorks account once, then configure and run Validate Address from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "finerworks-validate-address",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    finerworks: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Validate Address inputs
Property Type Description
firstName First Name string
Recipient first name
Required
lastName Last Name string
Recipient last name
Required
companyName Company Name string
Recipient company name
Optional
address Address string
Street address for the recipient
Required
city City string
Recipient city
Optional
stateCode State Code string
Required if in U.S. A valid USPS recognized 2 digit state code, i.e.: CA
Optional
province Province string
Province or region name
Optional
zipPostalCode ZIP or Postal Code string
ZIP or postal code of the recipient
Required
countryCode Country Code string
Two-letter ISO country code, e.g.: US, CA, GB
Required
phone Phone string
Recipient phone number
Optional
email Email string
Recipient email address
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
finerworks-validate-address
Version
0.0.1
App
FinerWorks
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes