View as Markdown
Veremark icon

Veremark ACTION

Download candidate-uploaded document via File Stash

Downloads a supporting document uploaded by a candidate during the background check process and saves it via File Stash. Document GUIDs are found in the response from Get Background Check Request — look in the checks array for document references. Common document types include resumes, ID scans, and employment letters. 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 candidate-uploaded document via File Stash 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-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    veremark: { authProvisionId: "apn_xxxxxxx" },
    documentGuid: "Document 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 candidate-uploaded document via File Stash inputs
Property Type Description
documentGuid Document GUID string
The unique GUID of the document to download. Found in the response from Get Background Check Request within the checks data. Example: 123e4567-e89b-12d3-a456-426614174000.
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-document
Version
0.0.2
App
Veremark
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes