Get brand

GET

https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/:id

GET

/api/relay/rest/registry/beta/brands/:id

$ curl https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id \
>      -u "<project_id>:<api_token>"

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "state": "pending",
4   "name": "My Brand",
5   "company_name": "BrandCo",
6   "contact_email": "brand_info@example.com",
7   "contact_phone": "+18995551212",
8   "ein_issuing_country": "United States",
9   "legal_entity_type": "Private Company",
10   "ein": "12-3456789",
11   "company_address": "123 Brand St, Hill Valley CA, 91905",
12   "company_vertical": "Healthcare",
13   "company_website": "www.example.com",
14   "csp_brand_reference": "string",
15   "csp_self_registered": false,
16   "status_callback_url": "https://example.com/handle_callback",
17   "created_at": "2024-01-15T09:30:00Z",
18   "updated_at": "2024-01-15T09:30:00Z"
19 }

Retrieves one US 10-digit long code (10DLC) brand registration by ID so you can check its business identity and registration progress. Use List brands to discover IDs or List campaigns for messaging use cases registered under the brand.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.

Learn more about API scopes.

Retrieves one US 10-digit long code (10DLC) brand registration by ID so you can check its business identity and registration progress. Use [List brands](/docs/apis/rest/campaign-registry/brands/list-brands) to discover IDs or [List campaigns](/docs/apis/rest/campaign-registry/campaigns/list-campaigns) for messaging use cases registered under the brand. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Messaging_ and _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the brand.

Response

The request has succeeded.

idstringformat: "uuid"

The unique identifier of the brand.

statestringOptional

The current state of the brand.

namestringOptional

Brand/Marketing/DBA name of the business if applicable.

company_namestringOptional

The legal name of the business.

contact_emailstringOptional

A company contact email for this brand.

contact_phonestringOptional

A contact phone number for this brand.

ein_issuing_countrystringOptional

Country of registration.

legal_entity_typestringOptional

What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)

einstringOptional

Company EIN Number/Tax ID.

company_addressstringOptional

Full company address.

company_verticalstringOptional

An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION).

company_websitestringOptional

Link to the company website.

csp_brand_referencestringOptional

If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit).

csp_self_registeredbooleanOptional

This value must be true for all self-registered brands.

status_callback_urlstringOptional

Optional: Specify a URL to receive webhook notifications when your brand’s state changes. See the 10DLC status callback docs for the webhook payload.

created_atdatetimeOptional

Timestamp when the brand was created.

updated_atdatetimeOptional

Timestamp when the brand was last updated.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error