BGV Webhooks | Gradii API Documentation

{
  "success": true,
  "data": {
    "events": [
      {
        "event": "bgv.completed",
        "bgvRequestId": "bgv_123456",
        "candidateId": "cand_789",
        "campaignId": "123e4567",
        "timestamp": "2024-01-09T15:30:00.000Z",
        "data": {
          "candidate": {
            "id": "cand_789",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "phone": "+1234567890"
          },
          "campaign": {
            "id": "123e4567",
            "jobTitle": "Software Engineer"
          },
          "company": {
            "name": "Tech Corp"
          },
          "bgv": {
            "requestId": "bgv_123456",
            "requestType": "identity",
            "status": "completed",
            "verificationResult": "verified",
            "confidenceScore": 95,
            "completedAt": "2024-01-09T15:30:00.000Z",
            "digilockerData": {
              "profile": {
                "digilockerid": "1234567890123456",
                "name": "John Doe",
                "dob": "1990-01-01",
                "gender": "M",
                "eaadhaar": "XXXX-XXXX-1234",
                "mobile": "+91XXXXXXXXXX"
              },
              "address": {
                "house": "123",
                "street": "Main Street",
                "locality": "Downtown",
                "dist": "Central",
                "state": "State Name",
                "pincode": "123456"
              },
              "hasPicture": true,
              "apaar": {
                "apaar_id": "APAAR123456789"
              },
              "dataCompleteness": 85,
              "documentsVerified": 3,
              "documents": [
                {
                  "id": "doc_001",
                  "type": "PANCR",
                  "name": "PAN Card",
                  "status": "verified",
                  "verificationScore": 100,
                  "hmacVerified": true,
                  "extractedData": {
                    "pan_number": "ABCDE1234F",
                    "name": "John Doe"
                  }
                }
              ]
            }
          }
        }
      }
    ],
    "totalCount": 1,
    "filters": {
      "event": "bgv.completed",
      "limit": 10
    }
  },
  "timestamp": "2024-01-28T10:00:00Z",
  "version": "2.0"
}

Retrieve BGV webhook events including complete DigiLocker data on completion

Required permissions: bgv:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

Number of events (1-100, default: 50)

candidateIdstringOptionalformat: "uuid"

Filter by candidate

campaignIdstringOptionalformat: "uuid"

Filter by campaign

eventstringOptional

Filter by event type

Response

BGV webhook events retrieved successfully

successbooleanOptional

dataobjectOptional

timestampstringOptional

versionstringOptional

$	curl https://gradii.ai/api/v2/webhooks/bgv \
>	-H "Authorization: Bearer <token>"