Get BGV Order Report

This endpoint retrieves a complete BGV order report including the main order details and all associated sub-orders by order ID.

Endpoint

GET /api.ezyhire.com/test/getBGVOrderReport/{bgvOrderId}

Headers

Header	Type	Required	Description
`USER-Key`	`string`	Yes	Your API authentication key

Path Parameters

Parameter	Type	Required	Description
`bgvOrderId`	`string`	Yes	Unique identifier of the BGV order

Responses

Success Response

Status Code: 200 OK

{
  "statusCode": 200,
  "error": null,
  "message": "BGV Order and BGV Sub Orders against BGV Order ID : 'b6594f95-f1d0-44aa-892b-43144fa4b142' is fetched successfully.",
  "data": {
    "BGVOrder": {
      "bgvOrderId": "b6594f95-f1d0-44aa-892b-43144fa4b142",
      "externalId": "1234567890",
      "firstName": "Arvind",
      "lastName": "Chandrakar",
      "email": "arch9898@ezyhire.com",
      "dateOfBirth": [1998, 1, 1],
      "consent": "True",
      "consentTimestamp": [2025, 7, 30, 11, 48, 45, 433000000],
      "orderType": "LITE_CHECK",
      "orderStatus": "IN_PROGRESS",
      "createdOn": [2025, 7, 30, 18, 48, 43, 366490800],
      "updatedOn": [2025, 7, 30, 18, 48, 43, 366490800]
    },
    "BGVSubOrders": [
      {
        "BGVSubOrder": {
          "subOrderId": "e37bd508-46e9-469a-a539-545fc073fd0b",
          "bgvOrderId": "b6594f95-f1d0-44aa-892b-43144fa4b142",
          "subOrderProduct": "SEX_OFFENDER",
          "subOrderStatus": "PENDING",
          "subOrderSubStatus": "IN_PROGRESS",
          "subOrderLastUpdatedOn": [2025, 7, 30, 18, 49, 9, 734317100],
          "subOrderNotes": null,
          "orderDetails": {
            "order": {
              "orderDate": "2025-07-30T09:19:13.377",
              "status": "PENDING",
              "substatus": "IN_PROGRESS",
              "subject": {
                "firstName": "ARVIND",
                "lastName": "CHANDRAKAR",
                "birthdate": "1998-01-01T00:00:00",
                "ssn": "",
                "aliases": [],
                "addresses": [],
                "pastNames": [
                  {
                    "firstName": "Arvind",
                    "middleName": "",
                    "lastName": "Chandrakar",
                    "suffix": ""
                  }
                ]
              },
              "pricing": {
                "cost": 0,
                "courtFeeCost": 0,
                "dataFeeCost": 0
              },
              "product": {
                "category": "SEX_OFFENDER"
              },
              "jurisdiction": {
                "county": "National Sex Offender Registry",
                "state": "USA",
                "country": "United States"
              },
              "activity": [
                {
                  "note": "Assigned to Researcher",
                  "addedDate": "2025-07-30T09:19:14.233"
                },
                {
                  "note": "Search Added",
                  "addedDate": "2025-07-30T09:19:14.157"
                }
              ],
              "documents": [],
              "knownCases": [],
              "requestCustomFields": [],
              "resultCustomFields": [],
              "subscribers": [],
              "cases": [],
              "courtCopies": [],
              "isInNeed": false,
              "ssnTrace": [],
              "mvr": {
                "orderID": 0,
                "records": []
              }
            }
          },
          "createdOn": [2025, 7, 30, 18, 49, 9, 734317100]
        }
      },
    ]
  }
}

Error Responses

Unauthorized

Status Code: 401 Unauthorized

{
  "status": 401,
  "message": "Invalid User/API key",
  "data": "Please provide a valid User/API key"
}

Internal Server Error

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "error": "string",
  "message": "string",
  "data": "string"
}

Enum Values

Field Name	Possible Values
`orderType`	`LITE_CHECK`, `STANDARD_CHECK`, `ID_VERIFICATION`, `PROFESSIONAL_CHECK`, `ID_PLUS_SOFT`
`orderStatus`	`INITIALIZED`, `IN_PROGRESS`, `NEED_INFO`, `COMPLETED`
`subOrderProduct`	`NATCRIM`, `SSN_TRACE`, `SEX_OFFENDER`, `GLOBAL_SECURITY_CHECK`, `ID_VERIFICATION`, `EDUCATION_VERIFICATION`, `EMPLOYMENT_VERIFICATION`, `ADDRESS_VERIFICATION`, `CRIMINAL`
`subOrderStatus`	`PENDING`, `COMPLETE`, `CANCELLED`, `UNKNOWN`, `ID_VALIDATION_FINISHED`, `POST_PROCESSING_FINISHED`, `FACE_VALIDATION_FINISHED`, `GOVERNMENT_VALIDATION_FINISHED`, `ONBOARDING_FINISHED`, `MANUAL_REVIEW_APPROVED`, `MANUAL_REVIEW_REJECTED`
`subOrderSubStatus`	`IN_PROGRESS`, `NEED_INFO`, `QA_REVIEW`, `COMPLETE`, `CLEAR`, `RECORD`, `NO_RESULTS_FOUND`, `RESULTS_FOUND`, `VERIFIED_SUCCESS`, `VERIFIED_REQUIRES_REVIEW`, `UNVERIFIED_MISSING_INFO`, `UNVERIFIED_NO_RESPONSE`, `UNVERIFIED_DISCONNECTED`, `UNVERIFIED_SOURCE_INVALID`, `UNVERIFIED_SOURCE_REFUSED`, `UNVERIFIED_NO_RECORD`, `UNVERIFIED_CLOSED`, `UNVERIFIED_RETURNED`, `UNVERIFIED_CURRENT_EMPLOYMENT`, `UNVERIFIED_SELF_EMPLOYMENT`, `CANCELLED`, `CANCELLED_BILLABLE`

Example Usage

const bgvOrderId = "b6594f95-f1d0-44aa-892b-43144fa4b142";
 
const response = await fetch(`https://api.ezyhire.com/test/getBGVOrderReport/${bgvOrderId}`, {
  method: 'GET',
  headers: {
    'USER-Key': 'your-api-key-here'
  }
});
 
const data = await response.json();

Get My BGV Orders ID Verification