Skip to main content
The pages under SDK and API walk through the core flow (initialize and confirmations) with full context. For the complete list of endpoints, use the reference surfaces below.

API Reference tab

The full, interactive endpoint reference, right here in the docs. Every operation with request and response shapes. Start here.

Swagger UI

Browse every operation and try it out against the live API. Each endpoint deep-links, e.g. …/docs#/Verification%20Flow/external-initialize.

openapi.json

The raw spec, served by the live API. Point your codegen at this URL to generate a client.

Environments

The same paths are served everywhere. Test and live are not separate hosts; the mode comes from the key you authenticate with: Not sure a key is wired correctly? POST /v3/keys/test with any key returns { valid, key_type, is_test } and is safe to use as a setup check or healthcheck.

Generate a client

Prefer not to generate anything? The official SDK (@verifyyou-sdk/client) already wraps the browser side of these endpoints. Your backend only needs two plain HTTP calls: confirm and, optionally, lock.