v4

OpenAPI 3.1.02026-08-0255174167.5 KB
authentication

Verify a sign-up code

Verifies the one-time code for a verificationId. On first verification the account is created, an API key is issued, and a first phone number is provisioned. The API key is returned only once — store it immediately.

When a new number is provisioned, inboundInstruction is optional — it becomes that number's inbound voice-agent prompt, and a default greeting is used if you omit it. For an existing account (no new number provisioned) inboundInstruction is ignored.

post/api/v1/auth/verify

Request body

verificationIdstring required
codestring required

The 6-digit code from the email.

inboundInstructionstring

System prompt for the AI voice agent on calls to the auto-provisioned number. Optional — a default greeting is used if omitted when a new number is created; ignored when signing in to an existing account.

Response

Verified.

apiKeystring

Your API key. Shown once on account creation.

accountIdstring
phoneNumberstring nullable

The number auto-provisioned for a new account, if any.

phoneNumberIdstring nullable
messagestring