Skip to main content
POST
Verify a phone code
Checks the code the user read back. A verification stays fresh for 60 days.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Body

application/json
user_id
string
required

The connected user.

code
string
required

The code the user read back.

phone_number
string

The same number you sent the code to.

Response

The phone is verified.

object
enum<string>
required

Always phone_verification.

Available options:
phone_verification
status
string
required

sent, already_verified or verified.

channel
string

How the code was sent.

phone
string

The number, masked.

expires_in_seconds
integer

How long the code works.