Skip to main content
POST
Authenticate a widget user by phone number
Call this endpoint from your backend with an API key that has the widget:write scope. It returns the same verified token as Authenticate contact. Pass that token to the widget through user.token.
  • Matching: spaces and a leading + in the number you send don’t matter, so +14155550123, 14155550123, and +1 415 555 0123 all identify the same contact.
  • Several matches: when more than one contact has the number, the one created first is used.
  • No match: a new contact is created with only the phone number.
  • Validation: the number must include its country code. A national-only number such as 0770096918 is rejected with 400.
This endpoint only accepts a phone number. To also set a name, email, or custom data, use Authenticate contact.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phone
string
required

Phone number including the country code, e.g. +14155550123

Response

Default Response

token
string
required

The JWT token to use for further requests

contact
object
required