Skip to main content
GET
/
recruiter
/
v2
/
report-json
/
Fetch the BGV report for a case as structured JSON.
curl --request GET \
  --url https://bgv.konnectnxt.com/api/recruiter/v2/report-json/ \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "code": 200,
  "message": "Report JSON fetched successfully.",
  "data": {
    "reference_id": "2605310236148021",
    "generated_at": "2026-06-15T10:30:00.123456+00:00",
    "status": "completed",
    "result": "clear",
    "candidate": {
      "name": "Vivek Patel",
      "photo": "https://storage.googleapis.com/konnectnxt/profile_pictures/abc.png"
    },
    "summary": {
      "total": 2,
      "clear": 2,
      "minor_discrepancy": 0,
      "discrepancy": 0,
      "unable_to_verify": 0,
      "not_available": 0,
      "pending": 0
    },
    "checks": [
      {
        "type": "criminal",
        "name": "Criminal Record Check",
        "category": "Criminal & Compliance",
        "status": "completed",
        "result": "clear",
        "completed_at": "13 May, 2026, 11:02",
        "documents": [
          "https://storage.googleapis.com/konnectnxt/criminal/page_1.png"
        ]
      },
      {
        "type": "identity_aadhaar",
        "name": "Aadhaar Verification",
        "category": "Identity",
        "status": "completed",
        "result": "clear",
        "completed_at": "13 May, 2026, 11:02",
        "fields": [
          {
            "label": "Name",
            "value": "Nallala Vivek"
          },
          {
            "label": "Date of Birth",
            "value": "08-01-2001"
          },
          {
            "label": "Gender",
            "value": "Male"
          },
          {
            "label": "Aadhaar Number",
            "value": "xxxxxxxx8300"
          }
        ]
      }
    ]
  },
  "errors": null
}

​
Overview

Fetch the background verification report for a BGV case as structured JSON instead of a PDF. Call this endpoint with the case_id returned by the Submit Candidates for BGV (Bulk) endpoint to check progress and read results directly in your own application.

​
When to Call This Endpoint

POST /api/recruiter/v2/bgv-submit/
          │
          ▼
  cases_created[].case_id returned here
          │
          ▼
GET /api/recruiter/v2/report-json/?case_id=<case_id>
          │
          │  data.status == "in_progress"?
          ▼
   wait, then poll again
          │
          ▼
  data.status == "completed"
Unlike the Download BGV Report endpoint, this one can be called as soon as the case is created — you don’t need to wait for completion. Check data.status on each call to know whether the case is still in_progress, under review (in_audit), or completed. Within a case, individual checks may also still show result: "pending" even after others have finished — don’t treat a 200 response alone as a sign that verification is done. Poll on a backoff interval (for example 30s → 60s → 5m) rather than continuously. Avoid polling more than once every 15 seconds.

​
Response Format

FieldDescription
reference_idReference number for the case.
generated_atTimestamp for this report snapshot.
statusCase status: in_progress, in_audit, or completed.
resultOverall result for the case (see below).
candidate{ name, photo } for the candidate.
summaryCount of checks by result.
checksList of requested checks with their individual results.

​
Result values

ValueMeaning
clearVerified with no issues.
minor_discrepancyA small, non-blocking mismatch.
discrepancyA material mismatch requiring attention.
unable_to_verifyThe check could not reach a conclusion.
not_availableNot enough information was available to perform the check.
pendingThe check has not finished yet.

​
Each item in checks

FieldDescription
typeCheck type, e.g. identity_aadhaar, criminal, employment.
nameDisplay name, e.g. “Aadhaar Verification”.
categoryDisplay group, e.g. “Identity”, “Criminal & Compliance”.
statusin_progress or completed.
resultOne of the result values above.
completed_atWhen the check finished, or null if not yet.
fieldsVerified details (name, DOB, masked ID number, etc.), where applicable.
documentsDocument/report page image URLs, where applicable.
remarkA short note about the outcome, where applicable.
entriesPer-item results for multi-part checks (employment, reference, address, social/professional), where applicable.
Example response (completed, clear): 
{
  "status": "success",
  "code": 200,
  "message": "Report JSON fetched successfully.",
  "data": {
    "reference_id": "2605310236148021",
    "generated_at": "2026-06-15T10:30:00.123456+00:00",
    "status": "completed",
    "result": "clear",
    "candidate": {
      "name": "Vivek Patel",
      "photo": "https://storage.googleapis.com/konnectnxt/profile_pictures/abc.png"
    },
    "summary": {
      "total": 2,
      "clear": 2,
      "minor_discrepancy": 0,
      "discrepancy": 0,
      "unable_to_verify": 0,
      "not_available": 0,
      "pending": 0
    },
    "checks": [
      {
        "type": "criminal",
        "name": "Criminal Record Check",
        "category": "Criminal & Compliance",
        "status": "completed",
        "result": "clear",
        "completed_at": "13 May, 2026, 11:02",
        "documents": [
          "https://storage.googleapis.com/konnectnxt/criminal/page_1.png"
        ]
      },
      {
        "type": "identity_aadhaar",
        "name": "Aadhaar Verification",
        "category": "Identity",
        "status": "completed",
        "result": "clear",
        "completed_at": "13 May, 2026, 11:02",
        "fields": [
          { "label": "Name", "value": "Nallala Vivek" },
          { "label": "Date of Birth", "value": "08-01-2001" },
          { "label": "Gender", "value": "Male" },
          { "label": "Aadhaar Number", "value": "xxxxxxxx8300" }
        ]
      }
    ]
  },
  "errors": null
}
Example response (still in progress): 
{
  "status": "success",
  "code": 200,
  "message": "Report JSON fetched successfully.",
  "data": {
    "reference_id": "2605310236148021",
    "generated_at": "2026-06-15T09:05:00.000000+00:00",
    "status": "in_progress",
    "result": "pending",
    "candidate": { "name": "Vivek Patel", "photo": "" },
    "summary": {
      "total": 2,
      "clear": 1,
      "minor_discrepancy": 0,
      "discrepancy": 0,
      "unable_to_verify": 0,
      "not_available": 0,
      "pending": 1
    },
    "checks": [
      {
        "type": "criminal",
        "name": "Criminal Record Check",
        "category": "Criminal & Compliance",
        "status": "in_progress",
        "result": "pending",
        "completed_at": null,
        "remark": "Criminal verification is still in progress."
      },
      {
        "type": "identity_aadhaar",
        "name": "Aadhaar Verification",
        "category": "Identity",
        "status": "completed",
        "result": "clear",
        "completed_at": "13 May, 2026, 11:02",
        "fields": [{ "label": "Name", "value": "Nallala Vivek" }]
      }
    ]
  },
  "errors": null
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
case_id
string<uuid>
required

UUID of the case to fetch. Obtained from the BGVSubmitViewV2 response (data.cases_created[].case_id).

Example:

"6bc26096-dfe5-4c44-937b-27063820dc28"

Response

Report fetched successfully. Note: a 200 does not imply the verification is finished — inspect data.status and each check's status/result.

Success response. The report is in data.

​
status
enum<string>
required
Available options:
success
Example:

"success"

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Report JSON fetched successfully."

​
data
object
required

The BGV report for one case.

​
errors
object
required
Example:

null