View as Markdown
Real ID icon

Real ID ACTION

Create ID Check

Create a new ID check for a user. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Real ID account once, then configure and run Create ID Check 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: "real_id-create-id-check",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    real_id: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    phone: "Phone Number",
  },
})

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.

Create ID Check inputs
Property Type Description
email Email string
Email address for initiating the ID check
Optional
phone Phone Number string
Phone number for initiating the ID check
Optional
firstName First Name string
First name of the customer
Optional
lastName Last Name string
Last name of the customer
Optional
wooCommerceCustomerId WooCommerce Customer ID string
Unique identifier for the customer in WooCommerce
Optional
wooCommerceOrderId WooCommerce Order ID string
Unique identifier for the order in WooCommerce
Optional
shopifyAdminGraphqlId Shopify Admin GraphQL ID string
Unique identifier for the customer in Shopify
Optional
shopifyAdminGraphqlOrderId Shopify Admin GraphQL Order ID string
Unique identifier for the order in Shopify
Optional
shopifyAdminGraphqlOrderName Shopify Admin GraphQL Order Name string
Name of the order in Shopify
Optional
additionalParameters Additional Parameters object
Additional parameters to include in the request
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
real_id-create-id-check
Version
0.0.2
App
Real ID
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes