5 min read

Quick Start

Get your first identity verification running in under 5 minutes.

1. Get Your API Key

Contact the VerifyHQ team or use the admin endpoint to create an API client:

Create API Clientbash

curl -X POST https://api.verifyhq.com/v1/admin/api-clients \
  -H "Content-Type: application/json" \
  -H "X-Admin-Secret: your_admin_secret" \
  -d '{
    "name": "My App",
    "permissions": ["identity:read", "identity:write", "document:write"],
    "rateLimit": 100
  }'

Store Your Key

The API key is returned only once. Store it securely — it cannot be retrieved again.

2. Install an SDK (Optional)

npm install @verifyhq/node

3. Start a Verification

curl -X POST https://api.verifyhq.com/v1/verifications/identity \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"userId": "user_123", "tier": "BASIC"}'

4. Submit Documents

Upload Documentbash

curl -X POST https://api.verifyhq.com/v1/verifications/document \
  -H "X-API-Key: your_api_key" \
  -F "userId=user_123" \
  -F "documentType=PASSPORT" \
  -F "documentCountry=NG" \
  -F "frontImage=@passport_front.jpg"

5. Check Status

Get Verification Statusbash

curl https://api.verifyhq.com/v1/verifications/identity/{verification_id} \
  -H "X-API-Key: your_api_key"

6. Set Up Webhooks

Get notified in real-time when verifications complete:

Configure Webhookbash

curl -X POST https://api.verifyhq.com/v1/webhooks/configure \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "your_client_id",
    "callbackUrl": "https://your-app.com/webhooks/verifyhq",
    "events": ["identity.verified", "document.verified", "liveness.passed"]
  }'

You're all set!

Your integration is ready. Check the API Reference for detailed endpoint documentation.