Skip to navigation
API Referenceregistration

Get Registration Status

Check registration status in the selected account scope. Pass X-Sub-Account-Id when checking a campaign created in a sub-account. Review stage and campaign_status; account approval alone does not establish readiness for a specific number. Check outboundSms on that number. See SMS registration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Sub-Account-IdstringOptional

Response

Successful Response
campaign_statusstring
messagestring
stagestring or nullOptional
issueobject or nullOptional

Set when stage is action_required: the reason and what to change. For a registration under review, resubmitting with PATCH /v1/register clears it. A registration that failed carrier review (campaign_status back to none) is resubmitted with POST /v1/register; a suspended one needs support.

sub_account_idstring or nullOptional

Set when the registration lives on a sub-account of the calling account (the default for POST /v1/register). Pass it as the X-Sub-Account-Id header to address that sub-account directly.