Check BGV Status | Gradii API Documentation

{
  "success": true,
  "data": {
    "candidateId": "cand_789",
    "candidateName": "John Doe",
    "candidateEmail": "john.doe@example.com",
    "campaignId": "123e4567",
    "jobTitle": "Software Engineer",
    "overallStatus": "in_progress",
    "completionPercentage": 45,
    "totalRequests": 3,
    "requests": [
      {
        "id": "req_001",
        "type": "identity",
        "priority": "medium",
        "status": "completed",
        "verificationResult": "verified",
        "confidenceScore": 95,
        "requestedAt": "2024-01-08T12:00:00.000Z",
        "completedAt": "2024-01-09T15:30:00.000Z"
      },
      {
        "id": "req_002",
        "type": "employment",
        "priority": "medium",
        "status": "in_progress",
        "requestedAt": "2024-01-08T12:00:00.000Z"
      },
      {
        "id": "req_003",
        "type": "education",
        "priority": "medium",
        "status": "pending",
        "requestedAt": "2024-01-08T12:00:00.000Z"
      }
    ]
  },
  "timestamp": "2024-01-28T10:00:00Z",
  "version": "2.0"
}

Check the status of BGV requests for a candidate

Required permissions: bgv:read.

Authentication

AuthorizationBearer

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

Query parameters

candidateIdstringOptionalformat: "uuid"

Candidate ID (required if no requestId)

campaignIdstringOptionalformat: "uuid"

Campaign ID (optional)

requestIdstringOptionalformat: "uuid"

Specific request ID (alternative to candidateId)

Response

BGV status retrieved successfully

successbooleanOptional

dataobjectOptional

timestampstringOptional

versionstringOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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