This playbook walks you through getting a VerifiMe integration live. It follows a specific order — don't skip ahead. Each phase has a clear outcome so you always know when you're ready to move to the next step.
You'll work with your VerifiMe contact throughout. Some steps require us to provision things on our side before you can proceed.
PHASE 1 — SANDBOX SETUP
Your goal in this phase: have everything in place to start writing code. You'll have a working sandbox environment, access to the Client Portal, and your credentials ready.
Step 1 — Invite your team and set permissions
VerifiMe provisions your organisation in the sandbox environment. You tell us who needs access.
Provide your VerifiMe contact with the email addresses of everyone who needs Client Portal access — typically your developer and a project lead. We'll send invitations.
When each team member receives their invitation:
Click the invitation link in the email.
Complete the sign-up process — this creates their VerifiMe wallet.
Set up their authenticator app (Google Authenticator, Authy, or Microsoft Authenticator). This is mandatory. The Client Portal requires a 6-digit code at every sign-in.
Important: Every team member must complete authenticator app setup during this first sign-in. If they skip it, they'll be locked out and will need administrator assistance to regain access.
Done when: Every team member who needs Client Portal access has signed in and has their authenticator app set up.
Step 2 — Connect to the Client Portal and get oriented
Staging URL: https://client-portal.stage.verifime.com
This is the portal your team will use to view customer verifications, review risk assessments, and manage your compliance workflow.
Sign-in process:
Enter your email address.
Enter the 6-digit code from your authenticator app.
Click the magic link sent to your inbox.
Checkpoint — do this now: Confirm every invited team member can successfully sign in to the staging Client Portal before moving on. If anyone can't get in, stop here and contact your VerifiMe representative.
Take a few minutes to explore:
The customer list — where verified customers will appear.
A risk assessment — the output your integration will ultimately drive.
The risk rules — how risk levels (LOW / MEDIUM / HIGH / EXTREME) are determined.
Done when: Your team is in, can navigate the portal, and understands what a completed verification looks like.
Step 3 — Set up your API credentials
Do this last in the setup phase, right before you start building. Your VerifiMe contact provides credentials once your environment is fully provisioned.
You will receive two things from the VerifiMe onboarding team:
Organisation Code — identifies your organisation in API calls. Webhook Shared Secret — used to verify that webhook events genuinely came from VerifiMe. Keep this secret.
Store both securely in your environment configuration, not in your codebase.
Done when: You have your organisation code and webhook shared secret in hand, stored securely.
Step 4 — Review the developer documentation
Before writing any code, read through the developer portal. It contains everything your developer needs.
Start here: https://developer.verifime.com
Key sections to read before building:
Integration overview — the two-phase model (customer data entry, then backend processing)
POST /v1/user/invite — how to create a tracking reference to start a verification
Widget integration — how to embed the VerifiMe widget in your application
Webhook reference — the RISK_ASSESSMENT_UPDATED event and payload structure
Environments — staging vs production URLs
Done when: Your developer has read the docs and can describe the three integration components: API, Widget, Webhook.
PRODUCTION GO-LIVE
Contact your VerifiMe representative when staging testing is complete. You'll receive a production Organisation Code and a production Webhook Shared Secret.
Swap those two values and update three URLs:
API: api.stage.verifime.com → api.prod.verifime.com
Widget script: widget.static.stage.verifime.com → widget.static.prod.verifime.com
Client Portal: client-portal.stage.verifime.com → client-portal.verifime.com
No other code changes are required.
COMMON QUESTIONS
Does onSuccess mean my customer is verified? No. It means they've finished entering their data (Phase 1 complete). The actual verification and risk assessment happen in the background. Wait for the RISK_ASSESSMENT_UPDATED webhook with assessmentStatus ASSESSED.
Why haven't I received a webhook? A webhook only fires after identity verification completes and the risk assessment is calculated. If it doesn't arrive, poll proactively using the risk assessment API when onSuccess fires.
Can I customise the widget's look and feel? You can display your organisation's logo. Full colour theming is not available.
Can I pre-fill the customer form? Yes — pass a customerContext in the invite call with the customer's known details (name, date of birth, address, phone). All values are editable by the customer before submission.
What if the webhook fails to deliver? VerifiMe will retry. Return a non-200 response to trigger a retry. Return 401 specifically for an invalid signature — this stops retries permanently for that event.