Skip to main content
GET
Download BGV Report

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

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

Using the Base64 report


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

API key issued by KonnectNXT. Pass as Authorization: Bearer <your_api_key>.

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