View as Markdown
Veremark icon

Veremark ACTION

Download Background Check Report

Downloads the full PDF background check report for a completed request and saves it via File Stash. Only available once the request reaches 'completed' status — use Get Background Check Request to check status first. The request GUID is returned when a request is created with Create Background Check Request. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Veremark account once, then configure and run Download Background Check Report 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: "veremark-download-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    veremark: { authProvisionId: "apn_xxxxxxx" },
    requestGuid: "Request GUID",
    syncDir: "Output Directory",
  },
})

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.

Download Background Check Report inputs
Property Type Description
requestGuid Request GUID string
The unique GUID of the background check request. Returned when a request is created via Create Background Check Request.
Required
syncDir Output Directory dir
The local directory where downloaded files will be saved. Pipedream uses this for File Stash integration and returns presigned download URLs.
Required

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
veremark-download-report
Version
0.0.2
App
Veremark
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes