{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Brand Identity API

Brand Identity endpoints exposed by the Devotel CPaaS API Base path: /api/v1/brand-identity Endpoint count: 7

title: “Read the consolidated trust posture” description: “One brand-verification answer across 10DLC, toll-free, WhatsApp, RCS, branded calling, and number regulatory KYC — with a single trust score and the next actions to raise it.”

Read the consolidated trust posture

Brand verification is siloed per channel: 10DLC and toll-free live in messaging compliance, WhatsApp in channel settings, RCS in sender registration, branded calling in voice trust, and number KYC in regulatory records. This endpoint is for the operations or compliance owner who needs one answer to “what blocks our deliverability today,” and for dashboards that render a single trust hub instead of six channel pages. Every source read is fail-soft — one degraded subsystem never blanks the whole hub. The response carries three blocks. summary rolls the channels into counters plus a 0-100 trustScore (= verified channels / applicable channels) and an overallState. channels lists every trust surface with its state (not_started | in_progress | verified | action_required | unavailable), a short tenant-readable detail (“2 of 3 numbers verified”), the provider’s reason when action is required, and a manageHref the dashboard deep-links for that surface. nextActions prioritizes what to fix first, each entry pointing at the dashboard path for that channel (priority is urgent or todo). One GET poll is enough — the Node SDK has no typed helper here either, so the generic request() escape hatch keeps the envelope identical. Request

cURL

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

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/status', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/brand-identity/status", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/brand-identity/status", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/status')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/status');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

A channel with state: "unavailable" is excluded from the trustScore denominator (the feature is not hooked up in your account), so the score stays honest either way.

List brand-impersonation takedown cases

GET /api/v1/brand-identity/impersonation/cases

Lists the tenant’s takedown cases (newest first), optionally filtered to a single lifecycle status.

string (enum: open|evidence_ready|reported|resolved|dismissed)

—

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

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

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Read the tenant’s brand-impersonation protected-asset watchlist

GET /api/v1/brand-identity/impersonation/watchlist

Returns the brand names, domains, and sender IDs the tenant has registered as ITS OWN assets to protect against impersonation. A never-configured tenant resolves to empty lists.

string (enum: true|false)

cURL

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

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Unified cross-channel brand trust posture

GET /api/v1/brand-identity/status

Returns one consolidated brand-identity verification posture across every trust channel (10DLC, toll-free, WhatsApp, RCS, branded calling, number regulatory KYC), rolled up into a single trust score + prioritized next-action list. Every source read is fail-soft — one degraded subsystem never blanks the hub.

string (enum: true|false)

cURL

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

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/status', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/brand-identity/status", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/brand-identity/status", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/status')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/status');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Open a brand-impersonation takedown case

POST /api/v1/brand-identity/impersonation/cases

Scores a candidate against the tenant’s brand watchlist, assembles a filing-ready takedown evidence pack (matched brand token, findings, a recommended abuse-desk recipient class, and a ready-to-send notice summary), and opens a case tracked through its lifecycle (open → evidence_ready → reported → resolved, or dismissed at any point). This ASSEMBLES the evidence pack only — actual submission to a registrar / carrier / platform abuse desk is a tenant/operator action; nothing is transmitted automatically and invariant #45 is untouched.

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "caseId": "string",
    "status": "open",
    "createdAt": "1970-01-01T00:00:00.000Z",
    "updatedAt": "1970-01-01T00:00:00.000Z",
    "evidence": {
      "caseId": "string",
      "generatedAt": "1970-01-01T00:00:00.000Z",
      "brandDisplayName": "string",
      "candidate": {
        "type": "domain",
        "value": "string",
        "channel": null,
        "observedAt": null,
        "sampleText": null,
        "sourceUrl": null
      },
      "matchedBrandToken": null,
      "score": 0,
      "band": "clean",
      "findings": [
        {
          "code": "string",
          "severity": "info",
          "points": 0,
          "detail": "string"
        }
      ],
      "recommendedRecipient": "domain_registrar_abuse",
      "noticeSummary": "string"
    },
    "note": null
  },
  "meta": {}
}

Scan candidate senders/domains for brand impersonation

POST /api/v1/brand-identity/impersonation/scan

