---
title: "Read Registration Status"
method: GET
path: "/setup/registration/status"
tags: ["setup"]
---

# Read Registration Status

`GET /setup/registration/status`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/setup/registration/status`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Query parameters

- `approval_gated` boolean

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- RegistrationCompletionPublic
  - `correction_available` boolean
  - `request` RegistrationRequestPublic, required
    - `id` string, required
    - `status` string, required
    - `accepted_at` string, date-time, required
    - `review` RegistrationReviewPublic, required
      - `provider` 'twilio' | 'telnyx', required
      - `selected_number` string, required
      - `version` string, required
      - `identity` BusinessIdentitySummaryPublic, required: The confirmed company profile as Step 4 presents it: read-only, no representatives.
        - `legal_name` string, nullable
        - `dba_name` string, nullable
        - `ein_last_four` string, nullable
        - `entity_type` string, nullable
        - `company_type` string, nullable
        - `vertical` string, nullable
        - `trades` string[], nullable
        - `phone` string, nullable
        - `street` string, nullable
        - `city` string, nullable
        - `state` string, nullable
        - `postal_code` string, nullable
        - `country` string, nullable
        - `website_url` string, nullable
        - `complete` boolean
      - `campaign` BusinessCampaignPublic, required
        - `program_name` string, nullable
        - `program_description` string, nullable
        - `use_case_categories` string[], nullable
        - `use_case_subcategories` string[], nullable
        - `sample_messages` string[], nullable
        - `expected_message_volume` string, nullable
      - `opt_in` RegistrationOptInReview, required
        - `opt_in_type` string, nullable
        - `opt_in_description` string, nullable
        - `opt_in_evidence_urls` string[], nullable
        - `message_frequency` string, nullable
        - `help_message` string, nullable
        - `stop_message` string, nullable
        - `terms_url` string, nullable
        - `privacy_url` string, nullable
      - `acceptance_version` 'campaign-approval-v2' | 'provider-preparation-v3', nullable
      - `eligible_providers` MessagingProvider[], nullable
  - `state` 'received' | 'waiting_identity' | 'processing' | 'carrier_review' | 'approved' | 'needs_attention', required
  - `phase` 'campaign_review' | 'purchase_pending' | 'assignment_pending' | 'choose_number' | 'ready', nullable
  - `selected_number` string, nullable
  - `customer_action` 'none' | 'provide_evidence' | 'contact_support' | 'choose_number' | 'select_number'
  - `support_email` string
  - `registration_progress` RegistrationProgress
    - `carriers` CarrierRegistrationProgress[], required
      - `provider` 'twilio' | 'telnyx', required
      - `identity_status` 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'suspended'
      - `campaign_status` 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'suspended'
      - `identity_registration_id` string, nullable
      - `campaign_registration_id` string, nullable
      - `service_profile_id` string, nullable
      - `action` 'none' | 'resume' | 'correct_details' | 'contact_support'
      - `correction_target` 'business' | 'campaign', nullable
      - `blocker_code` string, nullable
      - `last_observed_at` string, date-time, nullable
      - `history` RegistrationHistoryItem[]
        - `id` string, required
        - `registration_id` string, required
        - `phone_number` string, nullable
        - `stage` string, required
        - `status` 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'suspended', required
        - `reason` string, nullable
        - `occurred_at` string, date-time, nullable
        - `observed_at` string, date-time, required
        - `source` 'api' | 'poll' | 'webhook' | 'snapshot', required
        - `event_type` string, nullable
      - `history_has_more` boolean
      - `history_next_cursor` string, nullable
    - `campaign_approval_complete` boolean
    - `approved_provider` 'twilio' | 'telnyx'

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)