Skip to main content

Endpoints

MethodPathDescription
POST/v1/verify/email/startIssue an email verification challenge (scaffolding, extend to deliver codes)
POST/v1/verify/email/confirmConfirm an email verification code
POST/v1/verify/sms/startSend a 6-digit SMS verification code via Trigger.dev
POST/v1/verify/sms/confirmConfirm an SMS verification code within 5 minutes
POST/v1/verify/vatNormalize and validate VAT number formatting
POST/v1/verify/tax-previewInspect the tax rule the pricing engine will apply for a product
POST/v1/verify/document-rulesRetrieve document requirements for a market or itinerary scenario
All endpoints require a workspace-scoped API key (Authorization: Bearer). SMS delivery uses the configured Trigger.dev workflow and sender ID; ensure SMS_SENDER_ID is set in environments that require branded messaging.

Key concepts

  • Email verification endpoints return ok: true today. Wire them to your email provider to send codes via Trigger.dev or another service before promoting to production.
  • SMS verification stores hashed codes in comms.verification_codes, expires them after 5 minutes, and marks records as consumed after confirmation.
  • VAT verification currently performs format normalization (EU heuristic). When ENABLE_VIES_CHECK is set, extend the handler to call VIES and populate isRegistered.
  • Tax preview reuses the price engine rule picker, making it ideal for admin tooling that explains how VAT will be applied.
  • Document rules combine market configuration with product countries to determine which documents must be collected from travellers.