View as Markdown
Ideal Postcodes icon

Ideal Postcodes ACTION

Phone Number Validation

Validates a phone number and returns information about it. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ideal Postcodes account once, then configure and run Phone Number Validation 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: "ideal_postcodes-phone-number-validation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ideal_postcodes: { authProvisionId: "apn_xxxxxxx" },
    query: "Phone Number",
    currentCarrier: true,
  },
})

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.

Phone Number Validation inputs
Property Type Description
query Phone Number string
Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers should be suffixed +44, 44 or 0044.
Required
currentCarrier Current Carrier boolean
When set to true the current network of the phone number will be retrieved and populated. Note that this operation is potentially slow depending on the network and local conditions.
Optional
tags Tags string
A comma separated list of tags to query over. Useful if you want to specify the circumstances in which the request was made. If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching foo,bar will only query requests which tagged both foo and bar.
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
ideal_postcodes-phone-number-validation
Version
0.0.3
App
Ideal Postcodes
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes