BGV Need Info Webhook Payload
This webhook is triggered when additional information is required for a BGV (Background Verification) order. You can track BGV need info details through this webhook payload.
Webhook Event
Event Type: BGV_NEEDINFO
Payload
{
"orderId": "61571280-6597-44c2-84a6-cb813d1c30d2",
"externalId": "EXT123456",
"verificationStatus": "NEED_INFO",
"needInfo": "Please provide additional documentation for employment verification",
"subOrderId": "f1662894-cda6-424f-bc8f-4ccecea1201e"
}Payload Fields
| Field | Type | Description |
|---|---|---|
orderId | string | BGV order identifier |
externalId | string | External reference ID provided by client |
verificationStatus | enum | Status of the BGV verification process |
needInfo | string | Details of additional information required |
subOrderId | string | Sub-order identifier |
Verification Status Values
| Status | Description |
|---|---|
NEED_INFO | Additional information is required to proceed |
Example Webhook Handler
app.post('/webhook/bgv-needinfo', (req, res) => {
const { orderId, externalId, verificationStatus, needInfo, subOrderId } = req.body;
console.log('BGV Need Info:', {
orderId,
externalId,
status: verificationStatus,
requiredInfo: needInfo,
subOrderId
});
// Process the webhook data
// Update your database, send notifications to relevant parties, etc.
res.status(200).json({ received: true });
});