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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "ideal_postcodes-phone-number-validation",
"configured_props": {
"ideal_postcodes": { "authProvisionId": "apn_xxxxxxx" },
"query": "Phone Number",
"currentCarrier": true
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "ideal_postcodes",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "ideal_postcodes-phone-number-validation",
arguments: {
query: "Phone Number",
currentCarrier: true,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