Verify a sign-up code

View as Markdown
Verifies the one-time code for a `verificationId`. This endpoint has **two possible outcomes**, and you must branch on the response body: - **Signing in to an existing account** — the account and API key are returned immediately. **The API key is returned only once — store it immediately.** - **Registering a new account** — the email is now verified, but an account is *not* created yet. The response carries a `registrationId` instead. Registering requires a verified phone number: continue with [Register a phone number](#operation/registerNumber), then [Verify a phone number](#operation/verifyNumber), which creates the account and returns the same shape as the sign-in outcome. In short: **if the response contains `registrationId`, the flow is not finished.** A new number's inbound voice-agent prompt is always the default at creation; change it afterwards with [Update a phone number](#operation/updateNumber).

Request

This endpoint expects an object.
verificationIdstringRequired
codestringRequired

The 6-digit code from the email.

Response

Verified. Either the account (sign-in) or a registrationId (registration still needs a verified phone number).

AuthenticatedAccountobject

A completed sign-in or registration. Returned by both Verify a sign-up code (when signing in) and Verify a phone number (when registering).

OR
PendingPhoneRegistrationobject

The email is verified but no account exists yet, because registering requires a verified phone number. Continue with Register a phone number.

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error