10DLC Registration
Request brand authentication
Starts the registry’s brand authentication for a brand whose brandType is TENDLC_PUBLIC_COMPANY.
POST
/
10dlc
/
brands
/
{id}
/
brand-auth-verification
cURL
curl --request POST \
--url https://api.vobiz.ai/api/v1/sms/10dlc/brands/{id}/brand-auth-verification \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.brands.brand_auth_verification(
id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
)
const options = {
method: 'POST',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/brands/{id}/brand-auth-verification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "requested"
}{
"error": "invalid request: brand authentication is only available for TENDLC_PUBLIC_COMPANY brands"
}{
"error": "missing or invalid credentials"
}{
"error": "brand not found"
}{
"error": "registration provider rejected the request: brand is not yet submitted",
"providerError": "registration error 403 (HTTP 403): brand is not yet submitted"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
Brand ID (UUID) returned by POST /10dlc/brands. An unknown ID, an ID from another account, or a value that is not a UUID returns 404 with {"error":"brand not found"}.
Response
The request was accepted. Track progress with GET /10dlc/brands/{id}/registrar-statuses.
Acknowledgement that the registry accepted a brand-authentication or 2FA resend request. The outcome arrives later on the brand.
Always requested. Follow the result in the brand's registrationStatus or in GET /10dlc/brands/{id}/registrar-statuses.
Example:
"requested"
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.vobiz.ai/api/v1/sms/10dlc/brands/{id}/brand-auth-verification \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.brands.brand_auth_verification(
id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
)
const options = {
method: 'POST',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/brands/{id}/brand-auth-verification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "requested"
}{
"error": "invalid request: brand authentication is only available for TENDLC_PUBLIC_COMPANY brands"
}{
"error": "missing or invalid credentials"
}{
"error": "brand not found"
}{
"error": "registration provider rejected the request: brand is not yet submitted",
"providerError": "registration error 403 (HTTP 403): brand is not yet submitted"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}