Documentation

Huntr API Reference

Everything you need to integrate Huntr into your systems. RESTful APIs, webhooks, and SDKs.

APIs

Core APIs

Workers API

Create, read, update worker profiles. Manage documents and skills.

Compliance API

Check corridor requirements. Get gap analysis. Validate readiness.

Verify API

Submit documents for verification. Get validation results and fraud scores.

Match API

Score workers against jobs. Get ranked results with match reasons.

Track API

Update placement status. Query pipeline. Get analytics.

Webhooks

Real-time notifications for status changes, verifications, alerts.

Workers API

Endpoints

GET/v1/workersList all workers

GET/v1/workers/:idGet worker by ID

POST/v1/workersCreate worker

PUT/v1/workers/:idUpdate worker

POST/v1/workers/:id/documentsUpload document

GET/v1/workers/:id/complianceCheck compliance

Example

Get Worker

Retrieve a worker profile with all associated data.

// Request
GET /v1/workers/HW-2K4N8M3P
Authorization: Bearer sk_live_xxx

// Response
{
  "huntr_id": "HW-2K4N8M3P",
  "name": "Arun Kumar Sharma",
  "nationality": "NP",
  "primary_skill": "mason",
  "experience_years": 8,
  "verification_status": "verified",
  "documents": [...],
  "placements": [...]
}

Authentication

API Keys

All API requests require authentication via Bearer token.

// Include in all requests
Authorization: Bearer sk_live_xxxxxxxxxxxxx

// Test mode
Authorization: Bearer sk_test_xxxxxxxxxxxxx