Account API

The Account API allows you to retrieve metadata about your account.

Method: GET

Use

Retrieve metadata about your account.

Parameters

This endpoint requires no additional parameters.

Sample request

GET https://api.webexinteract.com/identity/v1/account

Sample response

{
  "account_uid": "acc_2Qpy74qWGaBcDeFBEXa72L",
  "account_status": "VERIFIED",
  "home_region": "UK",
  "time_zone": "en_GB",
  "default_currency": "GBP",
  "account_balance": 1000,
  "created": "2024-07-19T15:28:58Z"
}

Response Field Definitions

FieldDescription
account_uidUnique ID of the account
account_statusTrial - The account is not approved for sending messages. Awaiting phone number verification/organsation details
Verified Limited - The account is limited to sending a few test messages. Awaiting internal review.
Verified - The account is approved for normal use.
home_regionThe locale of the account.
time_zoneThe timezone of the account.
default_currencyThe account's default currency.
account_balanceThe monetary credit balance available on the account.
createdThe date time that the account was created.