Scores each candidate (a lookalike shortlink domain, a spoofed SMS/RCS sender ID, or a spoofed display name) against the tenant’s brand watchlist using typosquat edit-distance, homoglyph/leetspeak normalization, combosquatting, abused-TLD, and smishing lure-keyword signals. Read-only + advisory — nothing persists and nothing is transmitted; invariant #45 is untouched. To open a takedown case for a scored candidate, POST it to /impersonation/cases.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/scan');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Replace the tenant’s brand-impersonation protected-asset watchlist

PUT /api/v1/brand-identity/impersonation/watchlist

Replaces the tenant’s protected brand names, domains, and sender IDs used by the impersonation scanner and takedown-case engine to recognize the tenant’s OWN legitimate assets (so they are never flagged) and to fuzzy-match lookalike candidates against.

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.put("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist')
req = Net::HTTP::Put.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/watchlist');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Advance or dismiss a brand-impersonation takedown case

PATCH /api/v1/brand-identity/impersonation/cases/{caseId}

Transitions a takedown case through its lifecycle (open → evidence_ready → reported → resolved), or dismisses it (from any active state) / reopens a dismissed case. Returns 404 for an unknown case id and 409 for a disallowed transition.

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

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

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

const res = await fetch('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/brand-identity/impersonation/cases/{caseId}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "summary": {
      "applicable": 6,
      "verified": 4,
      "inProgress": 1,
      "actionRequired": 1,
      "notStarted": 0,
      "trustScore": 67,
      "overallState": "action_required"
    },
    "channels": [
      {
        "key": "messaging_10dlc",
        "label": "10DLC Brand (US A2P)",
        "pillar": "messaging",
        "state": "verified",
        "detail": "Campaign approved",
        "reason": null,
        "verifiedAt": "2026-05-12T09:14:42.000Z",
        "manageHref": "/settings/compliance"
      },
      {
        "key": "branded_calling",
        "label": "Branded Calling",
        "pillar": "voice",
        "state": "action_required",
        "detail": "Provider rejected the claim",
        "reason": "Logo file must be under 500 KB",
        "verifiedAt": null,
        "manageHref": "/settings/voice"
      }
    ],
    "nextActions": [
      {
        "channel": "branded_calling",
        "label": "Re-upload the branded-calling logo under 500 KB",
        "href": "/settings/voice",
        "priority": "urgent"
      }
    ]
  },
  "meta": {
    "request_id": "req_brand",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Brand Identity API

Brand Identity API

title: “Read the consolidated trust posture” description: “One brand-verification answer across 10DLC, toll-free, WhatsApp, RCS, branded calling, and number regulatory KYC — with a single trust score and the next actions to raise it.”

Read the consolidated trust posture

List brand-impersonation takedown cases

Read the tenant’s brand-impersonation protected-asset watchlist

Unified cross-channel brand trust posture

Open a brand-impersonation takedown case

Scan candidate senders/domains for brand impersonation

Replace the tenant’s brand-impersonation protected-asset watchlist

Advance or dismiss a brand-impersonation takedown case

​Brand Identity API

​title: “Read the consolidated trust posture” description: “One brand-verification answer across 10DLC, toll-free, WhatsApp, RCS, branded calling, and number regulatory KYC — with a single trust score and the next actions to raise it.”

​Read the consolidated trust posture

​List brand-impersonation takedown cases

​Read the tenant’s brand-impersonation protected-asset watchlist

​Unified cross-channel brand trust posture

​Open a brand-impersonation takedown case

​Scan candidate senders/domains for brand impersonation

​Replace the tenant’s brand-impersonation protected-asset watchlist

​Advance or dismiss a brand-impersonation takedown case

Brand Identity API

title: “Read the consolidated trust posture” description: “One brand-verification answer across 10DLC, toll-free, WhatsApp, RCS, branded calling, and number regulatory KYC — with a single trust score and the next actions to raise it.”

Read the consolidated trust posture

List brand-impersonation takedown cases

Read the tenant’s brand-impersonation protected-asset watchlist

Unified cross-channel brand trust posture

Open a brand-impersonation takedown case

Scan candidate senders/domains for brand impersonation

Replace the tenant’s brand-impersonation protected-asset watchlist

Advance or dismiss a brand-impersonation takedown case