Skip to main content
This guide takes you from empty account to first send. All via API: register, OTP, card, plan, and message.

In short

  1. Register with onboarding survey (fixed enum fields)
  2. Verify phone with OTP → receive apiKey (save it now)
  3. Optional: add card and subscribe to a plan
  4. Send a message with the API key on a channel
Onboarding enums: Registration and verification.

1. Register account

Response: verificationToken, deliveryChannel (whatsapp or sms), expiresAt, retryAfter.

2. Verify phone

Response: apiKey, workspaceId, user. Save the apiKey — it is not shown again.

3. (Optional) Add card and subscribe

Card, PIX, and recharge details: Billing.

4. Send first message

Login to existing account

With 2FA: first login returns requiresSecondFactor + verificationToken; call login again with that token + totpCode (not verify). See Registration and verification.

Second workspace

Then login with that workspace’s workspaceId to get an API key for it.

Next steps

  • Webhooks: receive events on your server
  • Workspaces: organize instances and team
  • Scopes: restrict the key for production