WAwavix
10DLC

List 10DLC Brands

Changed on

Returns a paginated list of 10DLC Brands for the authenticated account, filtered by date, name, legal name, and status.

get/v3/10dlc/brands

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/10dlc/brands
  • Auth
    HTTP bearer

Query parameters

dba_namestring
Example:Brand

Filters Brands by dba_name (doing-business-as name). Matches partial values.

company_namestring
Example:Company

Filters Brands by company_name (registered legal name). Matches partial values.

entity_typestring
Example:PRIVATE_PROFIT

Filters Brands by business entity type, such as PRIVATE_PROFIT.

statusstring
Example:VERIFIED

Filters Brands by identity verification status, such as VERIFIED.

countrystring
Example:US

Filters Brands by registration country, as an ISO 3166-1 alpha-2 code (e.g., US).

show_deletedboolean

When true, includes deleted Brands in the results. Default false.

ein_taxidstring
Example:999999999

Filters Brands by their Employer Identification Number (EIN) or tax ID.

mockboolean

When true, returns only mock Brands used for testing. Default false.

created_beforestring
Example:2024-08-22

Returns brands created on or before this date, in YYYY-MM-DD format.

created_afterstring
Example:2024-08-22

Returns brands created on or after this date, in YYYY-MM-DD format.

pageinteger
Example:1

Page number to retrieve. Default 1.

per_pageinteger
Example:25

Number of records to return per page. Default 25.

Response

Returns a paginated list of 10DLC Brands.

Example response

{
  "items": [
    {
      "brand_id": "BM20QP9",
      "city": "Miami",
      "company_name": "Company legal name",
      "country": "US",
      "created_at": "2024-07-24T08:10:49",
      "dba_name": "New Brand",
      "ein_taxid": "12345",
      "ein_taxid_country": "US",
      "email": "support@brand.com",
      "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",
      "vertical": "HEALTHCARE",
      "website": "https://brand.com",
      "zip": "12345"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Changes

  • d4db3aae3627Revision changes
    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to object for status

    • warning

      added the new GOVERNMENT enum value to the // response property for the response status

    • warning

      added the new NON_PROFIT enum value to the // response property for the response status

    • warning

      added the new PRIVATE_PROFIT enum value to the // response property for the response status

    • warning

      added the new PUBLIC_PROFIT enum value to the // response property for the response status

    • warning

      added the new REVIEW enum value to the // response property for the response status

    • warning

      added the new SUSPENDED enum value to the // response property for the response status

    • warning

      added the new UNVERIFIED enum value to the // response property for the response status

    • warning

      added the new VERIFIED enum value to the // response property for the response status

    • warning

      added the new VETTED_VERIFIED enum value to the // response property for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status