Brand Identity API

Registering a brand’s trust posture is normally scattered across six unrelated flows — a 10DLC brand + campaign, a toll-free verification, a WhatsApp Business verification, an RCS agent verification, branded calling (RCD/CNAM), and per-number regulatory KYC. Brand Identity doesn’t replace any of those registration flows; it reads the current status of each one and rolls them into a single trust score plus a prioritized list of what to do next, so a tenant can see “how verified am I, everywhere” at a glance instead of checking six settings pages. Base path: /api/v1/brand-identity Authentication: API key (X-API-Key) or session JWT. Any authenticated role (owner, admin, developer, viewer) can read the status.

Method	Path	Purpose
`GET`	`/api/v1/brand-identity/status`	Unified cross-channel brand-trust verification posture

Channels covered

Each channel is scored independently, then combined into the overall posture:

Channel key	Pillar	Source
`messaging_10dlc`	Messaging	10DLC brand + campaign registration
`messaging_toll_free`	Messaging	Toll-free verification (TFV)
`branded_calling`	Voice	RCD / CNAM branded calling
`rcs_business`	Messaging	RCS verified business sender
`whatsapp_business`	Messaging	WhatsApp Business verification
`number_regulatory`	Voice	Per-number regulatory KYC

Each channel reports one of five states: not_started, in_progress, verified, action_required, or unavailable (the underlying subsystem couldn’t be reached this call — it degrades that one channel rather than failing the whole response).

Read the status

No typed SDK helper wraps this endpoint yet, so each language uses the SDK’s generic request() escape hatch — same auth, same automatic 429/5xx retry with backoff, same { data, meta } envelope as a raw curl call.

curl "https://api.orbit.devotel.io/api/v1/brand-identity/status" \
  -H "X-API-Key: dv_live_sk_your_key_here"

import { Orbit } from '@devotel-orbit/node';

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY });

const { data: status } = await orbit.request<{ data: unknown }>(
  'GET',
  '/api/v1/brand-identity/status',
);

console.log(status.summary.trustScore);  // 0-100
console.log(status.summary.overallState); // 'verified' | 'action_required' | …

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

status = client.request("GET", "/brand-identity/status")

print(status["data"]["summary"]["trustScore"])    # 0-100
print(status["data"]["summary"]["overallState"])  # 'verified' | 'action_required' | …

client, err := orbit.NewClient(os.Getenv("ORBIT_API_KEY"))
if err != nil {
    log.Fatal(err)
}

var status map[string]any
if err := client.Request(
    context.Background(),
    "GET",
    "/brand-identity/status",
    nil, nil, &status, "",
); err != nil {
    log.Fatal(err)
}

fmt.Println(status["data"].(map[string]any)["summary"])

require "orbit_sdk"

client = OrbitSdk::Client.from_env

status = client.request("GET", "/brand-identity/status")

puts status["data"]["summary"]["trustScore"]    # 0-100
puts status["data"]["summary"]["overallState"]  # 'verified' | 'action_required' | …

<?php
use Devotel\Orbit\OrbitClient;

$client = OrbitClient::fromEnv();

$status = $client->request(
    method: "GET",
    path: "/brand-identity/status",
);

echo $status["data"]["summary"]["trustScore"] . PHP_EOL;    // 0-100
echo $status["data"]["summary"]["overallState"] . PHP_EOL;  // 'verified' | 'action_required' | …

The Python, Go, Ruby, and PHP clients address paths relative to /api/v1 — drop the /api/v1 prefix there; curl and the Node client take the full path.

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 3,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 1,
      "trustScore": 50,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC messaging",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Brand + campaign approved",
        "reason": null,
        "verifiedAt": "2026-04-02T10:00:00.000Z",
        "manageHref": "/settings/compliance/10dlc"
      }
    ],
    "nextActions": [
      {
        "channel": "whatsapp_business",
        "label": "Complete WhatsApp Business verification",
        "href": "/settings/compliance/whatsapp",
        "priority": "urgent"
      }
    ]
  },
  "meta": { "request_id": "req_abc123", "timestamp": "2026-06-18T14:09:00.000Z" }
}

trustScore is verified / applicable (rounded to an integer 0–100); a channel in unavailable doesn’t count against the score. nextActions is sorted so the highest-priority gaps (urgent before todo) appear first — this is what the dashboard’s brand-trust widget renders directly.

Degraded response — one subsystem down

Every per-channel read is fail-soft: when a source subsystem can’t be reached (here the RCS business-messaging service is down), the response still returns 200, that channel reports unavailable, and it is dropped from the score — the remaining channels still report normally:

{
  "data": {
    "summary": {
      "applicable": 5,
      "verified": 3,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 1,
      "trustScore": 60,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC messaging",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Brand + campaign approved",
        "reason": null,
        "verifiedAt": "2026-04-02T10:00:00.000Z",
        "manageHref": "/settings/compliance/10dlc"
      },
      {
        "key": "rcs_business",
        "label": "RCS verified business sender",
        "pillar": "messaging",
        "state": "unavailable",
        "detail": "RCS verification subsystem is temporarily unreachable",
        "reason": null,
        "verifiedAt": null,
        "manageHref": "/settings/compliance/rcs"
      }
    ],
    "nextActions": [
      {
        "channel": "whatsapp_business",
        "label": "Complete WhatsApp Business verification",
        "href": "/settings/compliance/whatsapp",
        "priority": "urgent"
      }
    ]
  },
  "meta": { "request_id": "req_def456", "timestamp": "2026-06-18T14:11:00.000Z" }
}

Two things to read off the summary in a degraded call:

applicable drops from 6 to 5 — unavailable channels are excluded from scoring, so trustScore recomputes against the channels that did answer (3 verified of 5 applicable → 60). A subsystem outage never drags the score down.
overallState still reflects the channels that answered. If every source read failed, applicable is 0 and overallState is unavailable with trustScore: 0 — distinguish that case from “nothing verified yet” by checking applicable, not the score.

Retry the call on unavailable — the state is transient and self-clears once the underlying subsystem answers again. Poll with ordinary backoff; do not treat it as proof a registration was lost.

Errors

All errors ship the same envelope:

{
  "error": { "code": "RATE_LIMITED", "message": "Rate limit exceeded", "status": 429 },
  "meta": { "request_id": "req_ghi789", "timestamp": "2026-06-18T14:12:00.000Z" }
}

HTTP	`error.code`	Cause	Remedy
`401`	`UNAUTHORIZED`	Missing or invalid API key / session	Send a valid key in `X-API-Key`
`403`	`FORBIDDEN`	Authenticated, but the API key or session role has no read access	Use a key/session with `owner`, `admin`, `developer`, or `viewer`
`429`	`RATE_LIMITED`	Shared authenticated-read limiter tripped	Honor the `Retry-After` header and back off

The SDK escape hatches handle the common call/retry shape themselves: a 429 is retried automatically up to the SDK’s retry budget, then surfaced as a rate-limit error (OrbitRateLimitError in Node, Python, Ruby, and PHP, orbit.IsRateLimit(err) in Go). A raw-curl caller must honor the Retry-After header on its own. A single degraded channel is never an error — it arrives as a 200 with state: "unavailable" (above).

API Reference

All Endpoints

Brand Identity API: cross-channel trust scoring

Brand Identity API

Channels covered

Read the status

Degraded response — one subsystem down

Errors

See also

​Brand Identity API

​Channels covered

​Read the status

​Degraded response — one subsystem down

​Errors

​See also

Brand Identity API

Channels covered

Read the status

Degraded response — one subsystem down

Errors

See also