Zum Hauptinhalt springen
POST
curl
Verwenden Sie POST /v3/phone/risk/, wenn Sie Telefon-Intelligence vor, anstelle von oder außerhalb eines OTP-Ablaufs benötigen. Der Endpoint sendet keinen Code an den Benutzer. Er erstellt eine API-Sitzung, reichert die Nummer an, wendet Ihre Phone-Risk-Regeln an und gibt in einer synchronen Antwort denselben normalisierten Telefonblock zurück, den auch die Telefonverifizierung verwendet. Wenn die Anfrage gespeichert wird, kann Didit die bewertete Telefonnummer zusätzlich als aggregierte Evidenz in Netzwerke verwenden. Netzwerkgraphen können bei gemeinsam genutzten Telefonsignalen risikoreiche Telefon-Intelligence, Rufnummernportierung und Kontext zum Leitungstyp anzeigen. Sie zeigen anderen Organisationen jedoch nicht die Telefonnummer im Rohformat.

Antwort interpretieren

  • status ist die endgültige Entscheidung für diese API-Sitzung. Sie lautet normalerweise Approved; die Risikobewertung kann auch In Review oder Declined ergeben.
  • phone.full_number ist die normalisierte Nummer im E.164-Format. phone.phone_number_prefix und phone.phone_number teilen sie in die internationale Vorwahl und die nationale Nummer auf.
  • phone.is_disposable und phone.is_virtual sind stabile Ja-/Nein-Signale für Ihre Anwendungslogik. Die Carrier-Abfrage ergänzt carrier.name und carrier.type (mobile, voip und ähnliche Werte).
  • phone.phone_intelligence.score verwendet eine Risikoskala von 0 bis 100, wobei ein höherer Wert ein höheres Risiko bedeutet. phone_type_risk (Low, Medium, High) und phone_trust_index (inverser Wert des Scores) sind abgeleitete Ansichten.
  • phone.phone_intelligence und phone.enrichment sind Kompatibilitätsaliase mit demselben normalisierten Objekt. Neue Integrationen sollten phone.enrichment lesen.
  • phone.matches listet andere Sitzungen Ihrer Anwendung auf, in denen dieselbe Nummer von einem anderen Benutzer verwendet wurde. Nutzen Sie das Feld zur Erkennung doppelter Konten.
  • request_id ist die ID der API-Sitzung. Speichern Sie sie zusammen mit vendor_data, wenn Sie das Ergebnis mit späteren Webhooks oder Aktivitäten in der Console abgleichen müssen.
phone.phone_intelligence und phone.enrichment sind Felder, die nach Möglichkeit bereitgestellt werden. Eine abgeschlossene Abfrage kann beide auslassen, wenn für diese Nummer, dieses Land oder diesen Tarif keine verwertbaren Intelligence-Daten zurückgegeben werden. Bauen Sie Regeln zuerst auf den stabilen normalisierten Feldern auf und behandeln Sie fehlende Intelligence als „unbekannt“, nicht als „sicher“.

Zusatzmodul Social Footprint

Setzen Sie enable_social auf true, damit der Antwort unter phone ein Block phone_social hinzugefügt wird. Er enthält die Online-Plattformen, auf denen diese Telefonnummer registriert ist, nach Kategorien gruppiert, mit den zusammenfassenden Zählwerten und allen Profildetails, die unsere Datenpartner zurückgeben.
  • phone.phone_social.profiles_registered und phone.phone_social.profiles_checked sind die wichtigsten Kennzahlen: Plattformen, auf denen die Telefonnummer nachweislich registriert ist, bezogen auf die geprüften Plattformen.
  • phone.phone_social.registered_platforms und phone.phone_social.not_registered_platforms listen jede Plattform mit ihrer category und ihrem scope auf (global oder local für regionsspezifische Plattformen).
  • phone.phone_social.categories gibt pro Kategorie die Anzahl der Registrierungen und das Verhältnis an. phone.phone_social.profiles enthält Profildetails pro Plattform, sofern eine Plattform sie bereitstellt (Name, Foto-URL, Info-Text, Datenschutzstatus, Kennzeichen für Geschäftskonten).
  • Zusammenfassende Indizes (digital_footprint_diversity, digital_sophistication_index, engagement_depth_index, subscription_affordability_index) sind zusammengesetzte Werte von 0 bis 10. Jeder Zählwert kann null sein, wenn die Prüfung dafür keine Daten geliefert hat.
