Virvell API v1

POST /api/v1/reference-checks

Create a new reference check.

Request Body

{
  "candidateName": "Jane Smith",
  "candidateEmail": "jane@example.com",
  "candidatePhone": "+1234567890",
  "position": "Software Engineer",
  "references": [
    {
      "name": "John Manager",
      "email": "john@company.com",
      "phone": "+1234567891",
      "relationship": "Manager"
    }
  ]
}

Response

{
  "id": 123,
  "status": "pending",
  "candidateName": "Jane Smith",
  "createdAt": "2025-07-27T10:00:00Z",
  "estimatedCompletionTime": "2025-07-27T12:00:00Z",
  "_links": {
    "self": "/api/v1/reference-checks/123",
    "report": "/api/v1/reference-checks/123/report"
  }
}

GET /api/v1/reference-checks/{id}

Get reference check status.

GET /api/v1/reference-checks/{id}/report

Get the full report. Only available once status is completed.