Skip to main content
GET
/
verification
/
bgv
/
download
Download BGV Report
curl --request GET \
  --url https://bgv.konnectnxt.com/api/verification/bgv/download \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Report Fetched Successfully.",
  "data": {
    "case_id": "a1b2c3",
    "candidate_name": "Ravi Kumar",
    "status": "completed",
    "created_at": "2024-06-01T08:00:00Z",
    "completed_at": "2024-06-04T10:30:00Z",
    "report": "https://storage.googleapis.com/konnectnxt-bucket/Reports/pdf/report_a1b2c3.pdf?v=84291"
  }
}

​
Overview

Download the final background verification report for a completed BGV case. Call this endpoint after receiving the case.completed webhook for the relevant case_id.

​
When to Call This Endpoint

POST /api/recruiter/v2/bgv-submit/
          │
          │  (async checks running...)
          ▼
  webhook: case.completed
          │
          ▼
GET /api/verification/bgv/download?case_id=<case_id>
The report is only available once the case status is completed. Calling before completion returns a 404 with "Candidate has not submitted the BGV yet.".

​
Response Format

type query paramResponse data.report value
pdfGCP-hosted direct-download URL (public, time-limited)
(omitted)Base64-encoded PDF string

​
Using the Base64 report

const pdfBuffer = Buffer.from(data.report, "base64");
fs.writeFileSync("bgv_report.pdf", pdfBuffer);

​
Notes

  • The hosted PDF URL (when type=pdf) is publicly accessible but contains a version token (?v=...) — store it securely and do not expose it unnecessarily.
  • The Base64 string represents the full PDF file and can be decoded client-side.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
case_id
string<uuid>
required

The UUID of the BGV case. Obtained from the cases_created array in the submit response, or from the webhook payload.

​
type
enum<string>

Controls the report format. Use pdf for a hosted URL; omit for Base64-encoded PDF.

Available options:
pdf

Response

Report fetched successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Report Fetched Successfully."

​
data
object