ID Verification Completed Webhook Payload

This webhook is triggered when ID verification is completed. You can track ID verification details through this webhook payload.

Webhook Event

Event Type: ID_VERIFICATION_COMPLETED

Payload

{
  "verificationStatus": "ONBOARDING_FINISHED",
  "externalCandidateId": "EXT123456",
  "idVerificationReportURL": "https://app.ezyhire.com/reports/idv/61571280-6597-44c2-84a6-cb813d1c30d2",
  "candidateId": "candidate-789012",
  "testId": "test-345678"
}

Payload Fields

Field	Type	Description
`verificationStatus`	`enum`	VerificationStatus of the ID verification process
`externalCandidateId`	`string`	External reference ID for the candidate
`idVerificationReportURL`	`string`	URL to access the ID verification report
`candidateId`	`string`	Internal candidate identifier
`testId`	`string`	Internal test identifier

Verification Status Values

Status	Description
`ONBOARDING_FINISHED`	ID verification onboarding completed
`ID_VALIDATION_FINISHED`	ID validation process completed
`FACE_VALIDATION_FINISHED`	Face validation process completed
`GOVERNMENT_VALIDATION_FINISHED`	Government validation completed
`POST_PROCESSING_FINISHED`	Post-processing completed
`MANUAL_REVIEW_APPROVED`	Manual review approved
`MANUAL_REVIEW_REJECTED`	Manual review rejected

Example Webhook Handler

app.post('/webhook/id-verification', (req, res) => {
  const { verificationStatus, externalCandidateId, idVerificationReportURL, candidateId, testId } = req.body;
  
  console.log('ID Verification completed:', {
    status: verificationStatus,
    candidate: externalCandidateId,
    reportUrl: idVerificationReportURL
  });
  
  // Process the webhook data
  // Update your database, send notifications, etc.
  
  res.status(200).json({ received: true });
});

Get BGV Order Report Test Completed