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

# Account, Verify and Lookup

> Account details and balance, subaccounts, OTP verification sessions, and carrier lookup.

Applications (the webhook URLs a number points at) are documented under [Connect a number](/docs/cli/voice-agent/connect-number).

## Account

Inspect the active account, its balance, and settings.

Inspect and update the active Plivo account

| Command                | What it does                                               |
| ---------------------- | ---------------------------------------------------------- |
| `plivo account get`    | Get account details (name, billing mode, credits, address) |
| `plivo account update` | Update account profile fields                              |

<AccordionGroup>
  <Accordion title="plivo account get">
    **Command:**

    ```bash theme={null}
    plivo account get
    ```
  </Accordion>

  <Accordion title="plivo account update">
    **Command:**

    ```bash theme={null}
    plivo account update [flags]
    ```

    **Flags**

    * `--address <string>`: billing address
    * `--city <string>`: city
    * `--name <string>`: account name
    * `--timezone <string>`: IANA timezone (e.g. Asia/Kolkata)
  </Accordion>
</AccordionGroup>

## Subaccounts

Create, list, update, and delete subaccounts.

Manage subaccounts under the master account

| Command                            | What it does                         |
| ---------------------------------- | ------------------------------------ |
| `plivo account subaccounts create` | Create a subaccount                  |
| `plivo account subaccounts delete` | Delete a subaccount (requires --yes) |
| `plivo account subaccounts get`    | Get a subaccount by auth\_id         |
| `plivo account subaccounts list`   | List subaccounts                     |
| `plivo account subaccounts update` | Update a subaccount                  |

<AccordionGroup>
  <Accordion title="plivo account subaccounts create">
    **Command:**

    ```bash theme={null}
    plivo account subaccounts create [flags]
    ```

    **Flags**

    * `--enabled`: enable on creation (default true)
    * `--name <string>`: subaccount name (required)
  </Accordion>

  <Accordion title="plivo account subaccounts delete">
    **Command:**

    ```bash theme={null}
    plivo account subaccounts delete <subauth_id>
    ```
  </Accordion>

  <Accordion title="plivo account subaccounts get">
    **Command:**

    ```bash theme={null}
    plivo account subaccounts get <subauth_id>
    ```
  </Accordion>

  <Accordion title="plivo account subaccounts list">
    **Command:**

    ```bash theme={null}
    plivo account subaccounts list [flags]
    ```

    **Flags**

    * `--limit <int>`: results per page (default 20)
    * `--offset <int>`: pagination offset
  </Accordion>

  <Accordion title="plivo account subaccounts update">
    **Command:**

    ```bash theme={null}
    plivo account subaccounts update <subauth_id> [flags]
    ```

    **Flags**

    * `--enabled <string>`: true|false
    * `--name <string>`: new name
  </Accordion>
</AccordionGroup>

## Verify

Create OTP sessions and check their status. Requires the Verify service to be enabled on the account.

Plivo Verify: OTP / phone-number verification sessions Manage Verify sessions

| Command                          | What it does                                           |
| -------------------------------- | ------------------------------------------------------ |
| `plivo verify sessions create`   | Create a Verify session (spends money: requires --yes) |
| `plivo verify sessions get`      | Get a Verify session by uuid                           |
| `plivo verify sessions list`     | List Verify sessions                                   |
| `plivo verify sessions validate` | Submit the OTP to validate a session                   |

<AccordionGroup>
  <Accordion title="plivo verify sessions create">
    **Command:**

    ```bash theme={null}
    plivo verify sessions create [flags]
    ```

    **Flags**

    * `--alpha-sender <string>`: alphanumeric sender id
    * `--app-uuid <string>`: Verify application uuid (required)
    * `--channel <string>`: delivery channel: sms|voice|whatsapp (default "sms")
    * `--locale <string>`: BCP-47 locale, e.g. en-US
    * `--method <string>`: HTTP method for callback URL
    * `--recipient <string>`: E.164 destination number (required)
    * `--url <string>`: callback URL for session status events
  </Accordion>

  <Accordion title="plivo verify sessions get">
    **Command:**

    ```bash theme={null}
    plivo verify sessions get <session_uuid>
    ```
  </Accordion>

  <Accordion title="plivo verify sessions list">
    **Command:**

    ```bash theme={null}
    plivo verify sessions list [flags]
    ```

    **Flags**

    * `--limit <int>`: results per page (default 20)
    * `--offset <int>`: pagination offset
    * `--status <string>`: filter by status: pending|verified|expired
  </Accordion>

  <Accordion title="plivo verify sessions validate">
    **Command:**

    ```bash theme={null}
    plivo verify sessions validate <session_uuid> [flags]
    ```

    **Flags**

    * `--otp <string>`: OTP code received by the recipient (required)
  </Accordion>
</AccordionGroup>

## Lookup

Look up the carrier, number type, and formatting for an E.164 number.

| Command        | What it does                                                   |
| -------------- | -------------------------------------------------------------- |
| `plivo lookup` | Carrier + format lookup for an E.164 number (lookup.plivo.com) |

<AccordionGroup>
  <Accordion title="plivo lookup">
    **Command:**

    ```bash theme={null}
    plivo lookup <number> [flags]
    ```

    **Flags**

    * `--type <string>`: lookup type (currently only 'carrier' is supported by Plivo) (default "carrier")
  </Accordion>
</AccordionGroup>
