Skip to Content
Start Here

Veref Integration Docs

Veref is the verified-human layer for remote hiring. These docs are organized for teams that need to understand the product, connect external systems, or run agent-assisted reference workflows.

Start by audience

  • Customer Guide — what recruiters, operators, and tenant admins should know before running Veref.
  • Developer Quickstart — the shortest path to API keys, CLI access, and the reference-check API.
  • Product Scope — what exists now, what belongs to the broader platform roadmap, and what should not be treated as shipped.

Customer docs

  • Reference Workflow explains the current end-to-end flow from recruiter request to customer-safe report.
  • User Flows shows how recruiters, candidates, referees, and agents each move the process forward.
  • Reference Reuse Permissions documents consent before existing reference evidence can be reused.

Developer docs

  • API Access covers tenant API keys, scopes, auditing, environments, and authentication.
  • Endpoint Reference lists the shipped HTTP routes by auth model.
  • OpenAPI embeds the generated Swagger UI and links the raw OpenAPI spec.
  • Agent CLI covers the veref CLI for agents and technical operators.
  • Integrations lists implemented, scaffolded, and launch-priority integration surfaces.

Secondary references

Internal build notes, local development, deployment, architecture, and brand identity are still available in the sidebar, but they are not the main customer integration path.

Customer Guide