Integrate

Sandbox

Sandbox keys, simulated sessions and outcomes, for development and CI.

Each workspace is in sandbox or production, switched at the top of Workspace settings. New workspaces start in sandbox. In sandbox the dashboard shows sandbox verifications, and the keys, webhook endpoints and publishable key it gives you are sandbox ones. Switch to production when you go live.

A sandbox key (kyc_sandbox_...) works like a secret key, but its sessions are simulated: nobody photographs a document, and you choose how each one ends. Use one while you build your integration and in automated tests. A key keeps its mode: a production key keeps working if the workspace goes back to sandbox.

Live keySandbox key
SessionsReal: document and selfie on a phoneSimulated: you choose the outcome
WebhooksTo production endpointsTo sandbox endpoints only, with "sandbox": true
Verify buttonspk_live_...pk_sandbox_...
Sees the other mode's sessionsNoNo
Fraud memoryCompared and rememberedNever
DashboardShown in productionShown in sandbox
KeptYour retention periodDeleted after 7 days

link Choosing the outcome

Create the session as usual. Then either open its start_url, which shows a page with one button per outcome, or end it from your code with Simulate a session:

outcomestatusreasonsWebhook event
clearclearnonesession.completed
considerconsiderDOC_CUT_OFFsession.review_required
rejectedrejectedINJ_REENCODEDsession.completed
errorerrornonesession.error

A consider sandbox session can be reviewed in the dashboard, so you can test the review webhook too.

edit_note

References

The same reference in the sandbox and live is two different applicants: testing with your real customer IDs never touches their live verifications.

Was this page helpful?

Authorization

Your secret key stays in this tab: it is sent with this request only and never stored.

Body application/json

Response

Send the request to see the response.