Verifier · Developers
Verifier · Developers
WorkspaceOpenAPI JSONQuickstartAPI reference

Build with the email verification API

Use a workspace API key for server-to-server requests. The API is available on the same HTTPS host as the app at /v1/*.

1. Create a workspace key

Sign in and create a key in Developer settings. Copy it when it is shown; the full key is not available again. Keep it on your server.

2. Call the API

Set API_BASE_URL to the origin in this page's address bar. Use the existing staging or production HTTPS host for that environment.

export API_BASE_URL="https://YOUR_APP_HOST"
export API_KEY="rch_live_..."
curl --fail-with-body -X POST "$API_BASE_URL/v1/check_email" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"to_email":"[email protected]"}'

The key identifies its workspace. Tenant operations use the same key and cannot access another workspace. Signed-in browser requests use /api/backend/* through the app session instead.

3. Explore the contract

The API reference lists every operation, request body, response, and access level. Download the OpenAPI JSONfor client generation. The generated @oppulence/reacher-sdk TypeScript and Go clients are maintained in this repository; use their source or generate a client from the same contract.

Access and compatibility

  • Workspace API keys call tenant /v1/* operations on this host.
  • Provider callbacks are server-to-server deliveries and use their own tokens and signatures.
  • Platform admin endpoints require an isolated operator credential and are not available through a workspace key.
  • Legacy /v0/* routes are not available on the hosted service. Use the v1 equivalents.

API reference

Next Page