Skip to main content
POST
/
tools
/
verify-user-exists
Check whether a user account exists
curl --request POST \
  --url https://apiv2.example.com/tools/verify-user-exists \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john.doe@example.com",
  "msisdn": "+15551234567"
}
'
{
  "exists": true,
  "description": "user recognized by email"
}

Body

application/json

Request to check whether a user account already exists for the given email and/or phone number.

​
email
string<email>

The email address to check.

Example:

"john.doe@example.com"

​
msisdn
string<phone>

The phone number to check.

Example:

"+15551234567"

Response

User-existence check completed.

Result of a user-existence check.

​
exists
boolean
required

Whether a user account already exists for the given email and/or phone number.

Example:

true

​
description
string

Human-readable explanation of the result.

Example:

"user recognized by email"