Sender ID Verifications#
Note
To learn how Sender ID verification works, see Sender ID Verifications.
Use the Sender ID Verifications resource to retrieve the Sender ID verifications of your account, and to change their name or SMS trunk.
A Sender ID verification is a verification request for a sender identity used for outbound
messages. The sender_type attribute shows the kind of sender it covers: alphanumeric,
carrier, long_code, short_code, or toll_free. The sender_ids attribute
lists the covered Sender IDs. For long_code and toll_free verifications, they are the
numbers of the account’s dids.
Each verification provides its reference, status, renewal date, charges, and the SMS Trunk its outbound messages are routed through.
Sender ID verifications are available starting from version 2026-11-19.
Requirements and behavior#
When updating a Sender ID verification:
Only
nameand thesms_trunkrelationship can be changed.sms_trunkaccepts onlyhttp_out,smpp_smsc, andsmpp_esmetrunks.Send
sms_trunkwithdata: nullto unassign the trunk. Outbound messages then stop until a trunk is assigned again.The request is rejected with
422when another verification already uses a Sender ID of this one on the SMS trunk.A
closedverification cannot be updated. The request is rejected with422.
Deleting an SMS trunk leaves the verifications that use it without a trunk, and their outbound messages stop until another trunk is assigned.
Endpoints#
Action |
Method |
Endpoint |
|---|---|---|
Retrieve all Sender ID Verifications |
|
|
Retrieve Sender ID Verification |
|
|
Update Sender ID Verification |
|
|
Retrieve all Sender ID Verifications#
Retrieves all Sender ID verifications of the account.
Use this endpoint to filter verifications by ID, name, reference, status, sender type, or SMS trunk, and sort results by name, status, creation time, or renewal date. The SMS trunk, countries, DIDs, order, identity, and address can be included in the response.
See Retrieve All Sender ID Verifications.
GET /v3/sender_id_verifications
Retrieve Sender ID Verification#
Retrieves a specific Sender ID verification by its unique ID.
Use this endpoint to inspect the status of the verification, the reasons the last submission was rejected, its renewal date, and its charges.
See Retrieve Sender ID Verification.
GET /v3/sender_id_verifications/{id}
Update Sender ID Verification#
Updates a specific Sender ID verification.
Use this endpoint to change the name of the verification, or the SMS trunk its outbound messages are routed through.
See Update Sender ID Verification.
PATCH /v3/sender_id_verifications/{id}
Data reference#
See Sender ID Verification Object for the complete attribute, relationship, and metadata definitions.
Common Sender ID Verification use cases#
Use case |
Description |
|---|---|
Track verification status |
Filter by |
Route outbound messages |
Assign an |
Find the verifications of a trunk |
Filter by |
Plan renewals |
Sort by |
Limit an outbound SMS export |
Use the verification ID in the |