Documentation de l'API

Virvell API v1

Automatisez la vérification des références avec une API REST simple. Créez des vérifications, interrogez l'état et récupérez les rapports terminés.

Authentification

Incluez votre clé d'API dans l'en-tête X-API-Key :

X-API-Key: sk_live_your_api_key_here

Points de terminaison

POST /api/v1/reference-checks

Créez une nouvelle vérification de références.

Corps de la requête

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

Réponse

{
  "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}

Obtenez l'état d'une vérification de références.

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

Obtenez le rapport complet. Disponible uniquement lorsque l'état est completed.

Limites de débit

100 requêtes par tranche de 15 minutes par clé d'API.

Assistance

Écrivez à api@virvell.ai pour obtenir de l'aide.