View as Markdown
Veremark icon

Veremark ACTION

Get Background Check Request

Retrieves the status and details of a background check request by its GUID. Returns the overall request status (e.g. requested, in_progress, review, completed) and the status of each individual check within the request. Also returns document GUIDs for any candidate-uploaded files, which can be downloaded with Download Candidate Document. The request GUID is returned when you create a request with Create Background Check Request. Note: there is no search endpoint — you must know the request GUID. Save it when creating requests. 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 Get Background Check Request 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-get-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    veremark: { authProvisionId: "apn_xxxxxxx" },
    requestGuid: "Request GUID",
  },
})

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 Background Check Request 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

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