Skip to navigation
REST APIAuthentication

Verify a phone number

View as Markdown

Submits the SMS code from Register a phone number. On success the account is created, an API key is issued, and a first phone number is provisioned — the response is identical to the sign-in outcome of Verify a sign-up code. The API key is returned only once — store it immediately.

If provisioning fails you receive a 502 and may retry this call with the same registrationId; the phone number stays verified, so no new code is needed.

Note that phoneNumber in the response is the Dial number provisioned for the account, not the number you just verified.

Request

This endpoint expects an object.
registrationIdstringRequired
codestringRequired

The 6-digit code from the SMS.

Response

Verified, account created.
apiKeystring or nullOptional
Your API key. Shown once, when the account is created.
accountIdstringOptional
createdbooleanOptional
True when this call created the account.
phoneNumberstring or nullOptional
The Dial number provisioned for the account, if any. This is not the phone number used to register.
phoneNumberIdstring or nullOptional
messagestringOptional

Errors

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