CONNECT APP
Build with Veremark
Human Resources
- API key
MCP
Give your agent Veremark tools
Every Veremark action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Veremark account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "veremark",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Background Check Request:
const result = await mcp.callTool({
name: "veremark-create-request",
arguments: {
criteriaGuid: "Criteria GUID",
candidateFirstName: "Candidate First Name",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "veremark",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Background Check Request:
result = await session.call_tool("veremark-create-request", {
"criteriaGuid": "Criteria GUID",
"candidateFirstName": "Candidate First Name",
})API PROXY
Call the Veremark API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Veremark API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.veremark.com/external/v1/user/",
})
// Any allowed Veremark endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.veremark.com/external/v1/user/
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkudmVyZW1hcmsuY29tL2V4dGVybmFsL3YxL3VzZXIv?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Veremark actions from your backend
Connect a user's Veremark account once, then run Create Background Check Request on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-create-request",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
veremark: { authProvisionId: "apn_xxxxxxx" },
criteriaGuid: "Criteria GUID",
candidateFirstName: "Candidate First Name",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="veremark-create-request",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"veremark": {"authProvisionId": "apn_xxxxxxx"},
"criteriaGuid": "Criteria GUID",
"candidateFirstName": "Candidate First Name",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "veremark-create-request",
"configured_props": {
"veremark": { "authProvisionId": "apn_xxxxxxx" },
"criteriaGuid": "Criteria GUID",
"candidateFirstName": "Candidate First Name"
}
}'TOOLS
Veremark actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Background Check Request
actionInitiates a new background check request for a candidate. Veremark sends the candidate an email invitation to complete their part of the screening process. Returns the request GUID — save this to check status later with Get Background Check Request. Use List Criteria first to find the criteria GUID for the background check package you want to run. See the documentationWritev0.0.2 -
Download Background Check Report
actionDownloads 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 documentationRead-onlyv0.0.2 -
Download candidate-uploaded document via File Stash
actionDownloads 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 documentationRead-onlyv0.0.2 -
Get Background Check Request
actionRetrieves 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 documentationRead-onlyv0.0.2 -
List Criteria
actionReturns all background check criteria packages configured for your Veremark account. Each criteria defines a named bundle of checks (e.g. 'Executive' includes reference check, ID check, employment check). Use this tool first to discover available criteria and their GUIDs before calling Create Background Check Request. See the documentationRead-onlyv0.0.2
EVENTS
Veremark triggers
Event sources your backend can deploy for users and receive through a webhook.
No Veremark triggers are available yet.
- App slug
- veremark
- Authentication
- API key
- Categories
- Human Resources
- Actions
- 5
- Triggers
- 0
- API proxy
- Available