# VerifyRef — Agent Guide

AI agents use VerifyRef to **find and rank recruits** for any business, then optionally run reference checks.

Prefer the **hosted MCP** when available. Otherwise call the REST API with a Bearer API key. Hosts without remote MCP can use the stdio bridge: `npx @datalinc/verifyref-mcp` with `VERIFYREF_API_KEY`.

## Quick start

1. User signs up at https://verifyref.com/sign-up (3 free credits).
2. Team owner creates a key at https://verifyref.com/team/api (`rc_test_…` sandbox or `rc_live_…` production).
3. Connect MCP: `https://verifyref.com/api/mcp` with header `Authorization: Bearer <api-key>`.
4. Or call REST: `https://verifyref.com/api/v1` with the same Bearer key.

## Primary workflow (talent pool)

1. `upload_candidate_resume` / `POST /talent-pool/candidates` — add resumes (PDF/DOCX). Free, no credits.
2. `match_candidates_to_job` / `POST /talent-pool/match` — paste a job description; get top matches with scores.
3. `create_reference_check` / `POST /checks` with `candidateId` — run a reference check on a shortlist (1 credit).
4. If credits are low: `purchase_credits` / `POST /credits/purchase` (MPP Shared Payment Token or Checkout URL fallback).

## Auth

- Sandbox keys (`rc_test_`) — no emails, no credit charge on checks.
- Live keys (`rc_live_`) — real emails, debit credits. Requires a prior credit purchase to create.
- API keys are managed in the dashboard only (no key CRUD API).

## Scope notes

- MCP tools cover talent pool, checks, account, and credit purchase.
- Video interviews and employee surveys: REST only (`/video-interviews`, `/surveys`).
- Exit interviews and voice reference completion: dashboard-only (no public API).

## Docs

- https://verifyref.com/llms.txt
- https://verifyref.com/openapi.yaml
- https://verifyref.com/docs/agents
- https://verifyref.com/docs/api
- https://verifyref.com/AGENTS.md