Skip to main content
POST
/
v3
/
phone
/
send
Send Phone Code
curl --request POST \
  --url https://verification.didit.me/v3/phone/send/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phone_number": "<string>",
  "options": {
    "code_size": 6,
    "locale": "<string>",
    "preferred_channel": "whatsapp"
  },
  "signals": {
    "ip": "127.0.0.1",
    "device_id": "<string>",
    "device_platform": "android",
    "device_model": "<string>",
    "os_version": "<string>",
    "app_version": "<string>",
    "user_agent": "<string>"
  },
  "vendor_data": "<string>"
}
'
{
  "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24",
  "status": "Success",
  "reason": null
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
phone_number
string
required

The phone number to verify in E.164 format. e.g. +14155552671

​
options
object

Options for the phone verification, such as code_size, locale, and preferred_channel.

​
signals
object

A dictionary of signals for fraud detection. Keys are signal names (string) and values are signal values (string).

​
vendor_data
string

A unique identifier for the vendor or user, such as a UUID or email. This field enables proper session tracking and user data aggregation across multiple verification sessions.

Response

OK

​
request_id
string<uuid>

Unique identifier for the session/request.

​
status
enum<string>

Status of the send operation (e.g., 'Success', 'Undeliverable', 'Retry').

Available options:
Success,
Undeliverable,
Retry
​
reason
string | null

Reason for the status (only applies to 'Undeliverable').