Get BGV Sub Orders
This endpoint retrieves all sub-orders for a specific BGV order by order ID.
Endpoint
POST /api.ezyhire.com/test/getBGVSubOrders/{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 Sub Orders fetched successfully.",
"data": [
{
"subOrderId": "f1662894-cda6-424f-bc8f-4ccecea1201e",
"bgvOrderId": "61571280-6597-44c2-84a6-cb813d1c30d2",
"subOrderProduct": "SEX_OFFENDER",
"subOrderStatus": "PENDING",
"subOrderSubStatus": "IN_PROGRESS",
"subOrderLastUpdatedOn": [2024, 1, 15, 10, 30, 0, 0],
"orderDetails": {
"order": {
"orderDate": "2024-01-15T10:30:00",
"status": "PENDING",
"substatus": "IN_PROGRESS",
"subject": {
"firstName": "John",
"lastName": "Doe",
"birthdate": "1990-01-15T00:00:00",
"ssn": "",
"aliases": [],
"addresses": [],
"pastNames": [
{
"firstName": "John",
"middleName": "",
"lastName": "Doe",
"suffix": ""
}
]
},
"pricing": {
"cost": 5.00,
"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": "2024-01-15T10:30:00"
},
{
"note": "Search Added",
"addedDate": "2024-01-15T10:35:00"
}
],
"documents": [],
"knownCases": [],
"requestCustomFields": [],
"resultCustomFields": [],
"subscribers": [],
"cases": [],
"courtCopies": [],
"isInNeed": false,
"ssnTrace": [],
"mvr": {
"orderID": 0,
"records": []
}
}
},
"createdOn": [2024, 1, 15, 10, 30, 0, 0]
}
]
}Error Responses
Bad Request
Status Code: 400 Bad Request
{
"Error": "Invalid request format",
"ErrorLine": " \"pageNumber\":0 ,",
"Location": "Line:0"
}Unauthorized
Status Code: 401 Unauthorized
{
"status": 401,
"message": "Invalid User/API key",
"error": "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 |
|---|---|
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 = "61571280-6597-44c2-84a6-cb813d1c30d2";
const response = await fetch(`https://api.ezyhire.com/test/getBGVSubOrders/${bgvOrderId}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'USER-Key': 'your-api-key-here'
}
});
const data = await response.json();