Integration Checklist

Prerequisites

• Obtain the VerifiMe organisation code from the VerifiMe onboarding team
• Obtain the webhook shared secret from VerifiMe onboarding team
• Determine when in your application flow to initiate verification

API Integration

• Implement call to POST /v1/user/invite
• Store returned trackingReference for widget initialisation
• Pass the application identifier in the referenceData parameter
• (Optional) Pass known customer details in customerContext to pre-fill the onboarding wizard

Widget Integration

• Add VerifiMe widget script to your page
• Initialise widget with trackingReference
• Implement onSuccess() callback handler
• Implement onError() callback handler
• Decide what to show the customer when onSuccess() fires

Webhook Integration

• Create publicly accessible HTTPS endpoint
• Implement HMAC signature verification
• Implement idempotency checking using eventId
• Parse webhook JSON payload
• Extract metadata field to correlate with your application
• Return HTTP 200 within 10 seconds
• Process webhook data asynchronously

Testing

• Test full flow in VerifiMe staging environment
• Test webhook signature verification
• Test duplicate webhook handling (same eventId twice)
• Test webhook retry behaviour (return non-200 status)
• Test various risk levels (LOW, MEDIUM, HIGH, EXTREME)
• Test various entity types (Individual, Company, Trust, Partnership, Sole Trader)

Monitoring

• Set up webhook endpoint monitoring and alerting
• Monitor webhook delivery success rate
• Alert if webhook is not received within expected timeframe
• Log all webhook payloads for debugging