Public API

API Reference

Endpoint index for sending idempotent email OTPs, verifying submitted codes, fetching test-mode codes, and checking service health.

Start with send

Core behavior

The send endpoint is idempotent by email and purpose. During the live window, repeat requests send the same code instead of creating a new rolling bucket of OTPs.

10 minute live windowChallenge IDsServer-side API keysTest inbox

Email language support

Pass language to the send endpoint to localize the verification email. Templates are available in English, Spanish, French, German, Portuguese, Italian, and Dutch.

en · es · fr · dept · it · nlLocale tags supportedEnglish fallback

AI integration references

Give an AI coding agent the full integration context first, then use the OpenAPI document for exact request and response shapes. Both are public and generated or maintained alongside this reference.

llms-full.txtopenapi.jsonllms.txt index

Endpoints

POST/v1/send

Send OTP

Send or resend an idempotent email code for an email and purpose.

POST/v1/verify

Verify OTP

Verify a submitted email code against the live idempotent OTP record.

GET/v1/test/latest-code

Latest test code

Fetch the latest code created by a test-mode key for an email and purpose.

GET/v1/health

Health check

Check that the OTP Worker is reachable.

Request model

1

Call send from your backend with a normalized user email and stable purpose key.

2

Store the returned challenge id and ask the user for the email code while it remains valid.

3

Call verify from your backend with the same email, purpose, challenge id, and submitted code.