Skip to main content
API Docs

Getting Started

HaceVerify provides a REST API for building verification workflows into your platform. All API requests are authenticated with your organization's API key. Requests and responses use HaceVerify's normalized schema — you never interact directly with underlying provider APIs.

API Operational Status — October 2026 (V1 pre-release)

Identity verification / KYC (HaceVerify Core & Plus)
Partial
U.S. Background Screening (HaceVerify U.S. Background Pro) — V2 only
Deferred
Business verification (KYB)
Partial
Public footprint / OSINT
Provider-blocked
AML / sanctions screening
Not active
Report artifact generation
Partial
Outbound webhook delivery
Partial
API gateway enforcement (rate limiting, key auth)
Live
Hard monthly quota enforcement (concurrent writes not certified)
Partial
Billing & quota checkout
Partial

"Live" = an independently certified active capability. "Partial" = implemented but release gates remain. "Provider-blocked" = no provider dispatch. "Not active" = not wired. "Deferred" = V2 only and unavailable in V1. No live payment or provider cutover is authorized.

Current REST transport (certified): https://haceverify-api-edge.mh-nkanta.workers.dev

This is a Temporary certified API edge endpoint. It serves standard REST semantics: literal /v1/* paths, standard HTTP methods, and Bearer authentication. No _path/_method body fields are required.

The permanent branded endpoint https://api.haceverify.com/v1 is pending DNS/registrar migration and is not yet operational. It will replace the temporary edge at GA — only the base URL changes.

bash
curl https://haceverify-api-edge.mh-nkanta.workers.dev/v1/verifications \
  -H "Authorization: Bearer hv_test_YOUR_API_KEY"

Quick Integration Flow

    1

    Create API Key

    Generate a scoped API key in your Business Portal → API Keys.

    2

    Submit a Verification Request

    POST /v1/verifications with subject data and confirmed consent.

    3

    Poll Status

    GET /v1/verifications/:id to poll request status.

    4

    List Requests

    GET /v1/verifications lists your organization’s requests with pagination.

    5

    Retrieve a Report

    GET /v1/reports/:id returns the report artifact when ready.

    6

    Webhooks

    POST /v1/webhook-endpoints to register a webhook for async event delivery.