View as Markdown
Xverify icon

Xverify ACTION

Verify Address

Sends an address verification request. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xverify account once, then configure and run Verify 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: "xverify-verify-address",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xverify: { authProvisionId: "apn_xxxxxxx" },
    domain: "Domain",
    address1: "Street Address 1",
  },
})

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.

Verify Address inputs
Property Type Description
domain Domain string
The domain you have configured in your Xverify settings under which this query should be processed. See below.
Required Dynamic
address1 Street Address 1 string
The street address to be verified.
Required
address2 Street Address 2 string
The second line of the street address to be verified.
Optional
city City string
The city of the address to be verified.
Optional
state State string
The state of the address to be verified.
Optional
zip Zip Code string
The postal code of the address to be verified. Required if city and state are not provided.
Optional
urbanization Urbanization string
A component of certain addresses in Puerto Rico.
Optional
parse Parse Address boolean
Set to true if you want the street address to be parsed into individual elements in the response.
Optional
aff Affiliate ID string
The ID you define to identify the affiliate or source of the email for reporting or potential blocking.
Optional
subaff Sub-Affiliate ID string
The sub-identifier you define for the affiliate or source of the email for reporting or potential blocking.
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
xverify-verify-address
Version
0.0.2
App
Xverify
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes