Erste Schritte
Integrieren / SDKs
Benutzerverifizierung
Unternehmensverifizierung
Transaktionsüberwachung
Changelogcurl -X POST https://verification.didit.me/v3/phone/check/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"phone_number": "+14155552671",
"code": "123456",
"voip_number_action": "DECLINE"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.phone.check_code(
phone_number="+14155552671",
code="123456",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.phone.checkCode({
phone_number: "+14155552671",
code: "123456",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{
PhoneNumber: "+14155552671",
Code: "123456",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.PhoneCheckCodeParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.phone().checkCode(PhoneCheckCodeParams.builder()
.phoneNumber("+14155552671")
.code("123456")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->phone->checkCode([
'phone_number' => '+14155552671',
'code' => '123456',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.phone.check_code(
phone_number: "+14155552671",
code: "123456"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams
{
PhoneNumber = "+14155552671",
Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));Telefoncode-Prüfung API: SMS-OTP validieren
POST /v3/phone/check/ validiert einen Telefon-OTP mit Carrier-Typ, virtueller Nummer und Wegwerfnummer-Erkennung. Abrechnung pro Nutzung, keine Mindestgebühren.
curl -X POST https://verification.didit.me/v3/phone/check/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"phone_number": "+14155552671",
"code": "123456",
"voip_number_action": "DECLINE"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.phone.check_code(
phone_number="+14155552671",
code="123456",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.phone.checkCode({
phone_number: "+14155552671",
code: "123456",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{
PhoneNumber: "+14155552671",
Code: "123456",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.PhoneCheckCodeParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.phone().checkCode(PhoneCheckCodeParams.builder()
.phoneNumber("+14155552671")
.code("123456")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->phone->checkCode([
'phone_number' => '+14155552671',
'code' => '123456',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.phone.check_code(
phone_number: "+14155552671",
code: "123456"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams
{
PhoneNumber = "+14155552671",
Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));Umgang mit Anbieterausfällen
Ist der Telefonanbieter vorübergehend nicht erreichbar, gibt dieser Endpoint502 mit einem stabilen, maschinenlesbaren Code zurück:
{
"detail": "The phone verification provider is temporarily unavailable.",
"code": "phone_provider_unavailable"
}
Add-on für Telefonanalysen
Setzen Sieenable_enrichment auf true, um zusätzlich eine Telefonanalyse für die Nummer durchzuführen: einen Risiko-Score, den Leitungstyp, die Information, ob die Nummer kürzlich portiert wurde, und einen Vertrauensindex.
Das Add-on wird zum Listenpreis von $0.05 pro Anfrage abgerechnet, zusätzlich zum Preis der Prüfung.
Die Anfrage gibt 403 zurück, wenn Ihr Guthaben dafür nicht ausreicht.
Vier Felder bestimmen, was die Signale bewirken.
Jedes davon ist NO_ACTION (der Standardwert) oder DECLINE, und jedes wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.
| Feld | Ablehnung, wenn |
|---|---|
phone_intelligence_score_action | Der Risiko-Score über dem Schwellenwert liegt. |
phone_type_risk_action | Der Leitungstyp der Nummer ein hohes Risiko aufweist. |
recent_port_action | Die Nummer kürzlich zu einem anderen Anbieter portiert wurde. |
low_phone_trust_action | Der Vertrauensindex beim Schwellenwert liegt oder darunter. |
NO_ACTION wird das Signal trotzdem in phone.phone_intelligence zurückgegeben, sodass Sie Ihre eigene Regel anwenden können.Autorisierungen
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
Dieselbe Telefonnummer, die im zugehörigen Aufruf von POST /v3/phone/send/ verwendet wurde, im E.164-Format. Dadurch wird die Prüfung mit dem Versand verknüpft.
20"+14155552671"
Das OTP, das der Endbenutzer erhalten hat. Muss aus 4–8 Ziffern bestehen – alles andere gibt 400 zurück, ohne einen Versuch zu verbrauchen. Ein wohlgeformter, aber falscher Code gibt 200 mit status: "Failed" zurück und verbraucht einen der 3 Versuche.
4 - 8^[0-9]{4,8}$"123456"
Was zu tun ist, wenn dieselbe Nummer bereits von einem anderen Benutzer (andere vendor_data) Ihrer Anwendung verwendet wurde. DECLINE ändert den finalen status zu Declined; NO_ACTION erfasst das Risiko in phone.warnings und befüllt phone.matches.
NO_ACTION, DECLINE Was zu tun ist, wenn die Anbieterabfrage die Nummer als temporäre/Wegwerfnummer kennzeichnet (phone.is_disposable). DECLINE setzt den endgültigen status auf Declined; NO_ACTION erfasst das Risiko in phone.warnings.
NO_ACTION, DECLINE Was zu tun ist, wenn die Anbieterabfrage einen virtuellen Leitungstyp meldet — voip, isp oder vpn (phone.is_virtual). DECLINE setzt den endgültigen status auf Declined; NO_ACTION erfasst das Risiko in phone.warnings.
NO_ACTION, DECLINE Wenn true, wird zusätzlich eine Telefon-Intelligence für die Nummer ausgeführt: ein Risiko-Score, der Leitungstyp, ob sie kürzlich portiert wurde, und ein Vertrauensindex. Wird als eine phone_intelligence_api-Einheit pro Anfrage ($0.05 zum Listenpreis) zusätzlich zum eigenen Preis dieses Endpoints abgerechnet. Die Anfrage gibt 403 zurück, wenn Ihr Guthaben dies nicht decken kann.
false
Aktion, wenn der Risiko-Score der Telefon-Intelligence über dem Schwellenwert liegt. DECLINE ändert den endgültigen status zu Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.
NO_ACTION, DECLINE Aktion, wenn es sich bei der Nummer um einen risikoreichen Leitungstyp handelt. DECLINE ändert den endgültigen status zu Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.
NO_ACTION, DECLINE Aktion, wenn die Nummer kürzlich zu einem anderen Anbieter portiert wurde. DECLINE ändert den endgültigen status zu Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.
NO_ACTION, DECLINE Aktion, wenn der Vertrauensindex der Telefon-Intelligence am oder unter dem Schwellenwert liegt. DECLINE ändert den endgültigen status zu Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.
NO_ACTION, DECLINE 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.
true
Aktion, wenn die Prüfung des digitalen Fußabdrucks (Social Footprint) ergibt, dass die Nummer auf keiner der abgedeckten Plattformen registriert ist. An diesem Endpoint werden nur NO_ACTION und DECLINE akzeptiert; REVIEW ist über den gleichnamigen Workflow-Konfigurationsschlüssel verfügbar.
NO_ACTION, DECLINE Antwort
Prüfung abgeschlossen – falsche Codes und fehlende Verifizierungen geben ebenfalls 200 zurück; prüfen Sie status, nicht den HTTP-Code. phone ist nur bei abgeschlossenen Ergebnissen (Approved/Declined) ausgefüllt, null bei Failed und fehlt bei Expired or Not Found.
Bei Approved/Declined: die Sitzungs-ID der zugeordneten Verifizierung – identisch mit der von POST /v3/phone/send/ zurückgegebenen request_id. Bei Failed und Expired or Not Found: eine zufällige einmalige UUID, die später nicht nachgeschlagen werden kann.
Approved — korrekter Code, kein zur Ablehnung führendes Risiko. Declined — endgültig: Ein zur Ablehnung führendes Risiko lag vor oder das Kontingent an Versuchen (3) wurde aufgebraucht. Failed — falscher Code, verbleibende Versuche vorhanden. Expired or Not Found — keine ausstehende Verifizierung für diese Nummer in den letzten 5 Minuten.
Approved, Declined, Failed, Expired or Not Found Lesbare Erklärung des Ergebnisses, einschließlich der verbleibenden Anzahl von Versuchen nach einem falschen Code.
Vollständiger Telefonbericht. Nur bei endgültigen Ergebnissen vorhanden (nicht null) (Approved/Declined); null bei Failed und nicht vorhanden bei Expired or Not Found.
Show child attributes
Show child attributes
vendor_data der Sitzung der übereinstimmenden Verifizierung. null bei Expired or Not Found.
metadata der Sitzung der zugeordneten Verifizierung. null bei Expired or Not Found.
Zeitstempel dieser Prüfungsantwort.