> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otpiq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Sender IDs

> Retrieve all sender IDs associated with the authenticated project.



## OpenAPI

````yaml GET /sender-ids
openapi: 3.1.1
info:
  title: OTPIQ SMS API
  description: >-
    Enterprise-grade SMS and messaging API for sending verification codes,
    custom messages, and managing sender IDs. Supports multiple providers
    including SMS, WhatsApp, and Telegram with intelligent fallback routing.


    ## Features


    * **Multi-Provider Support**: Send messages via SMS, WhatsApp, or Telegram

    * **Smart Fallback Routes**: Automatic provider switching for maximum
    delivery success

    * **Verification Codes**: Automated OTP delivery with customizable codes

    * **Custom Messages**: Send personalized messages with custom sender IDs

    * **Rate Limiting**: Built-in protection against abuse

    * **Spending Controls**: Configurable spending thresholds and credit
    management

    * **Real-time Tracking**: Monitor message delivery status

    * **Sender ID Management**: Register and manage custom sender IDs

    * **Webhook Notifications**: Real-time delivery status updates via webhooks


    ## Provider Options


    OTPIQ now offers 6 provider options including smart fallback routes:


    - **`whatsapp-sms`**: Try WhatsApp first, fallback to SMS

    - **`telegram-sms`**: Try Telegram first, fallback to SMS

    - **`whatsapp-telegram-sms`**: Try WhatsApp → Telegram → SMS (maximum
    delivery success)

    - **`sms`**: SMS only

    - **`whatsapp`**: WhatsApp only

    - **`telegram`**: Telegram only


    ## Authentication


    All API requests require authentication using your project API key. Include
    it in the Authorization header:


    ```

    Authorization: Bearer sk_live_your_api_key_here

    ```


    ## Webhooks


    OTPIQ provides real-time delivery status notifications via webhooks. See the
    Webhooks section for detailed documentation and examples.


    ## Support


    * **Documentation**: [https://docs.otpiq.com](https://docs.otpiq.com)

    * **Support Email**: info@otpiq.com
  version: 1.0.0
  contact:
    name: OTPIQ Support
    url: https://otpiq.com
    email: info@otpiq.com
  license:
    name: Commercial
    url: https://otpiq.com/terms
servers:
  - url: https://api.otpiq.com/api
    description: Production API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: API key authentication and project information
  - name: SMS
    description: >-
      Send SMS messages, verification codes, and track delivery with multiple
      provider options and fallback routing
  - name: Sender IDs
    description: Manage custom sender IDs for your messages
  - name: Webhooks
    description: Real-time delivery status notifications via webhooks
  - name: Delivery Reports
    description: Generate and list CSV delivery reports for SMS/messages in a date range
  - name: Pricing
    description: Retrieve international SMS pricing information
  - name: WhatsApp
    description: >-
      List WhatsApp businesses, accounts, phone numbers, and message templates
      connected to a project
externalDocs:
  description: OTPIQ Documentation
  url: https://docs.otpiq.com
paths:
  /sender-ids:
    get:
      tags:
        - Sender IDs
      summary: Get sender IDs
      description: Retrieve all sender IDs associated with the authenticated project.
      operationId: getSenderIds
      responses:
        '200':
          description: >-
            Sender IDs retrieved successfully. Response body includes: success
            (boolean), data (array of SenderId).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    description: Whether the request was successful
                    examples:
                      - true
                  data:
                    type: array
                    description: Array of sender IDs
                    items:
                      type: object
                      required:
                        - _id
                        - senderId
                        - status
                        - pricePerSms
                      properties:
                        _id:
                          type: string
                          description: Unique identifier for the sender ID
                          examples:
                            - 507f1f77bcf86cd799439011
                        senderId:
                          type: string
                          description: The sender ID name
                          maxLength: 11
                          examples:
                            - OTPIQ
                        status:
                          type: string
                          enum:
                            - pending
                            - accepted
                            - rejected
                          description: Status of the sender ID approval
                          examples:
                            - accepted
                        pricePerSms:
                          type: object
                          description: Pricing per SMS for different carriers
                          properties:
                            korekTelecom:
                              type: number
                              description: Price for Korek Telecom
                              minimum: 0
                              examples:
                                - 80
                            asiaCell:
                              type: number
                              description: Price for AsiaCell
                              minimum: 0
                              examples:
                                - 80
                            zainIraq:
                              type: number
                              description: Price for Zain Iraq
                              minimum: 0
                              examples:
                                - 80
                            others:
                              type: number
                              description: Price for other carriers
                              minimum: 0
                              examples:
                                - 100
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    data:
                      - _id: 507f1f77bcf86cd799439011
                        senderId: OTPIQ
                        status: accepted
                        pricePerSms:
                          korekTelecom: 80
                          asiaCell: 80
                          zainIraq: 80
                          others: 100
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            required:
              - message
            properties:
              message:
                type: string
                description: Unauthorized error message
                examples:
                  - Unauthorized, please use your project api key
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            required:
              - message
            properties:
              message:
                type: string
                description: Internal server error message
                examples:
                  - Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Project API key (`sk_live…` or `sk_dev…`). Send it as `Authorization:
        Bearer <api_key>`.

````