Get BGV Order By Order ID
This endpoint retrieves a specific BGV order by its order ID.
Endpoint
GET /api.ezyhire.com/test/getBgvOrderByOrderId/{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 fetched successfully.",
"data": {
"bgvOrderId": "61571280-6597-44c2-84a6-cb813d1c30d2",
"externalId": "EXT123456",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"dateOfBirth": [1990, 1, 15],
"consent": "True",
"consentTimestamp": [2024, 1, 15, 10, 30, 0, 0],
"orderType": "LITE_CHECK",
"orderStatus": "IN_PROGRESS",
"createdOn": [2024, 1, 15, 10, 30, 0, 0],
"updatedOn": [2024, 1, 15, 10, 30, 0, 0]
}
}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 |
Example Usage
const bgvOrderId = "61571280-6597-44c2-84a6-cb813d1c30d2";
const response = await fetch(`https://api.ezyhire.com/test/getBgvOrderByOrderId/${bgvOrderId}`, {
method: 'GET',
headers: {
'USER-Key': 'your-api-key-here'
}
});
const data = await response.json();