View as Markdown
Real ID icon

Real ID ACTION

Get ID Check

Retrieve an ID check. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Real ID account once, then configure and run Get 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-get-id-check",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    real_id: { authProvisionId: "apn_xxxxxxx" },
    checkId: "ID Check Identifier",
    withPhotos: 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.

Get ID Check inputs
Property Type Description
checkId ID Check Identifier string
The unique identifier for the ID check
Required
withPhotos Include Photos boolean
All photos will be provided as short lived URLs in the API response under the photos key.
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-get-id-check
Version
0.0.2
App
Real ID
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes