Verify API

L'API Verify vous permet de confirmer que vous pouvez contacter un utilisateur à un numéro spécifique, afin que vous puissiez :

• Joignez vos utilisateurs à tout moment, en vous assurant que vous disposez de leur numéro de téléphone correct.
• Protéger contre la fraude et le spam, en empêchant un utilisateur de créer plusieurs Account
• Ajouter une couche de sécurité supplémentaire pour aider à confirmer l'identité d'un utilisateur lorsqu'il souhaite effectuer certaines activités.

Comment cela fonctionne-t-il ?

La vérification est un processus en deux étapes qui nécessite deux appels à l'API :

Demande de vérification

1. Un utilisateur s'inscrit à votre service via votre appli ou votre site web et fournit un numéro de téléphone.

2. Pour confirmer que l'utilisateur a accès au numéro pour lequel il s'est enregistré, votre application fait un appel API à l'application Point d'arrivée de la demande de vérification.

3. L'API Verify génère un code PIN, auquel est associé un numéro d'identification personnel. request_id.

   Il est possible de fournir votre propre code PIN dans certaines circonstances, veuillez contacter votre Account Manager.

4. L'API Verify tente ensuite de transmettre ce code PIN à l'utilisateur. Le format (SMS ou Text-to-speech (TTS)) et le moment de ces tentatives sont définis par l'API Verify choisie. flux de travail. Si l'utilisateur ne revient pas sur votre application ou votre site web pour saisir le code PIN qu'il a reçu, la demande de vérification finira par expirer. Dans le cas contraire, vous devez vérifier le numéro qu'il a saisi en effectuant un contrôle de vérification.

Contrôle de vérification

5. L'utilisateur reçoit le code PIN et le saisit dans votre application.

6. Votre application fait un appel API à l'application Point final du contrôle de vérification, en passant dans le request_id et le code PIN saisi par l'utilisateur.

7. L'API Verify vérifie que le code PIN saisi correspond à celui qui a été envoyé et renvoie le résultat à votre application.

Pour commencer

L'exemple suivant montre comment lancer le processus de vérification en envoyant un code de vérification à un utilisateur. Pour savoir comment valider le code fourni par l'utilisateur et effectuer d'autres opérations, reportez-vous à la section Extraits de code.

curl GET "https://api.nexmo.com/verify/json?api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET&number=$VERIFY_NUMBER&brand=AcmeInc"

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

val response = client.verifyLegacy.verify(VERIFY_NUMBER, VERIFY_BRAND_NAME)
if (response.status == VerifyStatus.OK) {
    println("Verification sent. Request ID: ${response.requestId}")
}
else {
    println("Error: ${response.errorText}")
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

implementation 'com.vonage:server-sdk:9.3.1'

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

VerifyResponse response = client.getVerifyClient().verify(VERIFY_NUMBER, VERIFY_BRAND_NAME);

if (response.getStatus() == VerifyStatus.OK) {
    System.out.printf("RequestID: %s", response.getRequestId());
}
else {
    System.out.printf("ERROR! %s: %s", response.getStatus(), response.getErrorText());
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Install-Package Vonage

using System.Threading.Tasks;
using Vonage.Verify;
using Vonage;

var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

var request = new VerifyRequest() { Brand = brandName, Number = recipientNumber };

composer require vonage/client

pip install vonage python-dotenv

from vonage import Auth, Vonage
from vonage_verify_legacy import StartVerificationResponse, VerifyRequest

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

request = VerifyRequest(number=VERIFY_NUMBER, brand='AcmeInc')

response: StartVerificationResponse = client.verify_legacy.start_verification(request)
print(response)

gem install vonage

Guides

• Guide de migration Verify: Ce guide vous aidera à migrer de Verify Legacy à Verify.
• Authentification: Authentification avec l'API Verify
• Verify Languages (en anglais): Les langues disponibles pour la V2 de l'API Verify
• Verify API Workflow (flux de travail de l'API): Verify API Workflow (flux de travail de l'API)
• Gestion des modèles: Comment utiliser la gestion des modèles pour envoyer des messages OTP personnalisés avec l'API Verify de Vonage.
• Verify API Webhooks: Guide sur les webhooks et leur utilisation avec l'API Verify.
• Authentification silencieuse: Authentification silencieuse avec l'API Verify de Vonage
• Verify le système anti-fraude: Le système anti-fraude de Verify
• Opérateur virtuel pour l'authentification silencieuse: Une introduction à l'utilisation de la fonction d'opérateur virtuel dans la zone de jeu API du réseau Vonage avec l'authentification silencieuse.
• API de déblocage du réseau: Apprenez ce qu'est l'API de déblocage du réseau Vonage et comment l'utiliser.

Extraits de code

• Annuler une demande de vérification
• Créer un fragment de modèle
• Créer un modèle
• Envoyer une demande de vérification (avec option de repli)
• Envoyer une demande de vérification en utilisant l'authentification silencieuse
• Envoyer une demande de vérification en utilisant la voix (TTS)
• Envoyer une demande de vérification par courrier électronique
• Envoyer une demande de vérification par SMS
• Envoyer une demande de vérification par WhatsApp
• Liste des fragments de modèle
• Mise à jour d'un fragment de modèle
• Mise à jour d'un modèle
• Modèles de liste
• Obtenir un fragment de modèle
• Obtenir un modèle
• Supprimer un fragment de modèle
• Supprimer un modèle
• Vérifier un code de vérification

Cas d'utilisation

Pour en savoir plus

• Verify la référence de l'API
• Mise en œuvre de l'API Verify à l'aide de Node.js
• Utiliser l'API Verify dans les applications iOS
• Utiliser l'API Verify dans les applications Android