Sender ID Verification Object#
JSON:API object with type sender_id_verifications.
Only name and the sms_trunk relationship can be changed. See
Update Sender ID Verification.
Request#
URI Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique identifier of the Sender ID verification. |
Data Attributes#
Name |
Type |
Description |
|---|---|---|
name |
|
Name of the Sender ID verification. |
status |
|
Lifecycle state of the verification. Possible values: |
sender_type |
|
Kind of sender the verification covers. Possible values: |
sender_ids |
Array of |
Sender IDs the verification covers. For |
reference |
|
Human-readable reference. |
reject_reasons |
Array of |
Reasons the last submission was rejected. |
reject_comment |
|
Reviewer comment on the rejection. |
renew_date |
|
Next renewal date. |
created_at |
|
The date and time when the verification was created. |
activated_at |
|
The date and time when the verification was activated. Can be |
closed_at |
|
The date and time when the verification was closed. Can be |
Object Relationships#
Name |
Type |
Description |
|---|---|---|
sms_trunk |
to-one |
SMS Trunk Object. SMS trunk outbound messages are routed through. Can be |
countries |
to-many |
Country Object. Read-only. Countries of the verification. |
dids |
to-many |
DID Object. Read-only. DIDs of the verification. For |
order |
to-one |
Order Object. Read-only. Order of the verification. Can be |
identity |
to-one |
Identity Object. Read-only. Identity of the verification. Can be |
address |
to-one |
Addresses Object. Read-only. Address of the verification. Can be |
Object Meta#
Name |
Type |
Description |
|---|---|---|
setup_price |
|
One-off activation charge, as a decimal string. |
monthly_price |
|
Recurring monthly charge, as a decimal string. |