BGV Completed Webhook Payload
This webhook is triggered when a BGV (Background Verification) order is completed. You can track BGV completion details through this webhook payload.
This webhook is triggered when ALL sub-orders within a BGV order have been completed successfully.
Webhook Event
Event Type: BGV_COMPLETED
Payload
{
"orderId": "61571280-6597-44c2-84a6-cb813d1c30d2",
"externalId": "EXT123456",
"verificationStatus": "COMPLETED"
}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 |
Verification Status Values
| Status | Description |
|---|---|
COMPLETED | BGV verification has been completed successfully |
Example Webhook Handler
app.post('/webhook/bgv-completed', (req, res) => {
const { orderId, externalId, verificationStatus } = req.body;
console.log('BGV Completed:', {
orderId,
externalId,
status: verificationStatus
});
// Process the webhook data
// Update your database, send notifications to relevant parties, etc.
res.status(200).json({ received: true });
});