profiles_registered: 0 ist eine gültige Antwort und kein Fehler: Die Plattformen wurden geprüft, und die Telefonnummer wurde auf keiner davon gefunden. Das ist ein häufiges Signal für synthetische Identitäten. Dieser Endpoint leitet daraus allein keine Aktion ab. Verwenden Sie phone_no_social_presence_action in einem Workflow, um daraus eine Entscheidung zur Prüfung oder Ablehnung zu machen. Der Block fehlt, wenn enable_social nicht gesetzt ist. Er fehlt auch, wenn die Social-Prüfung nicht abgeschlossen werden konnte. In diesem Fall wird sie nicht abgerechnet.

Verhalten in der Sandbox

Sandbox-Schlüssel validieren die Anfrage und geben deterministische, genehmigte Daten zurück. Sie senden keinen OTP, verbrauchen keine Credits, erstellen keine Sitzung und tragen nicht zu Netzwerken bei. Wenn enable_social gesetzt ist, geben sie außerdem einen deterministischen Block phone_social zurück.

Abrechnung

Aufrufe der Phone Risk API kosten $0.04 zum Listenpreis. Das ist weniger als eine vollständige Telefonverifizierung, weil kein OTP gesendet wird. Eine Live-Anfrage ist abrechenbar, sobald die Abfrage startet, auch wenn einige Best-Effort-Felder nicht verfügbar sind. Das Zusatzmodul Social Footprint wird separat abgerechnet: eine Einheit phone_social pro Anfrage zusätzlich zum Preis der Phone Risk API, sobald die Prüfung abgeschlossen ist. Die Credit-Prüfung vor der Abfrage umfasst beides.

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Body

application/json
phone_number
string
erforderlich

Zu bewertende Telefonnummer. Sie wird validiert und auf E.164 normalisiert.

Maximum string length: 20
Beispiel:

"+14155552671"

country_code
string

Optionaler ISO 3166-1 alpha-2- oder alpha-3-Länderhinweis für die Informationsabdeckung.

Maximum string length: 3
Beispiel:

"US"

signals
object

Optionaler Geräte- und Netzwerkkontext, der von Ihrer Anwendung beobachtet wird. Alle Felder sind optional. Ihre Übergabe speist die sitzungsübergreifende Übereinstimmungserkennung in Networks.

vendor_data
string

Ihre stabile Referenz für diese Anfrage. Wird in der API-Sitzung gespeichert und in der Antwort zurückgegeben.

metadata
object | null

Ihre nicht sensiblen JSON-Metadaten. Werden in der API-Sitzung gespeichert und in der Antwort zurückgegeben.

enable_social
boolean
Standard:false

Wenn true, wird auch der digitale Fußabdruck der Nummer ermittelt – die Messaging-, Social-, E-Commerce- und Berufs-Plattformen, auf denen sie registriert ist. Wird als eine phone_social-Einheit pro Anfrage zusätzlich zum regulären Preis dieses Endpoints abgerechnet.

Beispiel:

true

Antwort

Die Risikobewertung wurde abgeschlossen. Prüfen Sie status für die Entscheidung; HTTP ist bei abgeschlossenen Abfragen immer 200.

request_id
string<uuid>
erforderlich

ID der API-Sitzung, die für diese Anfrage erstellt wurde. Speichern Sie sie zusammen mit vendor_data, wenn Sie das Ergebnis mit späteren Webhooks oder Konsolenaktivitäten korrelieren müssen.

status
enum<string>
erforderlich

Endgültige Entscheidung für diese API-Sitzung. Normalerweise Approved; die Risikobewertung kann In Review oder Declined ergeben.

Verfügbare Optionen:
Approved,
In Review,
Declined
created_at
string<date-time>
erforderlich

Zeitstempel dieser Antwort.

vendor_data
string | null

Rückgabe der von Ihnen gesendeten vendor_data, null, wenn Sie keine gesendet haben.

metadata
object | null

Rückgabe der von Ihnen gesendeten metadata, null, wenn Sie keine gesendet haben.

phone
object

Normalisierter Telefonbericht, derselbe Block wie in den Antworten der Telefonverifizierung.

Zuletzt geändert am 7. November 2026