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

string

Yes

Unique identifier of the Sender ID verification.

Data Attributes#

Name

Type

Description

name

string

Name of the Sender ID verification.

status

string

Lifecycle state of the verification. Possible values: active, changes_required, closed, closing_in_process, in_process, new. A closed verification cannot be updated.

sender_type

string

Kind of sender the verification covers. Possible values: alphanumeric, carrier, long_code, short_code, toll_free.

sender_ids

Array of strings

Sender IDs the verification covers. For long_code and toll_free verifications, they are the numbers of the account’s dids.

reference

string

Human-readable reference.

reject_reasons

Array of strings

Reasons the last submission was rejected. null unless status is changes_required, and when there are none.

reject_comment

string

Reviewer comment on the rejection. null unless status is changes_required.

renew_date

date

Next renewal date. null once closed.

created_at

DateTime

The date and time when the verification was created.

activated_at

DateTime

The date and time when the verification was activated. Can be null.

closed_at

DateTime

The date and time when the verification was closed. Can be null.

Object Relationships#

Name

Type

Description

sms_trunk

to-one

SMS Trunk Object. SMS trunk outbound messages are routed through. Can be null.

countries

to-many

Country Object. Read-only. Countries of the verification.

dids

to-many

DID Object. Read-only. DIDs of the verification. For long_code and toll_free verifications, sender_ids contains their numbers.

order

to-one

Order Object. Read-only. Order of the verification. Can be null.

identity

to-one

Identity Object. Read-only. Identity of the verification. Can be null.

address

to-one

Addresses Object. Read-only. Address of the verification. Can be null.

Object Meta#

Name

Type

Description

setup_price

string

One-off activation charge, as a decimal string.

monthly_price

string

Recurring monthly charge, as a decimal string.