List 10DLC Brands on your account

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands?appid='

{
  "items": [
    {
      "brand_id": "BM20QP9",
      "city": "Miami",
      "company_name": "Company legal name",
      "country": "US",
      "created_at": "2024-07-24T08:10:49.000Z",
      "dba_name": "New Brand",
      "ein_taxid": "999999999",
      "ein_taxid_country": "US",
      "email": "[email protected]",
      "entity_type": "PRIVATE_PROFIT",
      "feedback": null,
      "first_name": "John",
      "last_name": "Dow",
      "mock": false,
      "phone_number": "12123450099",
      "state_or_province": "FL",
      "status": "VERIFIED",
      "stock_exchange": null,
      "stock_symbol": null,
      "street_address": "10, Street Name",
      "updated_at": "2024-07-24T08:29:09.000Z",
      "vertical": "HEALTHCARE",
      "website": "https://brand.com",
      "zip": "12345"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

GET

10dlc

brands

List 10DLC Brands on your account

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands?appid='

{
  "items": [
    {
      "brand_id": "BM20QP9",
      "city": "Miami",
      "company_name": "Company legal name",
      "country": "US",
      "created_at": "2024-07-24T08:10:49.000Z",
      "dba_name": "New Brand",
      "ein_taxid": "999999999",
      "ein_taxid_country": "US",
      "email": "[email protected]",
      "entity_type": "PRIVATE_PROFIT",
      "feedback": null,
      "first_name": "John",
      "last_name": "Dow",
      "mock": false,
      "phone_number": "12123450099",
      "state_or_province": "FL",
      "status": "VERIFIED",
      "stock_exchange": null,
      "stock_symbol": null,
      "street_address": "10, Street Name",
      "updated_at": "2024-07-24T08:29:09.000Z",
      "vertical": "HEALTHCARE",
      "website": "https://brand.com",
      "zip": "12345"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Authorizations

appid

string

query

required

An API key to authorize your request

Query Parameters

dba_name

string

Filter results by the brand name

Example:

"Brand"

company_name

string

Filter results by the company legal name

Example:

"Company"

entity_type

string

Filter results by the business entity type

Example:

"PRIVATE_PROFIT"

status

string

Filter results by Brand Identity verification status

Example:

"VERIFIED"

country

string

Filter results by a Brand’s registration country

Example:

"US"

show_deleted

boolean

default:false

Use true to query active and deleted brands. By default, the deleted Brands are excluded from the results.

Example:

false

ein_taxid

string

ein_taxid

Example:

"999999999"

mock

boolean

default:false

Use true to query the mock Brands on your account only

Example:

false

created_before

string

Filter results by specifying the end date for the Brand creation date range in the yyyy-mm-dd format

Example:

"2024-08-22T00:00:00.000Z"

created_after

string

Filter results by specifying the start date for the Brand creation date range in the yyyy-mm-dd format

Example:

"2024-08-22T00:00:00.000Z"

page

integer<int32>

The page number

Example:

1

per_page

integer<int32>

The number of records per page

Example:

25

Response

A list of 10DLC Brands

items

10DLCBrand · object[]

required

A paginated list of 10DLC Brands matching the filter criteria

Show child attributes

items.brand_id

string

required

TCR Brand unique identified

Example:

"BM20QP9"

items.dba_name

string

required

Brand name or DBA

Example:

"Brand"

items.company_name

string

required

Legal name of the company

Example:

"Company"

items.entity_type

enum<string>

required

The company entity type

Available options:

PRIVATE_PROFIT,

PUBLIC_PROFIT,

NON_PROFIT,

GOVERNMENT

Example:

"PRIVATE_PROFIT"

items.vertical

string

required

The segment the business operates in

Example:

"HEALTHCARE"

items.ein_taxid

string

required

IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.

Example:

"999999999"

items.ein_taxid_country

string

required

2-letter ISO country code of the Tax ID issuing country

Example:

"US"

items.status

enum<string>

required

Brand identity verification status

Available options:

REVIEW,

VERIFIED,

UNVERIFIED,

VETTED_VERIFIED

Example:

"VERIFIED"

items.first_name

string

required

The first name of the business contact

Example:

"John"

items.last_name

string

required

The last name of the business contact

Example:

"Dow"

items.phone_number

string

required

The support contact telephone in E.164 format

Example:

"12123450099"

items.email

string

required

The email address of the support contact

Example:

"[email protected]"

items.street_address

string

required

Street name and house number

Example:

"10, City Name"

items.city

string

required

The city name

Example:

"Miami"

items.country

string

required

2-letter ISO country code the business address

Example:

"US"

items.zip

string

required

The business zip or postal code

Example:

"12345"

items.feedback

string | null

required

The Brand Identity verification feedback, if any

items.created_at

string

required

Date and time the Brand was created

Example:

"2024-07-24T08:29:09.000Z"

items.updated_at

string

required

Date and time the Brand was updated

Example:

"2024-07-24T08:29:09.000Z"

items.website

string

The website of the business

Example:

"https://brand.com"

items.stock_symbol

string | null

The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.

items.stock_exchange

string | null

The stock exchange code. For PUBLIC_PROFIT Brands only.

items.state_or_province

string | null

State or province. For the United States, use 2 character codes.

Example:

"FL"

items.mock

boolean

default:false

Indicates a mock Brand. You can create mock Brands for testing purposes only, production traffic with the mock Brands is prohibited.

Example:

false

pagination

Pagination · object

required

Pagination details

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

Inbound message

Using the APIs

API reference

List 10DLC Brands on your account

Authorizations

Query Parameters

Response